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

fix issue #29: fix implementation of error code 422 for SOL002 in 5.3.1

parent 39ab0454
Loading
Loading
Loading
Loading
Loading
+43 −4
Original line number Diff line number Diff line
@@ -259,7 +259,7 @@ paths:
        "416":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
        "422":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
          $ref: '#/components/responses/Subscriptions.Post.422'
        "429":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
        "500":
@@ -346,7 +346,7 @@ components:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI
        GS NFV-SOL 013 [6].
        GS NFV-SOL 013.
        The VNFM shall support receiving this parameter as part of the URI query
        string. The EM may supply this parameter. The VNF may supply its instance
        Id as an attribute filter.
@@ -361,7 +361,7 @@ components:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI
        GS NFV-SOL 013 [6].
        GS NFV-SOL 013.
        The VNFM shall support receiving this parameter as part of the URI query string. The
        EM may supply this parameter. The VNF may supply its instance Id as an attribute
        filter.
@@ -699,6 +699,45 @@ components:
          schema:
            $ref: definitions/SOL002VNFFaultManagement_def.yaml#/definitions/FmSubscription

    Subscriptions.Post.422:
      description: |
        422 Unprocessable Content

        Shall be returned upon the following error: The content type of the message content is supported 
        and the message content of a request contains syntactically correct data but the data cannot be processed.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, 
        including rules for the presence of the response body.
        Specifically in case of this resource, the response code 422 shall also be returned if the VNFM has tested 
        the Notification endpoint as described in clause 7.4.7.3.2 and the test has failed.
        In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information 
        about the error.
      headers:
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../General_Definitions/SOL002_def.yaml#/definitions/ProblemDetails"
    
    IndividualSubscription.Get.200:
      description: |
        200 OK
+43 −4
Original line number Diff line number Diff line
@@ -211,7 +211,7 @@ paths:
        "416":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
        "422":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
          $ref: '#/components/responses/VnfIndicatorSubscription.Post.422'
        "429":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
        "500":
@@ -294,7 +294,7 @@ components:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI
        GS NFV-SOL 013 [6].
        GS NFV-SOL 013.
        The EM shall and the VNF may support receiving this parameter as part of the URI
        query string. The VNFM may supply this parameter.
        All attribute names that appear in the VnfIndicatorSubscription data type and in data
@@ -310,7 +310,7 @@ components:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI
        GS NFV-SOL 013 [6].
        GS NFV-SOL 013.
        The API producer shall support receiving this parameter as part of the URI query
        string. The VNFM may supply this parameter.
        All attribute names that appear in the VnfIndicator data type and in data types
@@ -324,7 +324,7 @@ components:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI
        GS NFV-SOL 013 [6].
        GS NFV-SOL 013.
        The API producer shall support receiving this parameter as part of the URI query
        string. The VNFM may supply this parameter.
        All attribute names that appear in the VnfIndicator data type and in data types
@@ -564,6 +564,45 @@ components:
            items:
              $ref: definitions/SOL002VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription

    VnfIndicatorSubscription.Post.422:
      description: |
        422 Unprocessable Content

        Shall be returned upon the following error: The content type of the message content is supported 
        and the message content of a request contains syntactically correct data but the data cannot be processed.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, 
        including rules for the presence of the response body.
        Specifically in case of this resource, the response code 422 shall also be returned if the VNFM has tested 
        the Notification endpoint as described in clause 8.4.7.3.2 and the test has failed.
        In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information 
        about the error.
      headers:
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../General_Definitions/SOL002_def.yaml#/definitions/ProblemDetails"
    
    VnfIndicatorSubscription.Get.200:
      description: |
        200 OK
+177 −23
Original line number Diff line number Diff line
@@ -100,7 +100,7 @@ paths:
        "416":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
        "422":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
          $ref: '#/components/responses/VnfInstances.Post.422'
        "429":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
        "500":
@@ -925,7 +925,7 @@ paths:
        "416":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
        "422":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
          $ref: '#/components/responses/Subscriptions.Post.422'
        "429":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
        "500":
@@ -1017,8 +1017,6 @@ paths:
      responses:
        "202":
          $ref: '#/components/responses/VnfInstanceCreateSnapshot.Post.202'
        "409":
          $ref: '#/components/responses/VnfInstanceCreateSnapshot.Post.409'
        "400":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
        "401":
@@ -1026,15 +1024,15 @@ paths:
        "403":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
        "404":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
          $ref: '#/components/responses/VnfInstanceCreateSnapshot.Post.404'
        "405":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
        "406":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
        "416":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
        "409":
          $ref: '#/components/responses/VnfInstanceCreateSnapshot.Post.409'
        "422":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
          $ref: '#/components/responses/VnfInstanceCreateSnapshot.Post.422'
        "429":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
        "500":
@@ -1239,7 +1237,7 @@ components:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI
        GS NFV-SOL 013 [6].
        GS NFV-SOL 013.
        The VNFM shall support receiving this parameter as part of the URI
        query string. The EM may supply this parameter.
        All attribute names that appear in the VnfSnapshot and in data types
@@ -1255,7 +1253,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 [6] for details.
        response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
        The VNFM shall support this parameter.
        The following attributes shall be excluded from the VnfSnapshot
        structure in the response body if this parameter is provided, or none
