Loading src/SOL005/NSDManagement/NSDManagement.yaml +363 −419 File changed.Preview size limit exceeded, changes collapsed. Show changes src/SOL005/NSDManagement/responses/NSDescriptorManagement_resp.yaml→src/SOL005/NSDManagement/responses/SOL005NSDescriptorManagement_resp.yaml +172 −0 Original line number Original line Diff line number Diff line # Copyright (c) ETSI 2017. # https://forge.etsi.org/etsi-forge-copyright-notice.txt responses: responses: 202-with-Location: 206: description: > description: > Accepted Partial Content. The request was accepted for processing, but the processing has not On success, if the NFVO supports range requests, a been completed. The response body shall be empty. single consecutive byte range from the content of the The HTTP response shall include a "Location" HTTP NSD file is returned. header that contains the URI of the newly-created The response body shall contain the requested part of "NS lifecycle operation occurrence" resource the NSD file. corresponding to the operation. 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: headers: Content-Type: Content-Type: description: The MIME type of the body of the response. description: > The MIME type of the body of the response. type: string type: string maximum: 1 maximum: 1 minimum: 1 minimum: 1 Location: Content-Range: description: The resource URI of the created NS instance type: string format: url WWW-Authenticate: description: > description: > Challenge if the corresponding HTTP request has not provided The Content-Range response HTTP header indicates where in a full body message a partial message belongs. authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string type: string maximum: 1 maximum: 1 minimum: 0 minimum: 1 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 WWW-Authenticate: WWW-Authenticate: description: > description: > Challenge if the corresponding HTTP request has not provided Challenge if the corresponding HTTP request has not provided Loading @@ -52,46 +35,22 @@ responses: type: string type: string maximum: 1 maximum: 1 minimum: 0 minimum: 0 409: Version: description: > description: > Conflict Version of the API used in the response. 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. type: string type: string maximum: 1 maximum: 1 minimum: 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: schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-another-nsd-operation-ongoing: description: > Conflict The operation cannot be executed currently, due to a conflict with the 303: state of the NS instance resource. description: > Typically, this is due to the fact that another Descriptor operation is A subscription with the same callbackURI and the same filter already exits and the policy ongoing. of the NFVO is to not create redundant subscriptions. The response body shall contain a ProblemDetails structure, in which the The HTTP response shall include a "Location" HTTP header that contains the resource URI of "detail" attribute should convey more information about the error. the existing subscription resource. The response body shall be empty. headers: headers: Content-Type: Content-Type: description: The MIME type of the body of the response. description: The MIME type of the body of the response. Loading @@ -106,41 +65,27 @@ responses: type: string type: string maximum: 1 maximum: 1 minimum: 0 minimum: 0 schema: Version: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-inconsistent-state: description: > description: > Conflict Version of the API used in the response. 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. type: string type: string maximum: 1 maximum: 1 minimum: 1 minimum: 1 WWW-Authenticate: description: > 409: 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: description: > description: > Conflict Conflict The operation cannot be executed currently, due to a conflict with the Error: The operation cannot be executed currently, state of the NS instance resource. due to a conflict with the state of the resource. Typically, this is due to the fact that the NS instance resource is in Typically, this is due to the fact the NS descriptor INSTANTIATED state. resource is in the enabled operational state (i.e. The response body shall contain a ProblemDetails structure, in which the operationalState = ENABLED) or there are running "detail" attribute should convey more information about the error. 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: headers: Content-Type: Content-Type: description: The MIME type of the body of the response. description: The MIME type of the body of the response. Loading @@ -155,44 +100,26 @@ responses: type: string type: string maximum: 1 maximum: 1 minimum: 0 minimum: 0 schema: Version: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-state-conflict-not-FAILED_TEMP: description: > description: > The operation cannot be executed currently, due to a conflict with the Version of the API used in the response. 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. type: string type: string maximum: 1 maximum: 1 minimum: 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: schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-state-conflict-NOT-INSTANTIATED: 412: description: > 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 Typically, this is due to an ETag mismatch, indicating that the state of the NS instance resource. resource was modified by another entity. Typically, this is due to the fact that the NS instance resource is in NOT-INSTANTIATED state, or that another lifecycle management operation The response body should is ongoing. contain a ProblemDetails structure, in which the "detail" attribute The response body shall contain a ProblemDetails structure, in which the should convey more information about the error. "detail" attribute should convey more information about the error. headers: headers: Content-Type: Content-Type: description: The MIME type of the body of the response. description: The MIME type of the body of the response. Loading @@ -207,46 +134,20 @@ responses: type: string type: string maximum: 1 maximum: 1 minimum: 0 minimum: 0 schema: Version: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-nsd-onboarding-state-NOT-ONBOARDED: description: > description: > Conflict Version of the API used in the response. 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. type: string type: string maximum: 1 maximum: 1 minimum: 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: schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-pnfd-onboarding-state-NOT-ONBOARDED: description: > Conflict Error: The operation cannot be executed currently, 416: due to a conflict with the state of the resource. description: > Typically, this is due to the fact pnfdOnboardingState The byte range passed in the "Range" header did not has a value different from ONBOARDED. match any available byte range in the NSD file (e.g. access after end of file). The response body shall contain a ProblemDetails The response body may contain a ProblemDetails structure. structure, in which the "detail" attribute shall convey more information about the error. headers: headers: Content-Type: Content-Type: description: The MIME type of the body of the response. description: The MIME type of the body of the response. Loading @@ -261,32 +162,11 @@ responses: type: string type: string maximum: 1 maximum: 1 minimum: 0 minimum: 0 schema: Version: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-pnfd-onboarding-state-NOT-CREATED: description: > description: > Conflict. Version of the API used in the response. 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. type: string type: string maximum: 1 maximum: 1 minimum: 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: schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" No newline at end of file No newline at end of file src/SOL005/responses/SOL005_resp.yaml +26 −26 File changed.Contains only whitespace changes. Show changes Loading
src/SOL005/NSDManagement/NSDManagement.yaml +363 −419 File changed.Preview size limit exceeded, changes collapsed. Show changes
src/SOL005/NSDManagement/responses/NSDescriptorManagement_resp.yaml→src/SOL005/NSDManagement/responses/SOL005NSDescriptorManagement_resp.yaml +172 −0 Original line number Original line Diff line number Diff line # Copyright (c) ETSI 2017. # https://forge.etsi.org/etsi-forge-copyright-notice.txt responses: responses: 202-with-Location: 206: description: > description: > Accepted Partial Content. The request was accepted for processing, but the processing has not On success, if the NFVO supports range requests, a been completed. The response body shall be empty. single consecutive byte range from the content of the The HTTP response shall include a "Location" HTTP NSD file is returned. header that contains the URI of the newly-created The response body shall contain the requested part of "NS lifecycle operation occurrence" resource the NSD file. corresponding to the operation. 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: headers: Content-Type: Content-Type: description: The MIME type of the body of the response. description: > The MIME type of the body of the response. type: string type: string maximum: 1 maximum: 1 minimum: 1 minimum: 1 Location: Content-Range: description: The resource URI of the created NS instance type: string format: url WWW-Authenticate: description: > description: > Challenge if the corresponding HTTP request has not provided The Content-Range response HTTP header indicates where in a full body message a partial message belongs. authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string type: string maximum: 1 maximum: 1 minimum: 0 minimum: 1 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 WWW-Authenticate: WWW-Authenticate: description: > description: > Challenge if the corresponding HTTP request has not provided Challenge if the corresponding HTTP request has not provided Loading @@ -52,46 +35,22 @@ responses: type: string type: string maximum: 1 maximum: 1 minimum: 0 minimum: 0 409: Version: description: > description: > Conflict Version of the API used in the response. 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. type: string type: string maximum: 1 maximum: 1 minimum: 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: schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-another-nsd-operation-ongoing: description: > Conflict The operation cannot be executed currently, due to a conflict with the 303: state of the NS instance resource. description: > Typically, this is due to the fact that another Descriptor operation is A subscription with the same callbackURI and the same filter already exits and the policy ongoing. of the NFVO is to not create redundant subscriptions. The response body shall contain a ProblemDetails structure, in which the The HTTP response shall include a "Location" HTTP header that contains the resource URI of "detail" attribute should convey more information about the error. the existing subscription resource. The response body shall be empty. headers: headers: Content-Type: Content-Type: description: The MIME type of the body of the response. description: The MIME type of the body of the response. Loading @@ -106,41 +65,27 @@ responses: type: string type: string maximum: 1 maximum: 1 minimum: 0 minimum: 0 schema: Version: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-inconsistent-state: description: > description: > Conflict Version of the API used in the response. 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. type: string type: string maximum: 1 maximum: 1 minimum: 1 minimum: 1 WWW-Authenticate: description: > 409: 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: description: > description: > Conflict Conflict The operation cannot be executed currently, due to a conflict with the Error: The operation cannot be executed currently, state of the NS instance resource. due to a conflict with the state of the resource. Typically, this is due to the fact that the NS instance resource is in Typically, this is due to the fact the NS descriptor INSTANTIATED state. resource is in the enabled operational state (i.e. The response body shall contain a ProblemDetails structure, in which the operationalState = ENABLED) or there are running "detail" attribute should convey more information about the error. 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: headers: Content-Type: Content-Type: description: The MIME type of the body of the response. description: The MIME type of the body of the response. Loading @@ -155,44 +100,26 @@ responses: type: string type: string maximum: 1 maximum: 1 minimum: 0 minimum: 0 schema: Version: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-state-conflict-not-FAILED_TEMP: description: > description: > The operation cannot be executed currently, due to a conflict with the Version of the API used in the response. 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. type: string type: string maximum: 1 maximum: 1 minimum: 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: schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-state-conflict-NOT-INSTANTIATED: 412: description: > 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 Typically, this is due to an ETag mismatch, indicating that the state of the NS instance resource. resource was modified by another entity. Typically, this is due to the fact that the NS instance resource is in NOT-INSTANTIATED state, or that another lifecycle management operation The response body should is ongoing. contain a ProblemDetails structure, in which the "detail" attribute The response body shall contain a ProblemDetails structure, in which the should convey more information about the error. "detail" attribute should convey more information about the error. headers: headers: Content-Type: Content-Type: description: The MIME type of the body of the response. description: The MIME type of the body of the response. Loading @@ -207,46 +134,20 @@ responses: type: string type: string maximum: 1 maximum: 1 minimum: 0 minimum: 0 schema: Version: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-nsd-onboarding-state-NOT-ONBOARDED: description: > description: > Conflict Version of the API used in the response. 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. type: string type: string maximum: 1 maximum: 1 minimum: 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: schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-pnfd-onboarding-state-NOT-ONBOARDED: description: > Conflict Error: The operation cannot be executed currently, 416: due to a conflict with the state of the resource. description: > Typically, this is due to the fact pnfdOnboardingState The byte range passed in the "Range" header did not has a value different from ONBOARDED. match any available byte range in the NSD file (e.g. access after end of file). The response body shall contain a ProblemDetails The response body may contain a ProblemDetails structure. structure, in which the "detail" attribute shall convey more information about the error. headers: headers: Content-Type: Content-Type: description: The MIME type of the body of the response. description: The MIME type of the body of the response. Loading @@ -261,32 +162,11 @@ responses: type: string type: string maximum: 1 maximum: 1 minimum: 0 minimum: 0 schema: Version: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-pnfd-onboarding-state-NOT-CREATED: description: > description: > Conflict. Version of the API used in the response. 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. type: string type: string maximum: 1 maximum: 1 minimum: 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: schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" No newline at end of file No newline at end of file
src/SOL005/responses/SOL005_resp.yaml +26 −26 File changed.Contains only whitespace changes. Show changes
