updated API version for SOL012

src/SOL012/APIVersion/APIVersion.yaml

@@ -23,5 +23,9 @@ info:
     name: NFV-SOL WG
 
 externalDocs:
-  description: ETSI GS NFV-SOL 012 V0.0.2
+  description: ETSI GS NFV-SOL 012 V0.2.0
   url: https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL012ed331_Protocol_Spec_for_Policy_Mgmt_Intface/NFV-SOL012ed311v002.zip
+
+paths:
+  /nfvpolicy/api_versions:
+    $ref: '../endpoints/SOL012_endpoints.yaml#/endpoints/api_versions'
\ No newline at end of file

src/SOL012/components/SOL012_params.yaml

+components:
+  parameters:
+    Version:
+      name: Version
+      description: >
+        Version of the API requested to use when responding to this request.
+      in: header
+      required: true
+      schema:
+        type: string
+    
+    Accept:
+      name: Accept
+      description: >
+        Content-Types that are acceptable for the response. Reference: IETF RFC 7231.
+      in: header
+      required: true
+      schema:
+        type: string
+    
+    Authorization:
+      name: Authorization
+      description: >
+        The authorization token for the request. Reference: IETF RFC 7235.
+      in: header
+      required: false
+      schema:
+        type: string
+
+    ContentType:
+      name: Content-Type
+      description: |
+        The MIME type of the body of the request. Reference: IETF RFC 7231
+      in: header
+      required: true
+      schema:
+        type: string
+
+    filter:
+      name: filter
+      description: >
+        Attribute-based filtering expression according to clause 5.2 of ETSI
+        GS NFV-SOL 013. The NFV-MANO functional entity shall support
+        receiving this parameter as part of the URI query string. The API
+        consumer may supply this parameter. All attribute names that appear
+        in the FmSubscription and in data types referenced from it shall be
+        supported by the NFV-MANO functional entity in the filter
+        expression.
+      in: query
+      required: false
+      schema:
+        type: string
+
+    all_fields:
+      name: all_fields
+      description: >
+        Include all complex attributes in the response. See clause 
+        5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity 
+        shall support this parameter.
+      in: query
+      required: false
+      schema:
+        type: string
+
+    fields:
+      name: fields
+      description: >
+        Complex attributes to be included into the response. See clause 
+        5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional 
+        entity should support this parameter.
+      in: query
+      required: false
+      schema:
+        type: string
+
+    exclude_fields:
+      name: exclude_fields
+      description: >
+        Complex attributes to be excluded from the response. See clause 
+        5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional 
+        entity should support this parameter.
+      in: query
+      required: false
+      schema:
+        type: string
+
+    exclude_default:
+      name: exclude_default
+      in: query
+      description: >-
+        Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013
+        for details. The NFV-MANO functional entity shall support this parameter.
+      required: false
+      schema:
+        type: string
+
+    nextpage_opaque_marker:
+      name: nextpage_opaque_marker
+      description: >
+        Marker to obtain the next page of a paged response. Shall be supported by 
+        the NFV-MANO functional entity if the entity supports alternative 2 (paging) 
+        according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
+      in: query
+      required: false
+      schema:
+        type: string

src/SOL012/components/SOL012_schemas.yaml

