Annotation Type License

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String name
      The license name used for the API.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      Extension[] extensions
      List of extensions to be added to the License model corresponding to the containing annotation.
      String identifier
      The license identifier used for the API.
      String url
      A URL to the license used for the API.
    • Element Detail

      • name

        String name
        The license name used for the API.
        Returns:
        the name of the license
      • identifier

        String identifier
        The license identifier used for the API.
        Returns:
        the identifier of the license
        Default:
        ""
      • url

        String url
        A URL to the license used for the API. MUST be in the format of a URL.
        Returns:
        the URL of the license
        Default:
        ""
      • extensions

        Extension[] extensions
        List of extensions to be added to the License model corresponding to the containing annotation.
        Returns:
        array of extensions
        Since:
        3.1
        Default:
        {}