swagger: "2.0" info: version: "2.3.1" title: DRAFT - SOL003 - VNF Lifecycle Operation Granting interface description: > DRAFT - SOL003 - VNF Lifecycle Operation Granting interface IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=--- license: name: "ETSI Forge copyright notice" url: https://forge.etsi.org/etsi-forge-copyright-notice.txt basePath: "/grant/v1" schemes: - https consumes: - "application/json" produces: - "application/json" paths: ############################################################################### # Resource: Grants # ############################################################################### '/grants': #SOL003 location: 9.4.2 post: description: > The POST method requests a grant for a particular VNF lifecycle operation. parameters: - name: GrantRequest in: body required: true schema: $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/GrantRequest" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: true type: string responses: 201: description: > The grant was created successfully (synchronous mode). A representation of the created "Individual grant" resource shall be returned in the response body. The HTTP response shall include a "Location" HTTP header that indicates the URI of the "Individual grant" resource just created. headers: #TODO: Add headers defined in 4.3.4.3 Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 Location: description: The resource URI of the created VNF instance 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. type: string maximum: 1 minimum: 0 schema: $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" 202: description: > The request was accepted for processing, but the processing has not been completed. It is expected to take some time to create the grant (asynchronous mode). The response body shall be empty. The HTTP response shall include a "Location" HTTP header that indicates the URI of the "Individual grant" resource that will be created once the granting decision has been made. headers: #TODO: Add headers defined in 4.3.4.3 Location: description: The resource URI of the created VNF instance 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. type: string maximum: 1 minimum: 0 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: description: > The grant was rejected. A ProblemDetails structure shall be included in the response to provide more details about the rejection in the "details" attribute. headers: #TODO: Add headers defined in 4.3.4.3 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 404: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 416: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" 422: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" ############################################################################### # Resource: Individual grant # ############################################################################### '/grants/{grantId}': #SOL003 location: 9.4.3 parameters: - name: grantId description: > Identifier of the grant. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request granting a new VNF lifecycle operation. It can also be retrieved from the "id" attribute in the payload body of that response. in: path type: string required: true get: description: > The GET method retrieves information about a subscription by reading an individual subscription resource. responses: 200: description: > The grant was read successfully. A representation of the "individual grant" resource shall be returned in the response body. headers: #TODO: Add headers defined in 4.3.4.3 Content-Type: description: The MIME type of the body of 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/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" 202: description: > The process of creating the grant is ongoing, no grant is available yet. The response body shall be empty. headers: #TODO: Add headers defined in 4.3.4.3 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 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: description: > The grant was rejected. A ProblemDetails structure shall be included in the response to provide more details about the rejection in the "details" attribute. headers: #TODO: Add headers defined in 4.3.4.3 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 404: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 416: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" 422: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"