+components:
+  schemas:
+    Link:
+      description: >
+        This type represents a link to a resource using an absolute URI.
+      type: object
+      required:
+        - href
+      properties:
+        href:
+          description: >
+            URI of another resource referenced from a resource.
+            Shall be an absolute URI (i.e. a UTI that contains {apiRoot}).
+          $ref: "#/components/schemas/Uri"
+
+    NotificationLink:
+      description: >
+        This type represents a link to a resource in a notification, using an absolute or relative URI.
+      type: object
+      required:
+        - href
+      properties:
+        href:
+          description: >
+            URI of a resource referenced from a notification.
+            Should be an absolute URI (i.e. a URI that contains
+            {apiRoot}), however, may be a relative URI (i.e. a URI
+            where the {apiRoot} part is omitted) if the {apiRoot}
+            information is not available.
+          $ref: "#/components/schemas/Uri"
+    
+    IpAddress:
+      description: >
+        An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal
+        integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that
+        consists of groups of zero to four hexadecimal digits, separated by colons.
+      type: string
+      format: IP
+
+    KeyValuePairs:
+      description: >
+        This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON,
+        a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4
+        of IETF RFC 8259. In the following example, a list of key-value pairs with four keys ("aString", "aNumber",
+        "anArray" and "anObject") is provided to illustrate that the values associated with different keys can be of
+        different type.
+      type: object
+
+    ApiVersionInformation:
+      description: >
+        This type represents API version information.
+      type: object
+      required:
+        - uriPrefix
+        - apiVersions
+      properties:
+        uriPrefix:
+          description: >
+            Specifies the URI prefix for the API, in the following
+            form {apiRoot}/{apiName}/{apiMajorVersion}/.
+          type: string
+        apiVersions:
+          description: >
+            Version(s) supported for the API signaled by the
+            uriPrefix attribute.
+          type: array
+          items:
+            type: object
+            required:
+              - version
+            properties:
+              version:
+                description: >
+                  Identifies a supported version. The value of the
+                  version attribute shall be a version identifier as
+                  specified in clause 9.1 (SOL013).
+                type: string
+              isDeprecated:
+                description: >
+                  If such information is available, this attribute indicates
+                  whether use of the version signaled by the version
+                  attribute is deprecated (true) or not (false).
+
+                  A deprecated version is still supported by the API producer but is recommended
+                  not to be used any longer.
+                  When a version is no longer supported, it does not appear in the response body.
+                type: boolean
+              retirementDate:
+                description: >
+                  The date and time after which the API version will no
+                  longer be supported.
+                  This attribute may be included if the value of the
+                  isDeprecated attribute is set to true and shall be
+                  absent otherwise.
+                $ref: "#/components/schemas/DateTime"
+
+    Identifier:
+      description: >
+        An identifier with the intention of being globally unique.
+      type: string
+
+    IdentifierLocal:
+      description: >
+        An identifier that is unique within a limited local scope other than above listed identifiers,
+        such as within a complex data structure or within a request-response pair.
+        Representation: string of variable length.
+      type: string
+
+    DateTime:
+      description: >
+        Date-time stamp.
+        Representation: String formatted according to IETF RFC 3339.
+      type: string
+      format: date-time
+
+    Uri:
+      description: >
+        String formatted according to IETF RFC 3986.
+      type: string
+
+    Boolean:
+      description: >
+        The Boolean is a data type having two values (true and false).
+      type: boolean
+
+    Version:
+      description: >
+        A version.
+      type: string
+
+    String:
+      description: >
+        A string defined in IETF RFC 8259.
+      type: string
+
+    Number:
+      description: >
+        A number defined in IETF RFC 8259.
+      type: number
+
+    UnsignedInt:
+      description: >
+        Unsigned integer
+      type: number
+
+    SubscriptionAuthentication:
+      type: object
+      required:
+        - authType
+      properties:
+        authType:
+          description: >
+            Defines the types of Authentication / Authorization which the API
+            consumer is willing to accept when receiving a notification.
+            Permitted values:
+            * BASIC: In every HTTP request to the notification endpoint, use
+              HTTP Basic authentication with the client credentials.
+            * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the
+              notification endpoint, use an OAuth 2.0 Bearer token, obtained
+              using the client credentials grant type.
+            * TLS_CERT: Every HTTP request to the notification endpoint is sent
+              over a mutually authenticated TLS session, i.e. not only the
+              server is authenticated, but also the client is authenticated
+              during the TLS tunnel setup.
+          type: array
+          items:
+            type: string
+            enum:
+              - BASIC
+              - OAUTH2_CLIENT_CREDENTIALS
+              - TLS_CERT
+        paramsBasic:
+          description: >
+            Parameters for authentication/authorization using BASIC.
+            Shall be present if authType is "BASIC" and the contained
+            information has not been provisioned out of band.
+            Shall be absent otherwise.
+          type: object
+          properties:
+            userName:
+              description: >
+                Username to be used in HTTP Basic authentication. Shall be
+                present if it has not been provisioned out of band.
+              type: string
+            password:
+              description: >
+                Password to be used in HTTP Basic authentication. Shall be
+                present if it has not been provisioned out of band.
+              type: string
+        paramsOauth2ClientCredentials:
+          description: >
+            Parameters for authentication/authorization using
+            OAUTH2_CLIENT_CREDENTIALS.
+            Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the
+            contained information has not been provisioned out of band.
+            Shall be absent otherwise.
+          type: object
+          properties:
+            clientId:
+              description: >
+                Client identifier to be used in the access token request of the
+                OAuth 2.0 client credentials grant type.
+                Shall be present if it has not been provisioned out of band.
+                The clientId and clientPassword passed in a subscription shall
+                not be the same as the clientId and clientPassword that are used
+                to obtain authorization for API requests. Client credentials may
+                differ between subscriptions. The value of clientPassword should
+                be generated by a random process.
+              type: string
+            clientPassword:
+              description: >
+                Client password to be used in the access token request of the
+                OAuth 2.0 client credentials grant type.
+                Shall be present if it has not been provisioned out of band.
+                The clientId and clientPassword passed in a subscription shall
+                not be the same as the clientId and clientPassword that are used
+                to obtain authorization for API requests. Client credentials may
+                differ between subscriptions. The value of clientPassword should
+                be generated by a random process.
+              type: string
+            tokenEndpoint:
+              description: >
+                The token endpoint from which the access token can be obtained.
+                Shall be present if it has not been provisioned out of band.
+              $ref: "#/components/schemas/Uri"
+
+    ProblemDetails:
+      description: >
+        The definition of the general "ProblemDetails" data structure from
+        IETF RFC 7807 [19] is reproduced inthis structure. Compared to the
+        general framework defined in IETF RFC 7807 [19], the "status" and
+        "detail" attributes are mandated to be included by the present document,
+        to ensure that the response contains additional textual information about
+        an error. IETF RFC 7807 [19] foresees extensibility of the
+        "ProblemDetails" type. It is possible that particular APIs in the present
+        document, or particular implementations, define extensions to define
+        additional attributes that provide more information about the error.
+        The description column only provides some explanation of the meaning to
+        Facilitate understanding of the design. For a full description, see
+        IETF RFC 7807 [19].
+      type: object
+      required:
+        - status
+        - detail
+      properties:
+        type:
+          description: >
+            A URI reference according to IETF RFC 3986 [5] that identifies the
+            problem type. It is encouraged that the URI provides human-readable
+            documentation for the problem (e.g. using HTML) when dereferenced.
+            When this member is not present, its value is assumed to be
+            "about:blank".
+          type: string
+          format: URI
+        title:
+          description: >
+            A short, human-readable summary of the problem type. It should not
+            change from occurrence to occurrence of the problem, except for
+            purposes of localization. If type is given and other than
+            "about:blank", this attribute shall also be provided.
+            A short, human-readable summary of the problem
+            type.  It SHOULD NOT change from occurrence to occurrence of the
+            problem, except for purposes of localization (e.g., using
+            proactive content negotiation; see [RFC7231], Section 3.4).
+          type: string
+        status:
+          description: >
+            The HTTP status code for this occurrence of the problem.
+            The HTTP status code ([RFC7231], Section 6) generated by the origin
+            server for this occurrence of the problem.
+          type: integer
+        detail:
+          description: >
+            A human-readable explanation specific to this occurrence of the
+            problem.
+          type: string
+        instance:
+          description: >
+            A URI reference that identifies the specific occurrence of the
+            problem. It may yield further information if dereferenced.
+          type: string
+          format: URI
+        #TODO: How to express "any additional attributes"?