@@ -1271,7 +1269,7 @@ components:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI
        GS NFV-SOL 013 [6].
        GS NFV-SOL 013.
        The VNFM shall support receiving this parameter as part of the URI query string. The
        EM may supply this parameter.
        All attribute names that appear in the LccnSubscription and in data types referenced
@@ -1285,7 +1283,7 @@ components:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI
        GS NFV-SOL 013 [6].
        GS NFV-SOL 013.
        The VNFM shall support receiving this parameter as part of the URI query string.
        The EM/VNF may supply this parameter.
        All attribute names that appear in the VnfLcmOpOcc and in data types referenced
@@ -1300,7 +1298,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 [6] for details. The VNFM shall support this
        clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this
        parameter.
        The following attributes shall be excluded from the VnfLcmOpOcc structure in the
        response body if this parameter is provided, or none of the parameters
@@ -1321,7 +1319,7 @@ components:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI
        GS NFV-SOL 013 [6].
        GS NFV-SOL 013.
        The VNFM shall support receiving this parameter as part of the URI query string.
        The EM may supply this parameter.
        All attribute names that appear in the VnfInstance and in data types referenced from
@@ -1336,7 +1334,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 [6] for details. The VNFM shall support this
        clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this
        parameter.
        The following attributes shall be excluded from the VnfInstance structure in the
        response body if this parameter is provided, or none of the parameters "all_fields",
@@ -1614,6 +1612,46 @@ components:
          schema:
            $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInstance

    VnfInstances.Post.422:
      description: |
        422 Unprocessable Content

        Shall be returned upon the following error: The content type of the message content is supported and the
        message content of a request contains syntactically correct data but the data cannot be processed.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
        including rules for the presence of the response body.
        Specifically in case of this resource, the response code 422 shall also be returned if the VNF package
        referenced by the "vnfdId" attribute in the "CreateVnfRequest" structure is not in the "ENABLED"
        state or does not exist. In this case, the "detail" attribute in the "ProblemDetails" structure shall convey
        more information about the error.
      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: >
            Version of the API used in the response.
          schema:
            type: string
            maximum: 1
            minimum: 1
      content:
        application/json:
          schema:
            $ref: "../General_Definitions/SOL002_def.yaml#/definitions/ProblemDetails"
    
    IndividualVnfInstance.Get.200:
      description: |
        200 OK
@@ -2947,6 +2985,46 @@ components:
          schema:
            $ref: definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription

    Subscriptions.Post.422:
      description: |
        422 Unprocessable Content

        Shall be returned upon the following error: The content type of the message content is supported
        and the message content of a request contains syntactically correct data but the data cannot be
        processed.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
        including rules for the presence of the response body.
        Specifically in case of this resource, the response code 422 shall also be returned if the VNFM has
        tested the Notification endpoint as described in clause 5.4.20.3.2 and the test has failed.
        In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more
        information about the error.
      headers:
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../General_Definitions/SOL002_def.yaml#/definitions/ProblemDetails"
    
    IndividualSubscription.Get.200:
      description: |
        200 OK
@@ -3038,19 +3116,55 @@ components:
            format: url
      content: {}

    VnfInstanceCreateSnapshot.Post.404:
      description: |
        404 Not Found

        Shall be returned upon the following error: The API producer did not find a current representation
        for the target resource or is not willing to disclose that one exists.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI
        GS NFV-SOL 013, including rules for the presence of the response body.
        Specifically in case of this task resource, the response code 404 shall also be returned if the
        task is not supported for the VNF instance represented by the parent resource, which means
        that the task resource consequently does not exist.
        In this case, the response body shall be present, and shall contain a ProblemDetails structure, in
        which the "detail" attribute shall convey more information about the error. 
      headers:
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../General_Definitions/SOL002_def.yaml#/definitions/ProblemDetails"
    
    VnfInstanceCreateSnapshot.Post.409:
      description: |
        409 CONFLICT

        Shall be returned upon the following error: The
        operation cannot be executed currently, due to a
        Shall be returned upon the following error: The operation cannot be executed currently, due to a
        conflict with the state of the resource.
        Typically, this is due to the fact that the VNF
        instance resource is in NOT_INSTANTIATED
        state, or that another lifecycle management
        operation is ongoing.
        The response body shall contain a ProblemDetails
        structure, in which the "detail" attribute shall
        Typically, this is due to the fact that the VNF instance resource is in NOT_INSTANTIATED
        state, or that another lifecycle management operation is ongoing.
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
        convey more information about the error.
      headers:
        WWW-Authenticate:
@@ -3079,6 +3193,46 @@ components:
          schema:
            $ref: "../General_Definitions/SOL002_def.yaml#/definitions/ProblemDetails"

    VnfInstanceCreateSnapshot.Post.422:
      description: |
        422 Unprocessable Content

        Shall be returned upon the following error: The content type of the message content is supported
        and the message content of a request contains syntactically correct data but the data cannot be
        processed.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI
        GS NFV-SOL 013, including rules for the presence of the response body.
        Specifically in case of this resource, the response code 422 shall also be returned if the provided
        identifier of the target "Individual VNF snapshot" resource for the VNF snapshot is invalid.
        In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more
        information about the error.
      headers:
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../General_Definitions/SOL002_def.yaml#/definitions/ProblemDetails"
    
    VnfInstanceRevertToSnapshot.Post.202:
      description: |
        202 ACCEPTED
+165 −8

File changed.

Preview size limit exceeded, changes collapsed.