Loading src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml +181 −191 Original line number Diff line number Diff line swagger: "2.0" openapi: 3.0.2 info: version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - VNF Lifecycle Operation Granting interface description: > description: | SOL003 - VNF Lifecycle Operation Granting interface Loading @@ -20,38 +19,35 @@ info: design. Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= contact: name: NFV-SOL WG license: name: "ETSI Forge copyright notice" name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: description: ETSI GS NFV-SOL 003 V2.7.1 description: ETSI GS NFV-SOL 003 V3.3.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf basePath: "/grant/v1" schemes: - https consumes: - "application/json" produces: - "application/json" servers: - url: http://127.0.0.1/grant/v1 - url: https://127.0.0.1/grant/v1 paths: ############################################################################### # API Versions # ############################################################################### '/api_versions': /api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' ############################################################################### # Resource: Grants # ############################################################################### '/grants': /grants: #SOL003 location: 9.4.2 post: description: > description: | Grant Lifecycle Operation. The POST method requests a grant for a particular VNF lifecycle operation. This method shall follow the provisions specified in the tables 9.4.2.3.1-1 and 9.4.2.3.1-2 Loading @@ -62,101 +58,22 @@ paths: case which is indicated by responding with "202 Accepted", this resource may be created after the response is returned. 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: false type: string - name: Version description: > Version of the API requested to use when responding to this request. in: header required: true type: string - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version requestBody: $ref: '#/components/requestBodies/GrantRequest' responses: 201: description: > 201 CREATED Shall be returned when the grant has been 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: 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 Version: description: > Version of the API used in the response. type: string maximum: 1 minimum: 1 schema: $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" $ref: '#/components/responses/Grants.Post.201' 202: description: > 202 ACCEPTED Shall be returned when the request has been accepted for processing and 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: 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 $ref: '#/components/responses/Grants.Post.202' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: # description: > #description: | # 403 FORBIDDEN # # Shall be returned upon the following error: The grant has been rejected. Loading @@ -179,102 +96,31 @@ paths: ############################################################################### # Resource: Individual grant # ############################################################################### '/grants/{grantId}': /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 - $ref: '#/components/parameters/GrantId' get: description: > description: | Grant Lifecycle Operation. The GET method reads a grant. This method shall follow the provisions specified in the tables 9.4.3.3.2-1 and 9.4.3.3.2-2 for URI query parameters, request and response data structures, and response codes. parameters: - name: Accept description: > Content-Types that are acceptable for the response. 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: false type: string - name: Version description: > Version of the API requested to use when responding to this request. in: header required: true type: string - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: description: > 200 OK Shall be returned when the grant has been read successfully. A representation of the "Individual grant" resource shall be returned in the response body. headers: 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 Version: description: > Version of the API used in the response. type: string maximum: 1 minimum: 1 schema: $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" $ref: '#/components/responses/IndividualGrant.Get.200' 202: description: > 202 ACCEPTED Shall be returned when the process of creating the grant is ongoing, no grant is available yet. The response body shall be empty. 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. type: string maximum: 1 minimum: 0 Version: description: > Version of the API used in the response. type: string maximum: 1 minimum: 1 $ref: '#/components/responses/IndividualGrant.Get.202' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: # description: > #description: | # 403 FORBIDDEN # # Shall be returned upon the following error: The grant has been rejected. Loading @@ -293,3 +139,147 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" components: parameters: GrantId: name: grantId in: path 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. required: true style: simple explode: false schema: type: string requestBodies: GrantRequest: content: application/json: schema: $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/GrantRequest" required: true responses: Grants.Post.201: description: | 201 CREATED Shall be returned when the grant has been 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: 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: application/json: schema: $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" Grants.Post.202: description: | 202 ACCEPTED Shall be returned when the request has been accepted for processing and 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: 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 IndividualGrant.Get.200: description: | 200 OK Shall be returned when the grant has been read successfully. A representation of the "Individual grant" resource shall be returned in the response body. 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: application/json: schema: $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" IndividualGrant.Get.202: description: | 202 ACCEPTED Shall be returned when the process of creating the grant is ongoing, no grant is available yet. The response body shall be empty. 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 No newline at end of file Loading
src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml +181 −191 Original line number Diff line number Diff line swagger: "2.0" openapi: 3.0.2 info: version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - VNF Lifecycle Operation Granting interface description: > description: | SOL003 - VNF Lifecycle Operation Granting interface Loading @@ -20,38 +19,35 @@ info: design. Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= contact: name: NFV-SOL WG license: name: "ETSI Forge copyright notice" name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: description: ETSI GS NFV-SOL 003 V2.7.1 description: ETSI GS NFV-SOL 003 V3.3.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf basePath: "/grant/v1" schemes: - https consumes: - "application/json" produces: - "application/json" servers: - url: http://127.0.0.1/grant/v1 - url: https://127.0.0.1/grant/v1 paths: ############################################################################### # API Versions # ############################################################################### '/api_versions': /api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' ############################################################################### # Resource: Grants # ############################################################################### '/grants': /grants: #SOL003 location: 9.4.2 post: description: > description: | Grant Lifecycle Operation. The POST method requests a grant for a particular VNF lifecycle operation. This method shall follow the provisions specified in the tables 9.4.2.3.1-1 and 9.4.2.3.1-2 Loading @@ -62,101 +58,22 @@ paths: case which is indicated by responding with "202 Accepted", this resource may be created after the response is returned. 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: false type: string - name: Version description: > Version of the API requested to use when responding to this request. in: header required: true type: string - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version requestBody: $ref: '#/components/requestBodies/GrantRequest' responses: 201: description: > 201 CREATED Shall be returned when the grant has been 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: 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 Version: description: > Version of the API used in the response. type: string maximum: 1 minimum: 1 schema: $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" $ref: '#/components/responses/Grants.Post.201' 202: description: > 202 ACCEPTED Shall be returned when the request has been accepted for processing and 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: 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 $ref: '#/components/responses/Grants.Post.202' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: # description: > #description: | # 403 FORBIDDEN # # Shall be returned upon the following error: The grant has been rejected. Loading @@ -179,102 +96,31 @@ paths: ############################################################################### # Resource: Individual grant # ############################################################################### '/grants/{grantId}': /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 - $ref: '#/components/parameters/GrantId' get: description: > description: | Grant Lifecycle Operation. The GET method reads a grant. This method shall follow the provisions specified in the tables 9.4.3.3.2-1 and 9.4.3.3.2-2 for URI query parameters, request and response data structures, and response codes. parameters: - name: Accept description: > Content-Types that are acceptable for the response. 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: false type: string - name: Version description: > Version of the API requested to use when responding to this request. in: header required: true type: string - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: description: > 200 OK Shall be returned when the grant has been read successfully. A representation of the "Individual grant" resource shall be returned in the response body. headers: 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 Version: description: > Version of the API used in the response. type: string maximum: 1 minimum: 1 schema: $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" $ref: '#/components/responses/IndividualGrant.Get.200' 202: description: > 202 ACCEPTED Shall be returned when the process of creating the grant is ongoing, no grant is available yet. The response body shall be empty. 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. type: string maximum: 1 minimum: 0 Version: description: > Version of the API used in the response. type: string maximum: 1 minimum: 1 $ref: '#/components/responses/IndividualGrant.Get.202' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: # description: > #description: | # 403 FORBIDDEN # # Shall be returned upon the following error: The grant has been rejected. Loading @@ -293,3 +139,147 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" components: parameters: GrantId: name: grantId in: path 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. required: true style: simple explode: false schema: type: string requestBodies: GrantRequest: content: application/json: schema: $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/GrantRequest" required: true responses: Grants.Post.201: description: | 201 CREATED Shall be returned when the grant has been 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: 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: application/json: schema: $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" Grants.Post.202: description: | 202 ACCEPTED Shall be returned when the request has been accepted for processing and 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: 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 IndividualGrant.Get.200: description: | 200 OK Shall be returned when the grant has been read successfully. A representation of the "Individual grant" resource shall be returned in the response body. 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: application/json: schema: $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" IndividualGrant.Get.202: description: | 202 ACCEPTED Shall be returned when the process of creating the grant is ongoing, no grant is available yet. The response body shall be empty. 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 No newline at end of file