src/SOL012/endpoints/SOL012_endpoints.yaml

+# Copyright (c) ETSI 2019.
+# https://forge.etsi.org/etsi-forge-copyright-notice.txt
+endpoints:
+  api_versions:
+    parameters:
+      - name: Version
+        description: >
+          Version of the API requested to use when responding to this request.
+        in: header
+        required: false
+        schema:
+          type: string
+      - name: Authorization
+        description: >-
+          The authorization token for the request. Reference: IETF RFC 7235
+        in: header
+        required: false
+        schema:
+          type: string
+    get:
+      summary: Retrieve API version information
+      description: >
+        The GET method reads API version information. This method shall follow the provisions specified in
+        table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
+        supported.
+      responses:
+        200:
+          description: >
+            200 OK
+            
+            API version information was read successfully.
+            The response body shall contain 4.4 API version
+            information, as defined in clause 4.4.1.13.
+          content:
+            application/json:
+              schema:
+                $ref: '../components/SOL012_schemas.yaml#/components/schemas/ApiVersionInformation'
+          headers:
+            Content-Type:
+              description: The MIME type of the body of the response.
+              schema:
+                type: string
+                maximum: 1
+                minimum: 1
+            WWW-Authenticate:
+              description: >
+                Challenge if the corresponding HTTP request has not provided
+                authorization, or error details if the corresponding HTTP
+                request has provided an invalid authorization token.
+              schema:
+                type: string
+                maximum: 1
+                minimum: 0
+            Version:
+              description: The used API version.
+              schema:
+                type: string
+                maximum: 1
+                minimum: 1
+        400:
+          $ref: '../components/SOL012_resp.yaml#/components/responses/400'
+        401:
+          $ref: '../components/SOL012_resp.yaml#/components/responses/401'
+        403:
+          $ref: '../components/SOL012_resp.yaml#/components/responses/403'
+        404:
+          $ref: '../components/SOL012_resp.yaml#/components/responses/404'
+        405:
+          $ref: '../components/SOL012_resp.yaml#/components/responses/405'
+        406:
+          $ref: '../components/SOL012_resp.yaml#/components/responses/406'
+        413:
+          $ref: '../components/SOL012_resp.yaml#/components/responses/413'
+        414:
+          $ref: '../components/SOL012_resp.yaml#/components/responses/414'
+        416:
+          $ref: '../components/SOL012_resp.yaml#/components/responses/416'
+        422:
+          $ref: '../components/SOL012_resp.yaml#/components/responses/422'
+        429:
+          $ref: '../components/SOL012_resp.yaml#/components/responses/429'
+        500:
+          $ref: '../components/SOL012_resp.yaml#/components/responses/500'
+        503:
+          $ref: '../components/SOL012_resp.yaml#/components/responses/503'
+        504:
+          $ref: '../components/SOL012_resp.yaml#/components/responses/504'
\ No newline at end of file