Commit 3363ad79 authored by moscatelli's avatar moscatelli
Browse files

NSD mgmt referenced to common response codes updated

parent e0b3181f
Loading
Loading
Loading
Loading
Loading
+363 −419

File changed.

Preview size limit exceeded, changes collapsed.

+172 −0
Original line number Diff line number Diff line
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
responses:
  202-with-Location:
  206:
    description: >
      Accepted
      Partial Content.

      The request was accepted for processing, but the processing has not
      been completed. The response body shall be empty.
      The HTTP response shall include a "Location" HTTP
      header that contains the URI of the newly-created
      "NS lifecycle operation occurrence" resource
      corresponding to the operation.
      On success, if the NFVO supports range requests, a
      single consecutive byte range from the content of the
      NSD file is returned.
      The response body shall contain the requested part of
      the NSD file.
      The "Content-Range" HTTP header shall be provided
      according to IETF RFC 7233 [23].
      The "Content-Type" HTTP header shall be set as
      defined above for the "200 OK" response.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        description: >
          The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
      Location:
        description: The resource URI of the created NS instance
        type: string
        format: url
      WWW-Authenticate:
      Content-Range:
        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.
          The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
        type: string
        maximum: 1
        minimum: 0
    schema:
      $ref: "../definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
  202-with-Location-empty:
    description: >
      Accepted

      The request was accepted for processing, but the processing has not
      been completed. On success, the HTTP response shall include a
      "Location" HTTP header that contains the URI of the newly-created
      "NS Descriptor operation occurrence" resource corresponding to the
      operation.
      The response body shall be empty.
    headers:
      Location:
        description: The resource URI of the created NS instance
        type: string
        format: url
        minimum: 1
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
@@ -52,46 +35,22 @@ responses:
        type: string
        maximum: 1
        minimum: 0
  409:
      Version:
        description: >
      Conflict

      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 NS descriptor
      resource is in the enabled operational state (i.e.
      operationalState = ENABLED) or there are running
      NS instances using the concerned individual NS
      descriptor resource (i.e. usageState = IN_USE).
      The response body shall contain a ProblemDetails
      structure, in which the "detail" attribute shall convey
      more information about the error.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
          Version of the API used in the response.
        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.
        type: string
        maximum: 1
        minimum: 0
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  409-another-nsd-operation-ongoing:
    description: >
      Conflict
      $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

      The operation cannot be executed currently, due to a conflict with the
      state of the NS instance resource.
      Typically, this is due to the fact that another Descriptor operation is
      ongoing.
      The response body shall contain a ProblemDetails structure, in which the
      "detail" attribute should convey more information about the error.
  303:
    description: >
      A subscription with the same callbackURI and the same filter already exits and the policy
      of the NFVO is to not create redundant subscriptions.
      The HTTP response shall include a "Location" HTTP header that contains the resource URI of
      the existing subscription resource.
      The response body shall be empty.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
@@ -106,41 +65,27 @@ responses:
        type: string
        maximum: 1
        minimum: 0
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  409-inconsistent-state:
      Version:
        description: >
      Conflict

      Another request is in progress that prohibits the fulfillment of
      the current request, or the current resource state is inconsistent
      with the request.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
          Version of the API used in the response.
        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.
        type: string
        maximum: 1
        minimum: 0
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  409-state-conflict-INSTANTIATED:

  409:
    description: >
      Conflict

      The operation cannot be executed currently, due to a conflict with the
      state of the NS instance resource.
      Typically, this is due to the fact that the NS instance resource is in
      INSTANTIATED state.
      The response body shall contain a ProblemDetails structure, in which the
      "detail" attribute should convey more information about the error.
      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 NS descriptor
      resource is in the enabled operational state (i.e.
      operationalState = ENABLED) or there are running
      NS instances using the concerned individual NS
      descriptor resource (i.e. usageState = IN_USE).
      The response body shall contain a ProblemDetails
      structure, in which the "detail" attribute shall convey
      more information about the error.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
@@ -155,44 +100,26 @@ responses:
        type: string
        maximum: 1
        minimum: 0
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  409-state-conflict-not-FAILED_TEMP:
      Version:
        description: >
      The operation cannot be executed currently, due to a conflict with the
      state of the NS instance resource.
      Typically, this is due to the fact that the NS instance resource is
      not in FAILED_TEMP state, or another error handling action is starting,
      such as rollback or fail.
      The response body shall contain a ProblemDetails structure, in which the
      "detail" attribute should convey more information about the error.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
          Version of the API used in the response.
        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.
        type: string
        maximum: 1
        minimum: 0
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  409-state-conflict-NOT-INSTANTIATED:
      $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

  412:
    description: >
      Conflict
      Precondition Failed.
      A precondition given in an HTTP request header is not fulfilled.

      The operation cannot be executed currently, due to a conflict with the
      state of the NS instance resource.
      Typically, this is due to the fact that the NS 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 should convey more information about the error.
      Typically, this is due to an ETag mismatch, indicating that the
      resource was modified by another entity.

      The response body should
      contain a ProblemDetails structure, in which the "detail" attribute
      should convey more information about the error.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
@@ -207,46 +134,20 @@ responses:
        type: string
        maximum: 1
        minimum: 0
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  409-nsd-onboarding-state-NOT-ONBOARDED:
      Version:
        description: >
      Conflict

      Error: The operation cannot be executed currently,
      due to a conflict with the state of the resource.
      Typically, this is due to the fact "nsdOnboardingState"
      has a value different from ONBOARDED.
      The response body shall contain a ProblemDetails
      structure, in which the "detail" attribute shall convey
      more information about the error.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
          Version of the API used in the response.
        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.
        type: string
        maximum: 1
        minimum: 0
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  409-pnfd-onboarding-state-NOT-ONBOARDED:
    description: >
      Conflict
      $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

      Error: The operation cannot be executed currently,
      due to a conflict with the state of the resource.
      Typically, this is due to the fact pnfdOnboardingState
      has a value different from ONBOARDED.
      The response body shall contain a ProblemDetails
      structure, in which the "detail" attribute shall convey
      more information about the error.
  416:
    description: >
      The byte range passed in the "Range" header did not
      match any available byte range in the NSD file (e.g. access after end of file).
      The response body may contain a ProblemDetails structure.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
@@ -261,32 +162,11 @@ responses:
        type: string
        maximum: 1
        minimum: 0
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  409-pnfd-onboarding-state-NOT-CREATED:
      Version:
        description: >
      Conflict.

      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
      PnfdOnboardingState has a value other than CREATED.
      The response body shall contain a ProblemDetails
      structure, in which the "detail" attribute shall convey
      more information about the error.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
          Version of the API used in the response.
        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.
        type: string
        maximum: 1
        minimum: 0
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
 No newline at end of file
      $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
 No newline at end of file
+26 −26

File changed.

Contains only whitespace changes.