Loading src/SOL005/NFVICapacityInformation/NFVICapacityInformation.yaml +1 −215 Original line number Original line Diff line number Diff line Loading @@ -313,15 +313,6 @@ components: $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/CapacityThresholdModifications $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/CapacityThresholdModifications required: true required: true NfviCapacitySubscriptionRequest: description: | Details of the subscription to be created. content: application/json: schema: $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/NfviCapacityInfoSubscriptionRequest required: true CapacityShortageNotificationRequest: CapacityShortageNotificationRequest: description: | description: | Notification about the available NFVI capacity having crossed below a threshold value or having re-covered from Notification about the available NFVI capacity having crossed below a threshold value or having re-covered from Loading Loading @@ -563,138 +554,6 @@ components: type: string type: string content: {} content: {} NfviCiSubscriptions.Get: description: | 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 NFVI capacity information subscriptions, as defined in clause 10.5.2.9. 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 NFVO 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: | Version of the API used in the response. 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: type: array items: $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/NfviCapacityInfoSubscription NfviCiSubscriptions.Post: description: | Shall be returned when the subscription has been created successfully. A representation of the created subscription resource shall be returned in the response body, as defined in clause 10.5.2.9. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created subscription resource. headers: Version: description: | Version of the API used in the response. 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/NFVICapacityInformation_def.yaml#/components/schemas/NfviCapacityInfoSubscription NfviCiSubscription.Get: description: | Shall be returned when the subscription has been read successfully. The response body shall contain a representation of the subscription resource, as defined in clause 10.5.2.9. headers: Version: description: | Version of the API used in the response. 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/NFVICapacityInformation_def.yaml#/components/schemas/NfviCapacityInfoSubscription NfviCiSubscription.Delete: description: | Shall be returned when the subscription resource has been deleted successfully. The response body shall be empty. headers: Version: description: | Version of the API used in the response. 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: {} CapacityShortageNotification.Post: CapacityShortageNotification.Post: description: | description: | Shall be returned when the notification has been delivered successfully. Shall be returned when the notification has been delivered successfully. Loading Loading @@ -749,76 +608,3 @@ components: schema: schema: type: string type: string content: {} content: {} No newline at end of file callbacks: CapacityShortageNotification: '{$request.body#/callbackUri}': description: >- This resource represents a notification endpoint for NFVI capacity information. The API producer can use this resource to send notifications related to log management events to a subscribed API consumer, which has provided the URI of this resource during the capacity threshold creation process. post: description: >- The POST method delivers a notification regarding an NFVI capacity information event from the API producer to an API consumer. The API consumer shall have previously created an "Individual capacity threshold" resource" parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/Version - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization requestBody: $ref: "#/components/requestBodies/CapacityShortageNotificationRequest" responses: "204": $ref: '#/components/responses/CapacityShortageNotification.Post' "400": $ref: ../responses/SOL005_resp.yaml#/components/responses/400 "401": $ref: ../responses/SOL005_resp.yaml#/components/responses/401 "403": $ref: ../responses/SOL005_resp.yaml#/components/responses/403 "404": $ref: ../responses/SOL005_resp.yaml#/components/responses/404 "405": $ref: ../responses/SOL005_resp.yaml#/components/responses/405 "406": $ref: ../responses/SOL005_resp.yaml#/components/responses/406 "422": $ref: ../responses/SOL005_resp.yaml#/components/responses/422 "500": $ref: ../responses/SOL005_resp.yaml#/components/responses/500 "503": $ref: ../responses/SOL005_resp.yaml#/components/responses/503 "504": $ref: ../responses/SOL005_resp.yaml#/components/responses/504 get: description: >- The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, e.g. during creation of the capacity threshold resource. parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/Version - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization responses: "204": $ref: '#/components/responses/CapacityShortageNotification.Get' "400": $ref: ../responses/SOL005_resp.yaml#/components/responses/400 "401": $ref: ../responses/SOL005_resp.yaml#/components/responses/401 "403": $ref: ../responses/SOL005_resp.yaml#/components/responses/403 "404": $ref: ../responses/SOL005_resp.yaml#/components/responses/404 "405": $ref: ../responses/SOL005_resp.yaml#/components/responses/405 "406": $ref: ../responses/SOL005_resp.yaml#/components/responses/406 "422": $ref: ../responses/SOL005_resp.yaml#/components/responses/422 "500": $ref: ../responses/SOL005_resp.yaml#/components/responses/500 "503": $ref: ../responses/SOL005_resp.yaml#/components/responses/503 "504": $ref: ../responses/SOL005_resp.yaml#/components/responses/504 No newline at end of file Loading
src/SOL005/NFVICapacityInformation/NFVICapacityInformation.yaml +1 −215 Original line number Original line Diff line number Diff line Loading @@ -313,15 +313,6 @@ components: $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/CapacityThresholdModifications $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/CapacityThresholdModifications required: true required: true NfviCapacitySubscriptionRequest: description: | Details of the subscription to be created. content: application/json: schema: $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/NfviCapacityInfoSubscriptionRequest required: true CapacityShortageNotificationRequest: CapacityShortageNotificationRequest: description: | description: | Notification about the available NFVI capacity having crossed below a threshold value or having re-covered from Notification about the available NFVI capacity having crossed below a threshold value or having re-covered from Loading Loading @@ -563,138 +554,6 @@ components: type: string type: string content: {} content: {} NfviCiSubscriptions.Get: description: | 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 NFVI capacity information subscriptions, as defined in clause 10.5.2.9. 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 NFVO 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: | Version of the API used in the response. 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: type: array items: $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/NfviCapacityInfoSubscription NfviCiSubscriptions.Post: description: | Shall be returned when the subscription has been created successfully. A representation of the created subscription resource shall be returned in the response body, as defined in clause 10.5.2.9. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created subscription resource. headers: Version: description: | Version of the API used in the response. 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/NFVICapacityInformation_def.yaml#/components/schemas/NfviCapacityInfoSubscription NfviCiSubscription.Get: description: | Shall be returned when the subscription has been read successfully. The response body shall contain a representation of the subscription resource, as defined in clause 10.5.2.9. headers: Version: description: | Version of the API used in the response. 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/NFVICapacityInformation_def.yaml#/components/schemas/NfviCapacityInfoSubscription NfviCiSubscription.Delete: description: | Shall be returned when the subscription resource has been deleted successfully. The response body shall be empty. headers: Version: description: | Version of the API used in the response. 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: {} CapacityShortageNotification.Post: CapacityShortageNotification.Post: description: | description: | Shall be returned when the notification has been delivered successfully. Shall be returned when the notification has been delivered successfully. Loading Loading @@ -749,76 +608,3 @@ components: schema: schema: type: string type: string content: {} content: {} No newline at end of file callbacks: CapacityShortageNotification: '{$request.body#/callbackUri}': description: >- This resource represents a notification endpoint for NFVI capacity information. The API producer can use this resource to send notifications related to log management events to a subscribed API consumer, which has provided the URI of this resource during the capacity threshold creation process. post: description: >- The POST method delivers a notification regarding an NFVI capacity information event from the API producer to an API consumer. The API consumer shall have previously created an "Individual capacity threshold" resource" parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/Version - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization requestBody: $ref: "#/components/requestBodies/CapacityShortageNotificationRequest" responses: "204": $ref: '#/components/responses/CapacityShortageNotification.Post' "400": $ref: ../responses/SOL005_resp.yaml#/components/responses/400 "401": $ref: ../responses/SOL005_resp.yaml#/components/responses/401 "403": $ref: ../responses/SOL005_resp.yaml#/components/responses/403 "404": $ref: ../responses/SOL005_resp.yaml#/components/responses/404 "405": $ref: ../responses/SOL005_resp.yaml#/components/responses/405 "406": $ref: ../responses/SOL005_resp.yaml#/components/responses/406 "422": $ref: ../responses/SOL005_resp.yaml#/components/responses/422 "500": $ref: ../responses/SOL005_resp.yaml#/components/responses/500 "503": $ref: ../responses/SOL005_resp.yaml#/components/responses/503 "504": $ref: ../responses/SOL005_resp.yaml#/components/responses/504 get: description: >- The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, e.g. during creation of the capacity threshold resource. parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/Version - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization responses: "204": $ref: '#/components/responses/CapacityShortageNotification.Get' "400": $ref: ../responses/SOL005_resp.yaml#/components/responses/400 "401": $ref: ../responses/SOL005_resp.yaml#/components/responses/401 "403": $ref: ../responses/SOL005_resp.yaml#/components/responses/403 "404": $ref: ../responses/SOL005_resp.yaml#/components/responses/404 "405": $ref: ../responses/SOL005_resp.yaml#/components/responses/405 "406": $ref: ../responses/SOL005_resp.yaml#/components/responses/406 "422": $ref: ../responses/SOL005_resp.yaml#/components/responses/422 "500": $ref: ../responses/SOL005_resp.yaml#/components/responses/500 "503": $ref: ../responses/SOL005_resp.yaml#/components/responses/503 "504": $ref: ../responses/SOL005_resp.yaml#/components/responses/504 No newline at end of file
