Commit d5a05efa authored by Muhammad Hamza's avatar Muhammad Hamza
Browse files

OAS align with NFVSOL(24)000403r3 draft

parent 1b33daff

src/SOL023/CertificateManagement/CertificateManagement.yaml

+17 −16
Original line number Diff line number Diff line
@@ -231,7 +231,7 @@ paths: 
        "504":

          $ref: ../responses/SOL023_resp.yaml#/responses/504

        

  /subjects/{subjectId}/certificate/{certificateId}:

  /subjects/{subjectId}/certificates/{certificateId}:

    parameters:

      - $ref: "#/components/parameters/subjectId"

      - $ref: "#/components/parameters/certificateId"
@@ -483,7 +483,7 @@ components: 
      in: query

      description: >-

        Indicates to exclude the following complex attributes from the response. See clause 5.3 of

        ETSI GS NFV-SOL 013 [8] for details. The CMF shall support this parameter.

        ETSI GS NFV-SOL 013 for details. The CMF shall support this parameter.

        The following attributes shall be excluded from the SubjectInstance structure in the response

        body if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields",

        "exclude_default" are provided:
@@ -510,7 +510,7 @@ components: 
      in: query

      description: >-

        Indicates to exclude the following complex attributes from the response. See clause 5.3 of

        ETSI GS NFV-SOL 013 [8] for details. The CMF shall support this parameter.

        ETSI GS NFV-SOL 013 for details. The CMF shall support this parameter.

        The following attributes shall be excluded from the SubjectInstance structure in the response

        body if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields",

        "exclude_default" are provided:
@@ -523,9 +523,9 @@ components: 
      name: subjectId

      in: path

      description: |

        Identifier of the Subject instance. See note 1.

        Identifier of the Subject instance. See note.



        NOTE 1:	This identifier can be retrieved from the resource referenced by the "Location" HTTP

        NOTE:	This identifier can be retrieved from the resource referenced by the "Location" HTTP

        header in the response to a POST request creating a new "Individual Subject instance" resource.

        It can also be retrieved from the "id" attribute in the message content of that response.

      required: true
@@ -538,9 +538,9 @@ components: 
      name: certificateId

      in: path

      description: |

        certificateId	Identifier of the Certificate instance. See note 2.

        certificateId	Identifier of the Certificate instance. See note.



        NOTE 2:	This identifier can be retrieved from the resource referenced by the "Location" HTTP

        NOTE:	This identifier can be retrieved from the resource referenced by the "Location" HTTP

        header in the response to a POST request creating a new "Individual Certificate instance" resource.

        It can also be retrieved from the "id" attribute in the message content of that response.

      required: true
@@ -570,8 +570,9 @@ components: 
      name: subscriptionId

      in: path

      description: |

        Identifier of this subscription.

        This identifier can be retrieved from the resource referenced by the

        Identifier of this subscription. see note.

        

        NOTE: This identifier can be retrieved from the resource referenced by the

        "Location" HTTP header in the response to a POST request creating a

        new "Individual subscription" resource. It can also be retrieved from the "id"

        attribute in the message content of that response.
@@ -681,11 +682,11 @@ components: 
        If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields"

        (if supported) or "exclude_default" URI parameters was supplied in the request, the data in the response

        body shall have been transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of

        ETSI GS NFV SOL 013 [8], respectively.

        ETSI GS NFV SOL 013, respectively.



        If the CMF supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013 [8] for

        If the CMF supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013 for

        this resource, inclusion of the Link HTTP header in this response shall follow the provisions in

        clause 5.4.2.3 of ETSI GS NFV SOL 013 [8].

        clause 5.4.2.3 of ETSI GS NFV SOL 013.

      headers:

        Location:

          description: |
@@ -897,11 +898,11 @@ components: 
        If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields"

        (if supported) or "exclude_default" URI parameters was supplied in the request, the data in the response

        body shall have been transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of

        ETSI GS NFV SOL 013 [8], respectively.

        ETSI GS NFV SOL 013, respectively.



        If the CMF supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013 [8] for

        If the CMF supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013 for

        this resource, inclusion of the Link HTTP header in this response shall follow the provisions in

        clause 5.4.2.3 of ETSI GS NFV SOL 013 [8].

        clause 5.4.2.3 of ETSI GS NFV SOL 013.

      headers:

        WWW-Authenticate:

          description: >
@@ -1283,7 +1284,7 @@ components: 


        The response body shall contain in an array the representations of all active subscriptions

        of the functional block that invokes the method, i.e. zero or more representations of certificate

        change notification subscriptions as defined in clause X.X.X.X.

        change notification subscriptions as defined in clause 7.7.2.3.



        If the "filter" URI parameter was supplied in the request, the data in the response body shall have

        been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.

src/SOL023/CertificateManagement/definitions/SOL023CertificateManagement_def.yaml

+285 −140

File changed.

Preview size limit exceeded, changes collapsed.

src/SOL023/components/SOL023_params.yaml

+4 −4
Original line number Diff line number Diff line
@@ -49,7 +49,7 @@ components: 
      name: all_fields

      description: >

        Include all complex attributes in the response. See clause 5.3 of ETSI

        GS NFV-SOL 013 [8] for details. The CMF shall support this parameter.

        GS NFV-SOL 013 for details. The CMF shall support this parameter.

      in: query

      required: false

      schema:
@@ -59,7 +59,7 @@ components: 
      name: fields

      description: >

        Complex attributes to be included into the response. See clause 5.3 of ETSI

        GS NFV-SOL 013 [8] for details. The CMF should support this parameter.

        GS NFV-SOL 013 for details. The CMF should support this parameter.

      in: query

      required: false

      schema:
@@ -69,7 +69,7 @@ components: 
      name: exclude_fields

      description: >

        Complex attributes to be excluded from the response. See clause 5.3 of ETSI

        GS NFV-SOL 013 [8] for details. The CMF should support this parameter.

        GS NFV-SOL 013 for details. The CMF should support this parameter.

      in: query

      required: false

      schema:
@@ -80,7 +80,7 @@ components: 
      description: >

        Marker to obtain the next page of a paged response. Shall be supported by the CMF

        if the CMF supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI

        GS NFV-SOL 013 [8] for this resource.

        GS NFV-SOL 013 for this resource.

      in: query

      required: false

      schema: