Loading src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml +253 −250 Original line number Diff line number Diff line swagger: "2.0" openapi: 3.0.2 info: version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - Virtualised Resources Quota Available Notification interface description: > description: | SOL003 - Virtualised Resources Quota Available Notification interface Loading @@ -20,37 +19,37 @@ 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.2.1-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: "/vrqan/v1" schemes: - https consumes: - "application/json" produces: - "application/json" servers: - url: http://127.0.0.1/vrqan/v1 - url: https://127.0.0.1/vrqan/v1 paths: ############################################################################### # API Versions # ############################################################################### '/api_versions': /api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' ############################################################################### # Subscriptions # ############################################################################### '/subscriptions': /subscriptions: parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: description: > description: | Subscribe. The POST method creates a new subscription. This method shall follow the provisions specified in the tables 11.4.2.3.1-1 and 11.4.2.3.1-2 Loading @@ -68,78 +67,17 @@ paths: it shall return a "303 See Other" response code referencing the existing "Individual subscription" resource with the same filter and callback URI). 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: Content-Type description: > The Content-Type header shall be set to "application/merge-patch+json" according to IETF RFC 7396. in: header required: true type: string - name: VrQuotaAvailSubscriptionRequest description: Details of the subscription to be created. in: body required: true schema: $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscriptionRequest" - 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/Content-Type requestBody: $ref: '#/components/requestBodies/VrQuotaAvailSubscriptionRequest' responses: 201: description: > 201 CREATED Shall be returned when the subscription has been created successfully. The response body shall contain a representation of the created "Individual subscription" resource. The HTTP response shall include a "Location" HTTP header that points to the created resource. 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/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription" $ref: '#/components/responses/Subscriptions.Post.201' 303: # description: > #description: | # 303 SEE OTHER # # Shall be returned when a subscription with the same callback URI and the same # filter already exists 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 Loading Loading @@ -168,110 +106,20 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" get: description: > description: | Query Subscription Information. The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations. This method shall follow the provisions specified in the tables 11.4.2.3.2-1 and 11.4.2.3.2-2 for URI query parameters, request and response data structures, and response codes. parameters: - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: filter description: > Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. The VNFM shall support receiving this parameter as part of the URI query string. The NFVO may supply this parameter. All attribute names that appear in the VrQuotaAvailSubscription and in data types referenced from it shall be supported by the VNFM in the filter expression. in: query required: false type: string - name: nextpage_opaque_marker description: > Marker to obtain the next page of a paged response. Shall be supported by the VNFM if the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. in: query 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/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: 200: description: > 200 OK Shall be returned when the list of subscriptions has been queried successfully. The response body shall contain in an array the representations of all active subscriptions of the functional block that invokes the method, i.e. zero or more representations of virtualised resource quota available subscriptions as defined in clause 11.5.2.3. If the "filter" URI parameter was supplied in the request, the data in the response body shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. 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 Link: description: > Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. type: string maximum: 1 minimum: 0 schema: type: array items: $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription" $ref: '#/components/responses/Subscriptions.Get.200' 204: description: > No Content The notification endpoint was tested successfully. 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/Subscriptions.Get.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -296,56 +144,20 @@ paths: ############################################################################### # Individual subscription # ############################################################################### '/subscriptions/{subscriptionId}': /subscriptions/{subscriptionId}: parameters: - name: subscriptionId description: > Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new "Individual subscription" resource. 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/SubscriptionId' - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: description: > description: | Query Subscription Information. The GET method reads an individual subscription. This method shall follow the provisions specified in the tables 11.4.3.3.2-1 and 11.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: true type: string responses: 200: description: > 200 OK Shall be returned when information about an individual subscription has been read successfully. The response body shall contain a representation of the "Individual subscription" resource headers: Content-Type: description: > The MIME type of the body of the request. Reference: IETF RFC 7231 type: string maximum: 1 minimum: 1 schema: $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription" $ref: '#/components/responses/IndividualSubscription.Get.200' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -368,7 +180,7 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" delete: description: > description: | Terminate subscription. The DELETE method terminates an individual subscription. This method shall follow the provisions specified in the tables 11.4.3.3.5-1 and 11.4.3.3.5-2 Loading @@ -378,28 +190,9 @@ paths: sent to the formerly-subscribed API consumer. NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed API consumer for a certain time period after the deletion. parameters: - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: true type: string responses: 204: description: > No Content Shall be returned when the "Individual subscription" resource has been deleted successfully. headers: Content-Type: description: > The MIME type of the body of the request. Reference: IETF RFC 7231 type: string maximum: 1 minimum: 1 $ref: '#/components/responses/IndividualSubscription.Delete.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -420,3 +213,213 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" components: parameters: SubscriptionId: name: subscriptionId in: path description: | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new "Individual subscription" resource. 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: VrQuotaAvailSubscriptionRequest: description: | Details of the subscription to be created. content: application/json: schema: $ref: "xxx/VrQuotaAvailSubscriptionRequest" required: true responses: Subscriptions.Post.201: description: | 201 CREATED Shall be returned when the subscription has been created successfully. The response body shall contain a representation of the created "Individual subscription" resource. The HTTP response shall include a "Location" HTTP header that points to the created resource. headers: Version: description: | The used API version. style: simple explode: false schema: type: string 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 Content-Type: description: | The MIME type of the body of the response. style: simple explode: false schema: type: string Location: description: | The resource URI of the created VNF instance style: simple explode: false schema: type: string format: url content: application/json: schema: $ref: ./definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription Subscriptions.Get.200: description: | 200 OK Shall be returned when the list of subscriptions has been queried successfully. The response body shall contain in an array the representations of all active subscriptions of the functional block that invokes the method, i.e. zero or more representations of virtualised resource quota available subscriptions as defined in clause 11.5.2.3. If the "filter" URI parameter was supplied in the request, the data in the response body shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. headers: Version: description: | The used API version. style: simple explode: false schema: type: string 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 Content-Type: description: | The MIME type of the body of the response. style: simple explode: false schema: type: string Link: description: | Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. style: simple explode: false schema: type: string content: application/json: schema: type: array items: $ref: ./definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription Subscriptions.Get.204: description: | No Content The notification endpoint was tested successfully. The response body shall be empty. headers: Version: description: | The used API version. style: simple explode: false schema: type: string 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 IndividualSubscription.Get.200: description: | 200 OK Shall be returned when information about an individual subscription has been read successfully. The response body shall contain a representation of the "Individual subscription" resource. headers: Version: description: | The used API version. style: simple explode: false schema: type: string 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 Content-Type: description: | The MIME type of the body of the response. style: simple explode: false schema: type: string content: application/json: schema: $ref: ./definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription IndividualSubscription.Delete.204: description: | No Content Shall be returned when the "Individual subscription" resource has been deleted successfully. headers: Version: description: | The used API version. style: simple explode: false schema: type: string 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 Content-Type: description: | The MIME type of the body of the response. style: simple explode: false schema: type: string No newline at end of file Loading
src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml +253 −250 Original line number Diff line number Diff line swagger: "2.0" openapi: 3.0.2 info: version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - Virtualised Resources Quota Available Notification interface description: > description: | SOL003 - Virtualised Resources Quota Available Notification interface Loading @@ -20,37 +19,37 @@ 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.2.1-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: "/vrqan/v1" schemes: - https consumes: - "application/json" produces: - "application/json" servers: - url: http://127.0.0.1/vrqan/v1 - url: https://127.0.0.1/vrqan/v1 paths: ############################################################################### # API Versions # ############################################################################### '/api_versions': /api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' ############################################################################### # Subscriptions # ############################################################################### '/subscriptions': /subscriptions: parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: description: > description: | Subscribe. The POST method creates a new subscription. This method shall follow the provisions specified in the tables 11.4.2.3.1-1 and 11.4.2.3.1-2 Loading @@ -68,78 +67,17 @@ paths: it shall return a "303 See Other" response code referencing the existing "Individual subscription" resource with the same filter and callback URI). 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: Content-Type description: > The Content-Type header shall be set to "application/merge-patch+json" according to IETF RFC 7396. in: header required: true type: string - name: VrQuotaAvailSubscriptionRequest description: Details of the subscription to be created. in: body required: true schema: $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscriptionRequest" - 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/Content-Type requestBody: $ref: '#/components/requestBodies/VrQuotaAvailSubscriptionRequest' responses: 201: description: > 201 CREATED Shall be returned when the subscription has been created successfully. The response body shall contain a representation of the created "Individual subscription" resource. The HTTP response shall include a "Location" HTTP header that points to the created resource. 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/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription" $ref: '#/components/responses/Subscriptions.Post.201' 303: # description: > #description: | # 303 SEE OTHER # # Shall be returned when a subscription with the same callback URI and the same # filter already exists 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 Loading Loading @@ -168,110 +106,20 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" get: description: > description: | Query Subscription Information. The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations. This method shall follow the provisions specified in the tables 11.4.2.3.2-1 and 11.4.2.3.2-2 for URI query parameters, request and response data structures, and response codes. parameters: - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: filter description: > Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. The VNFM shall support receiving this parameter as part of the URI query string. The NFVO may supply this parameter. All attribute names that appear in the VrQuotaAvailSubscription and in data types referenced from it shall be supported by the VNFM in the filter expression. in: query required: false type: string - name: nextpage_opaque_marker description: > Marker to obtain the next page of a paged response. Shall be supported by the VNFM if the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. in: query 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/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: 200: description: > 200 OK Shall be returned when the list of subscriptions has been queried successfully. The response body shall contain in an array the representations of all active subscriptions of the functional block that invokes the method, i.e. zero or more representations of virtualised resource quota available subscriptions as defined in clause 11.5.2.3. If the "filter" URI parameter was supplied in the request, the data in the response body shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. 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 Link: description: > Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. type: string maximum: 1 minimum: 0 schema: type: array items: $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription" $ref: '#/components/responses/Subscriptions.Get.200' 204: description: > No Content The notification endpoint was tested successfully. 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/Subscriptions.Get.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -296,56 +144,20 @@ paths: ############################################################################### # Individual subscription # ############################################################################### '/subscriptions/{subscriptionId}': /subscriptions/{subscriptionId}: parameters: - name: subscriptionId description: > Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new "Individual subscription" resource. 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/SubscriptionId' - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: description: > description: | Query Subscription Information. The GET method reads an individual subscription. This method shall follow the provisions specified in the tables 11.4.3.3.2-1 and 11.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: true type: string responses: 200: description: > 200 OK Shall be returned when information about an individual subscription has been read successfully. The response body shall contain a representation of the "Individual subscription" resource headers: Content-Type: description: > The MIME type of the body of the request. Reference: IETF RFC 7231 type: string maximum: 1 minimum: 1 schema: $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription" $ref: '#/components/responses/IndividualSubscription.Get.200' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -368,7 +180,7 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" delete: description: > description: | Terminate subscription. The DELETE method terminates an individual subscription. This method shall follow the provisions specified in the tables 11.4.3.3.5-1 and 11.4.3.3.5-2 Loading @@ -378,28 +190,9 @@ paths: sent to the formerly-subscribed API consumer. NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed API consumer for a certain time period after the deletion. parameters: - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: true type: string responses: 204: description: > No Content Shall be returned when the "Individual subscription" resource has been deleted successfully. headers: Content-Type: description: > The MIME type of the body of the request. Reference: IETF RFC 7231 type: string maximum: 1 minimum: 1 $ref: '#/components/responses/IndividualSubscription.Delete.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -420,3 +213,213 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" components: parameters: SubscriptionId: name: subscriptionId in: path description: | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new "Individual subscription" resource. 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: VrQuotaAvailSubscriptionRequest: description: | Details of the subscription to be created. content: application/json: schema: $ref: "xxx/VrQuotaAvailSubscriptionRequest" required: true responses: Subscriptions.Post.201: description: | 201 CREATED Shall be returned when the subscription has been created successfully. The response body shall contain a representation of the created "Individual subscription" resource. The HTTP response shall include a "Location" HTTP header that points to the created resource. headers: Version: description: | The used API version. style: simple explode: false schema: type: string 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 Content-Type: description: | The MIME type of the body of the response. style: simple explode: false schema: type: string Location: description: | The resource URI of the created VNF instance style: simple explode: false schema: type: string format: url content: application/json: schema: $ref: ./definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription Subscriptions.Get.200: description: | 200 OK Shall be returned when the list of subscriptions has been queried successfully. The response body shall contain in an array the representations of all active subscriptions of the functional block that invokes the method, i.e. zero or more representations of virtualised resource quota available subscriptions as defined in clause 11.5.2.3. If the "filter" URI parameter was supplied in the request, the data in the response body shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. headers: Version: description: | The used API version. style: simple explode: false schema: type: string 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 Content-Type: description: | The MIME type of the body of the response. style: simple explode: false schema: type: string Link: description: | Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. style: simple explode: false schema: type: string content: application/json: schema: type: array items: $ref: ./definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription Subscriptions.Get.204: description: | No Content The notification endpoint was tested successfully. The response body shall be empty. headers: Version: description: | The used API version. style: simple explode: false schema: type: string 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 IndividualSubscription.Get.200: description: | 200 OK Shall be returned when information about an individual subscription has been read successfully. The response body shall contain a representation of the "Individual subscription" resource. headers: Version: description: | The used API version. style: simple explode: false schema: type: string 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 Content-Type: description: | The MIME type of the body of the response. style: simple explode: false schema: type: string content: application/json: schema: $ref: ./definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription IndividualSubscription.Delete.204: description: | No Content Shall be returned when the "Individual subscription" resource has been deleted successfully. headers: Version: description: | The used API version. style: simple explode: false schema: type: string 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 Content-Type: description: | The MIME type of the body of the response. style: simple explode: false schema: type: string No newline at end of file
