Commit 44336082 authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

updated response descriptions

parent b1c5eccc
Loading
Loading
Loading
Loading
+44 −9
Original line number Original line Diff line number Diff line
@@ -129,14 +129,7 @@ paths:
        406:
        406:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
        409:
        409:
          #          description: |
          $ref: '#/components/responses/IndividualAlarm.Patch.409'
          #            409 CONFLICT
          #
          #            Shall be returned upon the following error: The operation cannot be executed currently,
          #            due to a conflict with the state of the "Individual alarm" resource.
          #            Typically, this is due to the fact that the alarm is already in the state that is
          #            requested to be set (such as trying to acknowledge an already-acknowledged alarm).
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
        412:
        412:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412
        422:
        422:
@@ -450,6 +443,48 @@ components:
          schema:
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications"
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications"


    IndividualAlarm.Patch.409:
      description: |
        409 CONFLICT

        Shall be returned upon the following error: The
        operation cannot be executed currently, due to a
        conflict with the state of the "Individual alarm"
        resource.
        Typically, this is due to the fact that the alarm is
        already in the state that is requested to be set (such
        as trying to acknowledge an already-acknowledged
        alarm).
        The response body 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: The used API version.
          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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

    Subscriptions.Get.200:
    Subscriptions.Get.200:
      description: |
      description: |
        200 OK
        200 OK
+1011 −292

File changed.

Preview size limit exceeded, changes collapsed.

+83 −11
Original line number Original line Diff line number Diff line
@@ -57,11 +57,7 @@ paths:
        401:
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
        403:
        403:
          #description: |
          $ref: '#/components/responses/Grants.Post.403'
          # 403 FORBIDDEN
          #
          # Shall be returned upon the following error: The grant has been rejected.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
        404:
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
        405:
        405:
@@ -101,11 +97,7 @@ paths:
        401:
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
        403:
        403:
          #description: |
          $ref: '#/components/responses/IndividualGrant.Get.403'
          # 403 FORBIDDEN
          #
          # Shall be returned upon the following error: The grant has been rejected.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
        404:
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
        405:
        405:
@@ -217,6 +209,50 @@ components:
          schema:
          schema:
            type: string
            type: string


    Grants.Post.403:
      description: |
        403 FORBIDDEN

        Shall be returned upon the following error: The grant
        has been rejected.
        A ProblemDetails structure shall be included in the
        response to provide more details about the rejection
        in the "details" attribute.
      headers:
        Location:
          description: |
            The resource URI of the created subscription resource.
          style: simple
          explode: false
          schema:
            type: string
            format: url
        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: The used API version.
          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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

    IndividualGrant.Get.200:
    IndividualGrant.Get.200:
      description: |
      description: |
        200 OK
        200 OK
@@ -264,3 +300,39 @@ components:
          explode: false
          explode: false
          schema:
          schema:
            type: string
            type: string

    IndividualGrant.Get.403:
      description: |
        403 FORBIDDEN

        Shall be returned upon the following error: The grant
        has been rejected.
        A ProblemDetails structure shall be included in the
        response to provide more details about the rejection in
        the "details" attribute.
      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: The used API version.
          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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
 No newline at end of file
+411 −58

File changed.

Preview size limit exceeded, changes collapsed.

+83 −3
Original line number Original line Diff line number Diff line
@@ -143,7 +143,7 @@ paths:
        406:
        406:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
        409:
        409:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
          $ref: '#/components/responses/PackageContent.Get.409'
        416:
        416:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
        422:
        422:
@@ -187,7 +187,7 @@ paths:
        406:
        406:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
        409:
        409:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
          $ref: '#/components/responses/IndividualArtifact.Get.409'
        416:
        416:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
        422:
        422:
@@ -410,6 +410,46 @@ components:
            type: string
            type: string
            format: binary
            format: binary


    PackageContent.Get.409:
      description: |
        409 CONFLICT

        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 the "state" of the
        VNF snapshot package has a value different from
        "AVAILABLE".
        The response body 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: The used API version.
          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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

    IndividualArtifact.Get.200:
    IndividualArtifact.Get.200:
      description: |
      description: |
        200 OK
        200 OK
@@ -495,3 +535,43 @@ components:
          schema:
          schema:
            type: string
            type: string
            format: binary
            format: binary

    IndividualArtifact.Get.409:
      description: |
        409 CONFLICT

        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 the "state" of the
        VNF snapshot package has a value different from
        "AVAILABLE".
        The response body 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: The used API version.
          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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
 No newline at end of file