diff --git a/README.md b/README.md index 17953943bd24ef201327397c271ba38e69cfa433..a9a16ace24c6f8d4bb78a177bd6fd7380feee055 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # NFV SOL009 - OpenAPIs for the management of NFV-MANO -This repository contains OpenAPIs for ETSI GS NFV-SOL 009 v3.6.1, RESTful protocols +This repository contains OpenAPIs for ETSI GS NFV-SOL 009 v4.3.1, RESTful protocols specification for the management of NFV-MANO functional entities. **IMPORTANT: In case of discrepancies the published ETSI Group Specification takes precedence.** diff --git a/docker/Dockerfile b/docker/Dockerfile index 9b3d8380bbce4da5163ba8292cbefad5963ab448..b2bc21580d5bfed368756d3b9ca38b3051a135d3 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -12,7 +12,7 @@ RUN apk add asciidoctor RUN apk add openjdk8 RUN apk add ca-certificates wget && update-ca-certificates RUN apk add openssl -RUN gem install rdoc --pre || gem install rdoc --pre +RUN gem install rdoc -v 6.3.3 || gem install rdoc -v 6.3.3 RUN gem install asciidoctor-pdf-cjk RUN wget https://forge.etsi.org/swagger2markup-cli-1.3.2.jar RUN npm config set proxy $http_proxy diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index d40e85a81f08c02d586eba4163de0f6fd128a563..604ba0db2c8435b9fcc32c3c2b3468ae7d628d37 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -19,8 +19,8 @@ info: version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V3.6.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf + description: ETSI GS NFV-SOL 009 V4.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/04.03.01_60/gs_NFV-SOL009v040301p.pdf servers: - url: http://127.0.0.1/nfvmanocim/v2 @@ -43,25 +43,25 @@ paths: "200": $ref: "#/components/responses/ManoEntity.Get.200" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 patch: description: > @@ -80,25 +80,25 @@ paths: "412": $ref: "#/components/responses/ManoEntity.Patch.412" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /mano_entity/change_state: post: @@ -117,25 +117,25 @@ paths: "409": $ref: "#/components/responses/ChangeState.Post.409" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /mano_entity/mano_interfaces: get: @@ -158,23 +158,23 @@ paths: "400": $ref: "#/components/responses/ManoInterfaces.Get.400" "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /mano_entity/mano_interfaces/{manoServiceInterfaceId}: parameters: @@ -192,23 +192,23 @@ paths: "200": $ref: "#/components/responses/IndividualManoInterface.Get.200" "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 patch: description: > This method is used to modify an "Individual NFV-MANO service interface" resource. See clause 5.5.11.3.4. @@ -226,25 +226,25 @@ paths: "412": $ref: "#/components/responses/IndividualManoInterface.Patch.412" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /mano_entity/mano_interfaces/{manoServiceInterfaceId}/change_state: parameters: @@ -265,25 +265,25 @@ paths: "409": $ref: "#/components/responses/ManoInterfaceChangeState.Post.409" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /subscriptions: post: @@ -303,23 +303,23 @@ paths: "422": $ref: "#/components/responses/Subscriptions.Post.422" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 get: description: > The GET method queries the list of active subscriptions of the API consumer that @@ -337,23 +337,23 @@ paths: "400": $ref: "#/components/responses/Subscriptions.Get.400" "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /subscriptions/{subscriptionId}: parameters: @@ -370,25 +370,25 @@ paths: "200": $ref: "#/components/responses/Subscription.Get.200" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 delete: description: > The DELETE method terminates an individual subscription. See clause 5.5.5.3.5. @@ -400,25 +400,25 @@ paths: "204": $ref: "#/components/responses/Subscription.Delete.204" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /change_state_ops: get: @@ -441,23 +441,23 @@ paths: "400": $ref: "#/components/responses/ChangeStateOpOcc.Get.400" "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /change_state_ops/{changeStateOpOccId}: parameters: @@ -475,25 +475,25 @@ paths: "200": $ref: "#/components/responses/IndividualChangeStateOpOcc.Get.200" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /peer_entities: post: @@ -511,25 +511,25 @@ paths: "201": $ref: "#/components/responses/PeerEntities.Post.201" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 get: description: > The GET method queries information and configuration in the producer NFV-MANO functional @@ -550,23 +550,23 @@ paths: "400": $ref: "#/components/responses/PeerEntities.Get.400" "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /peer_entities/{peerEntityId}: parameters: @@ -583,25 +583,25 @@ paths: "200": $ref: "#/components/responses/IndividualPeerEntity.Get.200" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 patch: description: > This method modifies configuration and information of the producer NFV-MANO functional @@ -621,23 +621,23 @@ paths: "412": $ref: "#/components/responses/IndividualPeerEntity.Patch.412" "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 delete: description: > This method deletes an individual peer entity resource. By deleting such a resource in the @@ -656,25 +656,25 @@ paths: "409": $ref: "#/components/responses/IndividualPeerEntity.Delete.409" "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "412": - $ref: ../components/SOL009_resp.yaml#/components/responses/412 + $ref: ../responses/SOL009_resp.yaml#/responses/412 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 components: parameters: @@ -801,7 +801,7 @@ components: Identifier of the MANO service interface. required: true schema: - $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' subscriptionId: name: subscriptionId @@ -810,7 +810,7 @@ components: Identifier of the subscription required: true schema: - $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' changeStateOpOccId: name: changeStateOpOccId @@ -819,7 +819,7 @@ components: Identifier of the change state operation occurrence required: true schema: - $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' peerEntityId: name: peerEntityId @@ -828,7 +828,7 @@ components: Identifier of the peer entity required: true schema: - $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' requestBodies: ModifyManoEntityRequest: @@ -840,7 +840,7 @@ components: content: application/merge-patch+json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/ManoConfigModificationRequest" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/ManoConfigModificationRequest" required: true ChangeManoEntityStateRequest: @@ -849,7 +849,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/ChangeStateRequest" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/ChangeStateRequest" required: true ModifyManoEnityInterfaceRequest: @@ -862,7 +862,7 @@ components: content: application/merge-patch+json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/ManoServiceInterfaceModificationRequest" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/ManoServiceInterfaceModificationRequest" required: true ChangeManoEntityInterfaceStateRequest: @@ -872,7 +872,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/ChangeStateRequest" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/ChangeStateRequest" required: true CimSubscriptionRequest: @@ -882,7 +882,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/CimSubscriptionRequest" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/CimSubscriptionRequest" required: true CreatePeerEntityRequest: @@ -891,7 +891,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/CreatePeerEntityRequest" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/CreatePeerEntityRequest" required: true ModifyPeerEntityRequest: @@ -904,7 +904,7 @@ components: content: application/merge-patch+json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/PeerEntityConfigModificationRequest" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/PeerEntityConfigModificationRequest" required: true responses: @@ -932,7 +932,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/ManoEntity" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/ManoEntity" ManoEntity.Patch.200: description: > @@ -956,7 +956,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/ManoConfigModifications" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/ManoConfigModifications" ManoEntity.Patch.409: description: > 409 CONFLICT @@ -986,7 +986,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" ManoEntity.Patch.412: description: > 412 PRECONDITION FAILED @@ -1015,7 +1015,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" ChangeState.Post.202: description: > @@ -1077,7 +1077,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" ManoInterfaces.Get.200: description: > @@ -1126,7 +1126,7 @@ components: schema: type: array items: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/ManoServiceInterface" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/ManoServiceInterface" ManoInterfaces.Get.400: description: > 400 BAD REQUEST @@ -1159,7 +1159,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" IndividualManoInterface.Get.200: description: > @@ -1186,7 +1186,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/ManoServiceInterface" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/ManoServiceInterface" IndividualManoInterface.Patch.200: description: > 200 OK @@ -1212,7 +1212,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/ManoServiceInterfaceModifications" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/ManoServiceInterfaceModifications" IndividualManoInterface.Patch.409: description: > 409 CONFLICT @@ -1243,7 +1243,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" IndividualManoInterface.Patch.412: description: > 412 PRECONDITION FAILED @@ -1273,7 +1273,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" ManoInterfaceChangeState.Post.202: description: > @@ -1337,7 +1337,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" Subscriptions.Post.201: description: > @@ -1375,7 +1375,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/CimSubscription" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/CimSubscription" Subscriptions.Post.303: description: > 303 SEE OTHER @@ -1445,7 +1445,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" Subscriptions.Get.200: description: > @@ -1493,7 +1493,7 @@ components: schema: type: array items: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/CimSubscription" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/CimSubscription" Subscriptions.Get.400: description: > 400 BAD REQUEST @@ -1523,7 +1523,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" Subscription.Get.200: description: > @@ -1550,7 +1550,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/CimSubscription" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/CimSubscription" Subscription.Delete.204: description: > 204 NO CONTENT @@ -1620,7 +1620,7 @@ components: schema: type: array items: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/ChangeStateOpOcc" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/ChangeStateOpOcc" ChangeStateOpOcc.Get.400: description: > 400 BAD REQUEST @@ -1653,7 +1653,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" IndividualChangeStateOpOcc.Get.200: description: > @@ -1680,7 +1680,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/ChangeStateOpOcc" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/ChangeStateOpOcc" PeerEntities.Post.201: description: > @@ -1719,7 +1719,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/PeerEntity" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/PeerEntity" PeerEntities.Get.200: description: > 200 OK @@ -1767,7 +1767,7 @@ components: schema: type: array items: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/PeerEntity" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/PeerEntity" PeerEntities.Get.400: description: > 400 BAD REQUEST @@ -1800,7 +1800,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" IndividualPeerEntity.Get.200: description: > @@ -1827,7 +1827,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/PeerEntity" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/PeerEntity" IndividualPeerEntity.Patch.200: description: > 200 OK @@ -1853,7 +1853,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoConfigurationAndInformationManagement_def.yaml#/components/schemas/PeerEntityConfigModifications" + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/PeerEntityConfigModifications" IndividualPeerEntity.Patch.409: description: > 409 CONFLICT. @@ -1882,7 +1882,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" IndividualPeerEntity.Patch.412: description: > 412 PRECONDITION FAILED @@ -1911,7 +1911,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" IndividualPeerEntity.Delete.204: description: > 204 NO CONTENT @@ -1961,7 +1961,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" IndividualPeerEntity.Delete.412: description: > 412 PRECONDITION FAILED @@ -1990,6 +1990,6 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" #callbacks: \ No newline at end of file diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/components/NFVManoConfigurationAndInformationManagement_def.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/definitions/NFVManoConfigurationAndInformationManagement_def.yaml similarity index 78% rename from src/SOL009/NFVManoConfigurationAndInformationManagement/components/NFVManoConfigurationAndInformationManagement_def.yaml rename to src/SOL009/NFVManoConfigurationAndInformationManagement/definitions/NFVManoConfigurationAndInformationManagement_def.yaml index 92fcdb26054bc30da687b2b21c85cfee569d270e..467ec108c78a51af5efa008d2fd0a1c78ffd91b2 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/components/NFVManoConfigurationAndInformationManagement_def.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/definitions/NFVManoConfigurationAndInformationManagement_def.yaml @@ -1,4 +1,4 @@ -components: +definitions: schemas: ManoEntity: description: > @@ -10,6 +10,7 @@ components: entity is specified by the manoServices attribute. * NOTE 5: It is optional for the API producer to support the "manoEntityComponents" attribute. * NOTE 6: It shall be present when "type" attribute is "WIM", and it shall be absent in any other case. + * NOTE 7: It shall be present when "type" attribute is "CISM", and it shall be absent in any other case. type: object required: - id @@ -28,11 +29,11 @@ components: the initial deployment of the NFV-MANO functional entity and its value allocated based on network operator policies. The value of this identifier shall be unique at least in the scope of the NFV-MANO deployment. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" type: description: > Type of NFV-MANO functional entity. - $ref: "#/components/schemas/ManoEntityEnumType" + $ref: "#/definitions/schemas/ManoEntityEnumType" name: description: > Human-readable name of the NFV-MANO functional entity. @@ -53,14 +54,21 @@ components: softwareVersion: description: > The version of the software of the NFV-MANO functional entity. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Version" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version" + softwareInfo: + description: > + Additional information about the software used to realize the NFV-MANO + functional entity. For instance, the attribute can provide information + about sourced software and corresponding release(s) used to build the + entity’s software. + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs" manoEntityComponents: description: > The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. See note 5. type: array items: - $ref: "#/components/schemas/ManoEntityComponent" + $ref: "#/definitions/schemas/ManoEntityComponent" minItems: 0 manoServices: description: > @@ -68,14 +76,14 @@ components: functional entity. type: array items: - $ref: "#/components/schemas/ManoService" + $ref: "#/definitions/schemas/ManoService" minItems: 1 manoConfigurableParams: description: > Information and current values of the configurable parameters. This attribute can be modified with the PATCH method. - $ref: "#/components/schemas/ManoConfigurableParams" + $ref: "#/definitions/schemas/ManoConfigurableParams" manoApplicationState: description: > Information and current values of the NFV-MANO functional entity’s application state. @@ -88,31 +96,36 @@ components: operationalState: description: > The operational state of the NFV-MANO functional entity application. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/OperationalStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/OperationalStateEnumType" administrativeState: description: > The administrative state of the NFV-MANO functional entity application. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType" usageState: description: > The usage state of the NFV-MANO functional entity application. - $ref: "#/components/schemas/UsageStateEnumType" + $ref: "#/definitions/schemas/UsageStateEnumType" nfvoSpecificInfo: description: > The information specific to an NFVO entity. See note 1 and not 4. - $ref: "#/components/schemas/NfvoSpecificInfo" + $ref: "#/definitions/schemas/NfvoSpecificInfo" vnfmSpecificInfo: description: > The information specific to a VNFM entity. See note 2 and not 4. - $ref: "#/components/schemas/VnfmSpecificInfo" + $ref: "#/definitions/schemas/VnfmSpecificInfo" vimSpecificInfo: description: > The information specific to an VIM entity. See note 3 and not 4. - $ref: "#/components/schemas/VimSpecificInfo" + $ref: "#/definitions/schemas/VimSpecificInfo" wimSpecificInfo: description: > The information specific to a WIM entity. See notes 4 and note 6. - $ref: "#/components/schemas/WimSpecificInfo" + $ref: "#/definitions/schemas/WimSpecificInfo" + cismSpecificInfo: + description: > + The information specific to a CISM entity, See notes 4 and 7. + $ref: "#/definitions/schemas/CismSpecificInfo" + _links: description: > Links to resources related to this resource. @@ -126,19 +139,31 @@ components: properties: self: description: URI of this resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link" manoServiceInterfaces: description: Link to the "NFV-MANO service interfaces" resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link" peerEntities: description: Link to "Peer entities" resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link" changeState: description: Link to the "Change state" task resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link" changeStateOpOccs: description: Link to the "Change state operation occurrences" resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link" + + CismSpecificInfo: + description: > + This type represents information attributes specific to a CISM entity, and that + can be relevant to more than one NFV-MANO service offered by a CISM entity. It + shall comply with the provisions defined in table 5.6.3.14-1. + NOTE: No attributes are specified in the present document version. The definition of attributes is left for future specification. + type: object + properties: + none: + type: object + ManoConfigModificationRequest: description: > @@ -163,17 +188,17 @@ components: (see IETF RFC 7396). type: object additionalProperties: - $ref: "#/components/schemas/ClockSyncInfo" + $ref: "#/definitions/schemas/ClockSyncInfo" defaultLogCompileBySizeValue: description: > New value of the "defaultLogCompileBySizeValue" attribute in the "ManoEntityConfigurableParams". - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/UnsignedInt" defaultLogCompileByTimerValue: description: > New value of the "defaultLogCompileByTimerValue" attribute in the "ManoEntityConfigurableParams". - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/UnsignedInt" manoServiceModifications: description: > New content of certain entries in the "manoServices" attribute array @@ -201,7 +226,7 @@ components: id: description: > Identifier of the NFV-MANO service to modify. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity" name: description: > New value for the "name" attribute in the "ManoService". See note. @@ -235,19 +260,19 @@ components: "ManoEntityConfigurableParams", as defined in clause 5.6.2.3. type: object additionalProperties: - $ref: "#/components/schemas/ClockSyncInfo" + $ref: "#/definitions/schemas/ClockSyncInfo" defaultLogCompileBySizeValue: description: > If present, this attribute signals modifications of the "defaultLogCompileBySizeValue" attribute in the "ManoEntityConfigurableParams". - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/UnsignedInt" defaultLogCompileByTimerValue: description: > If present, this attribute signals modifications of the "defaultLogCompileByTimerValue" attribute in the "ManoEntityConfigurableParams". - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/UnsignedInt" manoServiceModifications: description: > If present, this attribute signals modifications of the "manoServices" @@ -259,7 +284,7 @@ components: id: description: > Identifier of the NFV-MANO service that has been modified. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity" name: description: > If present, this attribute signals modification of the "name" @@ -286,11 +311,11 @@ components: Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. - $ref: "#/components/schemas/CimNotificationsFilter" + $ref: "#/definitions/schemas/CimNotificationsFilter" callbackUri: description: > The URI of the endpoint to send the notification to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" authentication: description: > Authentication parameters to configure the use of Authorization when @@ -299,7 +324,7 @@ components: This attribute shall only be present if the subscriber requires authorization of notifications. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/SubscriptionAuthentication" CimSubscription: description: > @@ -314,17 +339,17 @@ components: id: description: > Identifier that identifies the subscription - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" filter: description: > Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. - $ref: "#/components/schemas/CimNotificationsFilter" + $ref: "#/definitions/schemas/CimNotificationsFilter" callbackUri: description: > The URI of the endpoint to send the notification to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" _links: description: > Links to resources related to this resource. @@ -333,7 +358,7 @@ components: self: description: > URI of this resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link" required: - self @@ -360,11 +385,11 @@ components: The desired operation state to change the managed object to. In case of changing the state of an NFV-MANO service interface the value "RESTART" shall not be used. - $ref: "#/components/schemas/ChangeOperationalStateEnumType" + $ref: "#/definitions/schemas/ChangeOperationalStateEnumType" stopType: description: > It signals the type of stop. See note 2. - $ref: "#/components/schemas/StopEnumType" + $ref: "#/definitions/schemas/StopEnumType" gracefulStopTimeout: description: > The time internal (in seconds) to wait for the entity to be taken out @@ -384,7 +409,7 @@ components: administrativeStateAction: description: > The desired administrative state to change the managed object to. - $ref: "#/components/schemas/ChangeAdministrativeStateEnumType" + $ref: "#/definitions/schemas/ChangeAdministrativeStateEnumType" ChangeStateOpOcc: description: > @@ -400,37 +425,37 @@ components: id: description: > Identifier of this change state operation occurrence. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" operationState: description: > The state of the "change state operation occurrence". - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/ChangeStateOpOccStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ChangeStateOpOccStateEnumType" stateEnteredTime: description: > Date-time when the current state was entered. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" startTime: description: > Date-time of the start of the operation. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" managedObjectRef: description: > Reference of the managed object to which the change state operation occurrence relates. The value of the "type" attribute shall be "MANO_ENTITY" or "MANO_SERVICE_IF". - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ManoManagedObjectReference" changeOperationalStateRequest: description: > The type of the change of operational state that was requested. Shall be present if the change of state operation triggered a change of operational state. - $ref: "#/components/schemas/ChangeOperationalStateEnumType" + $ref: "#/definitions/schemas/ChangeOperationalStateEnumType" changeAdministrativeStateRequest: description: > The type of the change of administrative state that was requested. Shall be present if the change of state operation triggered a change of administrative state. - $ref: "#/components/schemas/ChangeAdministrativeStateEnumType" + $ref: "#/definitions/schemas/ChangeAdministrativeStateEnumType" operationParams: description: > Input parameters of the change state operation. This attribute shall be @@ -477,7 +502,7 @@ components: id: description: > Identifier of the NFV-MANO functional entity interface. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity" name: description: > Human-readable name of the NFV-MANO functional entity interface. @@ -492,16 +517,16 @@ components: standardVersion: description: > Version of the standard the interface is compliant to. See note 1. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Version" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version" providerSpecificApiVersion: description: > Provider-specific software API version. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Version" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version" apiVersion: description: > API version, in compliance with the version identifiers and parameters format specified in clause 9.1 of ETSI GS NFV-SOL 013. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Version" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version" apiEndpoint: description: > Exposed API endpoint of the interface. @@ -515,7 +540,7 @@ components: (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. This attribute can be modified with the PATCH method. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" apiName: description: > Indicates the interface name in an abbreviated form. Shall be present @@ -540,7 +565,7 @@ components: APIs specified by ETSI NFV, this attribute shall not be modified. Instead, changes are handled indirectly via patching of the "apiRoot" attribute’s value. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" required: - apiUri maxConcurrentIntOpNumber: @@ -572,15 +597,15 @@ components: operationalState: description: > The operational state of the NFV-MANO service interface. - $ref: "#/components/schemas/InterfaceOperationalStateEnumType" + $ref: "#/definitions/schemas/InterfaceOperationalStateEnumType" administrativeState: description: > The administrative state of the NFV-MANO service interface. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType" usageState: description: > The usage state of the NFV-MANO service interface. - $ref: "#/components/schemas/UsageStateEnumType" + $ref: "#/definitions/schemas/UsageStateEnumType" required: - operationalState - administrativeState @@ -590,14 +615,14 @@ components: Security related information. This attribute can be modified with the PATCH method. See note 3. - $ref: "#/components/schemas/ServerInterfaceSecurityInfo" + $ref: "#/definitions/schemas/ServerInterfaceSecurityInfo" metadata: description: > Additional attributes that provide metadata describing the NFV-MANO service interface. These attributes can be created, modified or removed with the PATCH method. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs" ManoServiceInterfaceModificationRequest: description: > @@ -621,23 +646,23 @@ components: apiRoot: description: > New value of the "apiRoot" attribute in "ManoServiceInterface". See note 2. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" apiUri: description: > New value of the "apiUri" attribute in "ManoServiceInterface". See note 2. Shall not be provided if a change of "apiRoot" is present in the request. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" securityInfo: description: > New value of the "securityInfo" attribute in "ManoServiceInterface". See note 3. - $ref: "#/components/schemas/ServerInterfaceSecurityInfo" + $ref: "#/definitions/schemas/ServerInterfaceSecurityInfo" metadata: description: > Modifications of the "metadata" attribute in "ManoServiceInterface". If present, these modifications shall be applied according to the rules of JSON Merge PATCH (see IETF RFC 7396). - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs" ManoServiceInterfaceModifications: description: > @@ -663,22 +688,22 @@ components: description: > If present, this attribute signals modifications of the "apiRoot" attribute in "ManoServiceInterface", as defined in clause 5.6.2.11. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" apiUri: description: > If present, this attribute signals modifications of the "apiUri" attribute in "ManoServiceInterface", as defined in clause 5.6.2.11. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" securityInfo: description: > If present, this attribute signals modifications of the "securityInfo" attribute in "ManoServiceInterface", as defined in clause 5.6.2.11. See note. - $ref: "#/components/schemas/ServerInterfaceSecurityInfo" + $ref: "#/definitions/schemas/ServerInterfaceSecurityInfo" metadata: description: > If present, this attribute signals modifications of the "metadata" attribute in "ManoServiceInterface", as defined in clause 5.6.2.11. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs" CreatePeerEntityRequest: description: > @@ -695,7 +720,7 @@ components: peerEntityId: description: > Identifier of the peer functional entity. See note. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" name: description: > Human-readable name of the peer functional entity. @@ -703,7 +728,7 @@ components: type: description: > Type of the peer functional entity. - $ref: "#/components/schemas/PeerEntityEnumType" + $ref: "#/definitions/schemas/PeerEntityEnumType" description: description: > Human-readable description of the peer functional entity. @@ -714,7 +739,7 @@ components: from the peer functional entity. type: object additionalProperties: - $ref: "#/components/schemas/ConsumedManoInterfaceInfo" + $ref: "#/definitions/schemas/ConsumedManoInterfaceInfo" peerEntityState: description: > Current values of the state of the peer functional entity. @@ -723,11 +748,11 @@ components: operationalState: description: > TThe operation state of the peer functional entity’s application. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/OperationalStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/OperationalStateEnumType" administrativeState: description: > The administrative state of the peer functional entity’s application. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType" required: - operationalState - administrativeState @@ -752,11 +777,11 @@ components: description: > Identifier of the resource representing the peer functional entity. This identifier is allocated by the producer NFV-MANO functional entity. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" peerEntityId: description: > Identifier of the peer functional entity. See note 1. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" name: description: > Human-readable name of the peer functional entity. @@ -766,7 +791,7 @@ components: type: description: > Type of the peer functional entity. - $ref: "#/components/schemas/PeerEntityEnumType" + $ref: "#/definitions/schemas/PeerEntityEnumType" description: description: > Human-readable description of the peer functional entity. @@ -785,7 +810,7 @@ components: from other data structures via the "consumedManoInterfaceIds" attribute. type: object additionalProperties: - $ref: "#/components/schemas/ConsumedManoInterfaceInfo" + $ref: "#/definitions/schemas/ConsumedManoInterfaceInfo" peerEntityState: description: > State of the peer functional entity as provided by the API consumer when @@ -795,11 +820,11 @@ components: operationalState: description: > The operational state of the peer functional entity’s application. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/OperationalStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/OperationalStateEnumType" administrativeState: description: The administrative state of the peer functional entity’s application. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType" required: - operationalState - administrativeState @@ -833,17 +858,17 @@ components: JSON Merge PATCH (see IETF RFC 7396). See note. type: object additionalProperties: - $ref: "#/components/schemas/ConsumedManoInterfaceInfo" + $ref: "#/definitions/schemas/ConsumedManoInterfaceInfo" operationalState: description: > New content of the "operationalState" attribute in the "peerEntityState" structure in the "PeerEntity". - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/OperationalStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/OperationalStateEnumType" administrativeState: description: > New content of the "administrativeState" attribute in the "peerEntityState" structure in the "PeerEntity". - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType" PeerEntityConfigModifications: description: > @@ -877,19 +902,19 @@ components: clause 5.6.2.15. See note. type: object additionalProperties: - $ref: "#/components/schemas/ConsumedManoInterfaceInfo" + $ref: "#/definitions/schemas/ConsumedManoInterfaceInfo" operationalState: description: > If present, this attribute signals modifications of the "operationalState" attribute in the "peerEntityState" structure in the "PeerEntity", as defined in clause 5.6.2.15. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/OperationalStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/OperationalStateEnumType" administrativeState: description: > If present, this attribute signals modifications of the "administrativeState" attribute in the "peerEntityState" structure in the "PeerEntity", as defined in clause 5.6.2.15. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType" ManoConfigurableParams: description: > @@ -909,7 +934,7 @@ components: id: description: > Identifier of the NFV-MANO functional entity component. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity" manoServiceIds: description: > References to the NFV-MANO services that depend on the NFV-MANO functional @@ -918,7 +943,7 @@ components: component. type: array items: - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity" ManoService: description: > @@ -937,7 +962,7 @@ components: id: description: > Identifier of the NFV-MANO service. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity" name: description: > Human-readable name of the NFV-MANO service. @@ -958,7 +983,7 @@ components: ManoServiceInterface is referred. See note type: array items: - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity" minItems: 1 _links: description: > @@ -971,7 +996,7 @@ components: information about the associated interfaces to the NFV-MANO service. type: array items: - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link" minItems: 1 required: - manoServiceInterfaces @@ -1017,7 +1042,7 @@ components: standardVersion: description: > Name and version of the standard the VNFD is compliant to. See note 1. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Version" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version" required: - vnfdFormat - standardVersion @@ -1042,7 +1067,7 @@ components: standardVersion: description: > Name and version of the standard the NSD is compliant to. See note 1. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Version" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version" required: - nsdFormat - standardVersion @@ -1104,7 +1129,7 @@ components: standardVersion: description: > Name and version of the standard the VNFD is compliant to. See note - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Version" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version" required: - vnfdFormat - standardVersion @@ -1135,7 +1160,7 @@ components: List of supported image container formats. Container format indicates whether a software image is in a file that also contains metadata about the actual software. Valid values are all values for "container_format" as defined in ETSI GS NFV-SOL 001 - [i.16] and all values for "container-format" as defined in ETSI GS NFV-SOL 006 [i.17]. + [16] and all values for "container-format" as defined in ETSI GS NFV-SOL 006 [i.17]. type: array items: type: string @@ -1162,7 +1187,7 @@ components: determines the name of the capability, and the "value" shall indicate whether or not the capability is enabled. Examples of capabilities can include performing a validation of the image’s signing certificate during the image signature verification. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs" signatureVerificationAlgorithms: description: > List of algorithms for verifying the signature of software images that are supported by the VIM. @@ -1187,7 +1212,7 @@ components: additionalAlgParams: description: > Additional parameters specific to the signature verification algorithm. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs" imageDigestAlgorithms: description: > List of supported digest algorithms that can be used for digital signatures. @@ -1237,7 +1262,7 @@ components: Reference criteria for derivation/computation of the referred maximum number of MSCS in attribute "numMscs". Shall be provided if specific criteria has been taken into account for deriving the referred number. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs" maxMsncNum: description: > Maximum number of MSNC that the WIM can manage @@ -1253,7 +1278,7 @@ components: description: > Reference criteria for derivation/computation of the referred maximum number of MSNC in attribute "numMsnc". - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs" mscsLayerProtocolSupport: description: > List of protocols of particular layers used to realize an MSCS @@ -1296,16 +1321,16 @@ components: structure, are managed by the API consumer. type: object additionalProperties: - $ref: "#/components/schemas/ClockSyncInfo" + $ref: "#/definitions/schemas/ClockSyncInfo" minItems: 1 defaultLogCompileBySizeValue: description: Default value for the log compilation by size to be used. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/UnsignedInt" defaultLogCompileByTimerValue: description: Default value for the log compilation by timer to be used. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/UnsignedInt" ConsumedManoInterfaceInfo: description: > @@ -1341,12 +1366,12 @@ components: standardVersion: description: > Version of the standard the interface is compliant to. See note 1. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Version" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version" apiVersion: description: > API version, in compliance with the version identifiers and parameters format specified in clause 9.1 of ETSI GS NFV-SOL 013. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Version" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version" apiEndpoint: description: > Consumable API endpoint of the interface. @@ -1361,7 +1386,7 @@ components: represent a prefix path. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" apiName: description: > Indicates the interface name in an abbreviated form. Shall be present @@ -1381,14 +1406,14 @@ components: URL of the API endpoint. For ETSI NFV specified RESTful NFV-MANO APIs, the following prefix structure is used (see also clause 4.1 of ETSI GS NFV-SOL 013): {apiRoot}/{apiName}/{apiMajorVersion} - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" required: - apiUri securityInfo: description: > Security related information including credentials information if needed for consuming the API. See note 2. - $ref: "#/components/schemas/ClientInterfaceSecurityInfo" + $ref: "#/definitions/schemas/ClientInterfaceSecurityInfo" CimNotificationsFilter: description: > @@ -1402,7 +1427,7 @@ components: description: > Filter criteria to select the NFV-MANO functional entity and its associated managed objects. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/ManoEntitySubscriptionFilter" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ManoEntitySubscriptionFilter" notificationTypes: description: > Match particular notification types. @@ -1446,7 +1471,7 @@ components: ipAddress: description: > IP address of the NTP server. See note - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IpAddress" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IpAddress" hostname: description: > Indicates the hostname of the NTP server. See note. @@ -1455,7 +1480,7 @@ components: description: > Information for the other types of clock synchronization. May be present if type = "OTHER". - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs" ServerInterfaceSecurityInfo: description: > @@ -1507,7 +1532,7 @@ components: Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" providedConfiguration: description: > Configuration data used to setup the authorization server identifier. See note. @@ -1518,7 +1543,7 @@ components: authServerId: description: > Authorization server identifier as defined in ETSI GS NFV-SEC 022. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" tlsCipherSuites: description: > List of cipher suites that shall be declared as supported by the @@ -1645,6 +1670,71 @@ components: NOTE: The table is expected to be updated, by removing the corresponding listed entries, once the interfaces are specified as a RESTful NFV-MANO API. + + Acronym string value Description + "sim" Represents the "Software Image Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vcrm" Represents the "Virtualised Compute Resources Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vcrim" Represents the "Virtualised Compute Resources Information Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vcrcam" Represents the "Virtualised Compute Resources Capacity Management" interface produced by a VIM (refer to IFA005). + "vcrcn" Represents the "Virtualised Compute Resources Change Notification" interface produced by a VIM (refer to IFA005 and IFA006). + "vcfm" Represents the "Virtualised Compute Flavour Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vnrm" Represents the "Virtualised Network Resources Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vnrim" Represents the "Virtualised Network Resources Information Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vnrcam" Represents the "Virtualised Network Resources Capacity Management" interface produced by a VIM (refer to IFA005). + "vnrcn" Represents the "Virtualised Network Resources Change Notification" interface produced by a VIM (refer to IFA005 and IFA006). + "nfpm" Represents the "Network Forwarding Path Management" interface produced by a VIM (refer to IFA005). + "vsrm" Represents the "Virtualised Storage Resources Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vsrim" Represents the "Virtualised Storage Resources Information Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vsrcam" Represents the "Virtualised Storage Resources Capacity Management" interface produced by a VIM (refer to IFA005). + "vsrcn" Represents the "Virtualised Storage Resources Change Notification" interface produced by a VIM (refer to IFA005 and IFA006). + "vrpm" Represents the "Virtualised Resources Performance Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vrfm" Represents the "Virtualised Resources Fault Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vcrmm" Represents the "Virtualised Compute Resources Reservation Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vnrmm" Represents the "Virtualised Network Resources Reservation Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vsrmm" Represents the "Virtualised Storage Resources Reservation Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vrrcn" Represents the "Virtualised Resources Reservation Change Notification" interface produced by a VIM (refer to IFA005 and IFA006). + "vcrqm" Represents the "Virtualised Compute Resources Quota Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vnrqm" Represents the "Virtualised Network Resources Quota Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vsrqm" Represents the "Virtualised Storage Resources Quota Management" interface produced by a VIM (refer to IFA005 and IFA006). + "vrqcn" Represents the "Virtualised Resources Quota Change Notification" interface produced by a VIM (refer to IFA005 and IFA006). + "chrm" Represents the "Compute Host Reservation Management" interface produced by a VIM (refer to IFA005). + "chcam" Represents the "Compute Host Capacity Management" interface produced by a VIM (refer to IFA005). + "vnfspkgm" Represents the "VNF Snapshot Package Management" interface produced by a VNFM (refer to IFA007 and IFA013). This value is deprecated and it can be removed in subsequent versions of the present document. ETSI GS NFV SOL 005 [11] has specified to use the string "vnfsnapshotpkgm" as "apiName". + "vcrm_ind" Represents the indirect "Virtualised Compute Resources Management" interface produced by an NFVO (refer to IFA007). + "vcrim_ind" Represents the indirect "Virtualised Compute Resources Information Management" interface produced by an NFVO (refer to IFA007). + "vcrcn_ind" Represents the indirect "Virtualised Compute Resources Change Notification" interface produced by an NFVO (refer to IFA007). + "vsrm_ind" Represents the indirect "Virtualised Storage Resources Management" interface produced by an NFVO (refer to IFA007). + "vsrim_ind" Represents the indirect "Virtualised Storage Resources Information Management" interface produced by an NFVO (refer to IFA007). + "vsrcn_ind" Represents the indirect "Virtualised Storage Resources Change Notification" interface produced by an NFVO (refer to IFA007). + "vnrm_ind" Represents the indirect "Virtualised Network Resources Management" interface produced by an NFVO (refer to IFA007). + "vnrim_ind" Represents the indirect "Virtualised Network Resources Information Management" interface produced by an NFVO (refer to IFA007). + "vnrcn_ind" Represents the indirect "Virtualised Network Resources Change Notification" interface produced by an NFVO (refer to IFA007). + "vcrrm_ind" Represents the indirect "Virtualised Compute Resources Reservation Management" interface produced by an NFVO (refer to IFA007). + "vsrrm_ind" Represents the indirect "Virtualised Storage Resources Reservation Management" interface produced by an NFVO (refer to IFA007). + "vnrrm_ind" Represents the indirect "Virtualised Network Resources Reservation Management" interface produced by an NFVO (refer to IFA007). + "vrrcn_ind" Represents the indirect "Virtualised Resources Reservation Change Notification" interface produced by an NFVO (refer to IFA007). + "vrpm_ind" Represents the indirect "Virtualised Resources Performance Management" interface produced by an NFVO (refer to IFA007). + "vrfm_ind" Represents the indirect "Virtualised Resources Fault Management" interface produced by an NFVO (refer to IFA007). + "vcrqm_ind" Represents the indirect "Virtualised Resources Compute Quota Management" interface produced by an NFVO (refer to IFA007). + "vsrqm_ind" Represents the indirect "Virtualised Storage Resources Quota Management" interface produced by an NFVO (refer to IFA007). + "vnrqm_ind" Represents the indirect "Virtualised Network Resources Quota Management" interface produced by an NFVO (refer to IFA007). + "vrqcn_ind" Represents the indirect "Virtualised Resources Quota Change Notification" interface produced by an NFVO (refer to IFA007). + "lcmcoord" Represents the "LCM Coordination" interface produced by an EM and OSS (refer to IFA008 and IFA013). + "mscsm" Represents the "MSCS Management" interface produced by a WIM (refer to IFA032). + "mscscapm" Represents the "(MSCS) Capacity Management" interface produced by a WIM (refer to IFA032). + "mscsfm" Represents the "(MSCS) Fault Management" interface produced by a WIM (refer to IFA032). + "mscspm" Represents the "(MSCS) Performance Management" interface produced by a WIM (refer to IFA032). + "cismwkldm" Represents the "OS container workload management" service interface produced by a CISM (refer to IFA040). + "cismcompm" Represents the "OS container compute management" service interface produced by a CISM (refer to IFA040). + "cismstrgm" Represents the "OS container storage management" service interface produced by a CISM (refer to IFA040). + "cismnetwm" Represents the "OS container network management" service interface produced by a CISM (refer to IFA040). + "cismcfgm" Represents the "OS container configuration management" service interface produced by a CISM (refer to IFA040). + + NOTE: "IFA005", "IFA006", "IFA007", "IFA008", "IFA013", "IFA032", "IFA040" are used as a shorthand for the + specifications ETSI GS NFV-IFA 005 [i.5], ETSI GS NFV-IFA 006 [i.6], ETSI GS NFV-IFA 007 [i.7], + ETSI GS NFV IFA 008 [i.8], ETSI GS NFV-IFA 013 [i.9], ETSI GS NFV-IFA 032 [i.18] and + ETSI GS NFV-IFA 040 [i.27], respectively. + type: string UsageStateEnumType: @@ -1721,12 +1811,14 @@ components: - VNFM The NFV-MANO functional entity is a VNFM. - VIM The NFV-MANO functional entity is a VIM. - WIM The NFV-MANO functional entity is a WIM. + - CISM The NFV-MANO functional entity is a CISM. type: string enum: - NFVO - VNFM - VIM - WIM + - CISM PeerEntityEnumType: description: > @@ -1737,6 +1829,7 @@ components: - VNFM The peer functional entity is a VNFM. - VIM The peer functional entity is a VIM. - WIM The peer functional entity is a WIM. + - CISM The peer functional entity is a CISM. - EM The peer functional entity is an EM. - OSS The peer functional entity is an OSS/BSS. type: string @@ -1745,6 +1838,7 @@ components: - VNFM - VIM - WIM + - CISM - EM - OSS diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml index 6122cd72d0faba1a240f1b97070ae7ed35ee1d1b..cb9c62b972f5e53a9908bc87f384b7bf5bfaf3ff 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml @@ -19,8 +19,8 @@ info: version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V3.6.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf + description: ETSI GS NFV-SOL 009 V4.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/04.03.01_60/gs_NFV-SOL009v040301p.pdf servers: - url: http://127.0.0.1/callback/v2 @@ -48,25 +48,25 @@ paths: "204": $ref: "#/components/responses/Notification.Post.204" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 get: description: > @@ -80,25 +80,25 @@ paths: "204": $ref: "#/components/responses/Notification.Get.204" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 components: responses: @@ -153,6 +153,6 @@ components: application/json: schema: oneOf: - - $ref: "./components/NFVManoConfigurationAndInformationManagementNotification_def.yaml#/components/schemas/InformationChangedNotification" - - $ref: "./components/NFVManoConfigurationAndInformationManagementNotification_def.yaml#/components/schemas/ChangeStateNotification" + - $ref: "./definitions/NFVManoConfigurationAndInformationManagementNotification_def.yaml#/definitions/schemas/InformationChangedNotification" + - $ref: "./definitions/NFVManoConfigurationAndInformationManagementNotification_def.yaml#/definitions/schemas/ChangeStateNotification" required: true \ No newline at end of file diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/components/NFVManoConfigurationAndInformationManagementNotification_def.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/definitions/NFVManoConfigurationAndInformationManagementNotification_def.yaml similarity index 72% rename from src/SOL009/NFVManoConfigurationAndInformationManagementNotification/components/NFVManoConfigurationAndInformationManagementNotification_def.yaml rename to src/SOL009/NFVManoConfigurationAndInformationManagementNotification/definitions/NFVManoConfigurationAndInformationManagementNotification_def.yaml index 584fac92c7ed6340783e99c1630d13a0c6909030..7418582a016c43dd4f68f179739e4564d20fa23a 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/components/NFVManoConfigurationAndInformationManagementNotification_def.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/definitions/NFVManoConfigurationAndInformationManagementNotification_def.yaml @@ -1,4 +1,4 @@ -components: +definitions: schemas: InformationChangedNotification: description: > @@ -21,7 +21,7 @@ components: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to @@ -30,24 +30,24 @@ components: subscriptionId: description: > Identifier of the subscription that this notification relates to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" timeStamp: description: > Date and time of the generation of the notification. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" informationChangedTime: description: > Timestamp indicating when the information was changed. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" manoEntityId: description: > Identifier of the MANO entity of which the information was changed. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" changedInfo: description: > Data about the changed configuration and information of the NFV-MANO functional entity. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs" _links: description: > Links to resources related to this notification. @@ -56,11 +56,11 @@ components: self: description: > Link to the related subscription. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" subscription: description: > Link to the related subscription. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" required: - self @@ -84,7 +84,7 @@ components: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to @@ -93,39 +93,39 @@ components: subscriptionId: description: > Identifier of the subscription that this notification relates to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" timestamp: description: > Date-time of the generation of the notification. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" changeStateOpOccId: description: > Identifier of the change state operation occurrence associated to the notification. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" stateChangedTime: description: > Timestamp indicating when the state on the managed object was changed. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" changeStateOperationState: description: > The state of the "change state operation occurrence". - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/ChangeStateOpOccStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ChangeStateOpOccStateEnumType" managedObjectRef: description: > Reference of the managed object to which the state change notification relates. The value of the "type" attribute shall be "MANO_ENTITY" or "MANO_SERVICE_IF". - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ManoManagedObjectReference" operationalState: description: > New operational state of the managed object. Shall only be present when there is a change in the operational state. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/OperationalStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/OperationalStateEnumType" administrativeState: description: > New administrative state of the managed object. Shall only be present when there is a change in the administrative state. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType" _links: description: > Links to resources related to this notification. @@ -134,18 +134,18 @@ components: subscription: description: > Link to the related subscription. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" objectInstance: description: > Link to the resource representing the object to which the change state applies. Shall be present if the object instance is accessible as a resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" changeStateOpOcc: description: > Link to the change state operation occurrence that this notification is related to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" required: - subscription - objectInstance diff --git a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml index 7f3ffd0b467f3f16cfabc03a25990f7869e04019..c09bff389733d2119fdb18acd46f792b8bb72030 100644 --- a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml +++ b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml @@ -19,8 +19,8 @@ info: version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V3.6.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf + description: ETSI GS NFV-SOL 009 V4.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/04.03.01_60/gs_NFV-SOL009v040301p.pdf servers: - url: http://127.0.0.1/nfvmanofm/v1 @@ -44,25 +44,25 @@ paths: "200": $ref: '#/components/responses/Alarms.Get.200' "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 "/alarms/{alarmId}": parameters: - $ref: "#/components/parameters/alarmId" @@ -77,25 +77,25 @@ paths: "200": $ref: '#/components/responses/Alarm.Get.200' "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 patch: description: > This method modifies an "Individual alarm" resource. See clause 7.5.4.3.4. @@ -110,29 +110,29 @@ paths: "200": $ref: '#/components/responses/Alarm.Patch.200' "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "409": - $ref: ../components/SOL009_resp.yaml#/components/responses/409 + $ref: ../responses/SOL009_resp.yaml#/responses/409 "412": - $ref: ../components/SOL009_resp.yaml#/components/responses/412 + $ref: ../responses/SOL009_resp.yaml#/responses/412 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /subscriptions: post: description: > @@ -148,27 +148,27 @@ paths: "201": $ref: '#/components/responses/Subscriptions.Post.201' "303": - $ref: ../components/SOL009_resp.yaml#/components/responses/303 + $ref: ../responses/SOL009_resp.yaml#/responses/303 "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 get: description: > The client can use this method to retrieve the list of active subscriptions for NFV-MANO functional entity @@ -184,25 +184,25 @@ paths: "200": $ref: '#/components/responses/Subscriptions.Get.200' "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 "/subscriptions/{subscriptionId}": parameters: - $ref: "#/components/parameters/subscriptionId" @@ -218,25 +218,25 @@ paths: "200": $ref: '#/components/responses/Subscription.Get.200' "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 delete: description: > This method terminates an individual subscription. See clause 7.5.6.3.5. @@ -247,25 +247,25 @@ paths: "204": $ref: '#/components/responses/Subscription.Delete.204' "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 components: parameters: @@ -332,7 +332,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoFaultManagement_def.yaml#/components/schemas/AlarmModifications" + $ref: "./definitions/NFVManoFaultManagement_def.yaml#/definitions/schemas/AlarmModifications" required: true FmSubscriptionRequest: @@ -342,7 +342,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoFaultManagement_def.yaml#/components/schemas/FmSubscriptionRequest" + $ref: "./definitions/NFVManoFaultManagement_def.yaml#/definitions/schemas/FmSubscriptionRequest" required: true responses: @@ -386,7 +386,7 @@ components: schema: type: array items: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/Alarm" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/Alarm" Alarm.Get.200: description: > @@ -406,7 +406,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/Alarm" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/Alarm" Alarm.Patch.200: description: > @@ -435,7 +435,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoFaultManagement_def.yaml#/components/schemas/AlarmModifications" + $ref: "./definitions/NFVManoFaultManagement_def.yaml#/definitions/schemas/AlarmModifications" Subscriptions.Post.201: description: > @@ -473,7 +473,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoFaultManagement_def.yaml#/components/schemas/FmSubscription" + $ref: "./definitions/NFVManoFaultManagement_def.yaml#/definitions/schemas/FmSubscription" Subscriptions.Post.303: description: > 303 SEE OTHER @@ -543,7 +543,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" Subscriptions.Get.200: description: > @@ -595,7 +595,7 @@ components: schema: type: array items: - $ref: "./components/NFVManoFaultManagement_def.yaml#/components/schemas/FmSubscription" + $ref: "./definitions/NFVManoFaultManagement_def.yaml#/definitions/schemas/FmSubscription" Subscription.Get.200: description: > @@ -631,7 +631,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoFaultManagement_def.yaml#/components/schemas/FmSubscription" + $ref: "./definitions/NFVManoFaultManagement_def.yaml#/definitions/schemas/FmSubscription" Subscription.Delete.204: description: > diff --git a/src/SOL009/NFVManoFaultManagement/components/NFVManoFaultManagement_def.yaml b/src/SOL009/NFVManoFaultManagement/definitions/NFVManoFaultManagement_def.yaml similarity index 85% rename from src/SOL009/NFVManoFaultManagement/components/NFVManoFaultManagement_def.yaml rename to src/SOL009/NFVManoFaultManagement/definitions/NFVManoFaultManagement_def.yaml index c823092bb498467cdc7c8aed669571a024a2efc8..d6fad862ff1dfe642efb0cb72423dce0e64b2f2b 100644 --- a/src/SOL009/NFVManoFaultManagement/components/NFVManoFaultManagement_def.yaml +++ b/src/SOL009/NFVManoFaultManagement/definitions/NFVManoFaultManagement_def.yaml @@ -1,4 +1,4 @@ -components: +definitions: schemas: FmSubscriptionRequest: description: > @@ -14,17 +14,17 @@ components: notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. - $ref: "#/components/schemas/FmNotificationsFilter" + $ref: "#/definitions/schemas/FmNotificationsFilter" callbackUri: description: > The URI of the endpoint to send the notification to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" authentication: description: > Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013. This attribute shall only be present if the subscriber requires authorization of notifications. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/SubscriptionAuthentication" FmSubscription: description: > @@ -39,18 +39,18 @@ components: id: description: > Identifier of this "Individual subscription" resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" filter: description: > Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. - $ref: "#/components/schemas/FmNotificationsFilter" + $ref: "#/definitions/schemas/FmNotificationsFilter" callbackUri: description: > The URI of the endpoint to send the notification to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" _links: description: > Links for this resource. @@ -61,7 +61,7 @@ components: self: description: > URI of this resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link" AlarmModifications: description: > @@ -114,13 +114,13 @@ components: Match VNF alarms with a perceived severity listed in this attribute. type: array items: - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/PerceivedSeverityType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/PerceivedSeverityType" eventTypes: description: > Match VNF alarms with an event type listed in this attribute. type: array items: - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/EventType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/EventType" probableCauses: description: > Match VNF alarms with a probable cause listed in this attribute. diff --git a/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml b/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml index c648987523144286023c18ca1c5b8f3193a7a0f5..ca89483d0d76bad16e2cc21f17343342328f333b 100644 --- a/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml +++ b/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml @@ -19,8 +19,8 @@ info: version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V3.6.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf + description: ETSI GS NFV-SOL 009 V4.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/04.03.01_60/gs_NFV-SOL009v040301p.pdf servers: - url: http://127.0.0.1/callback/v1 @@ -43,19 +43,19 @@ paths: "204": $ref: "#/components/responses/AlarmNotification.Post.204" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 get: description: > The GET method allows the server to test the notification endpoint that @@ -67,19 +67,19 @@ paths: "204": $ref: "#/components/responses/AlarmNotification.Get.204" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification: post: description: > @@ -96,19 +96,19 @@ paths: "204": $ref: "#/components/responses/AlarmClearedNotification.Post.204" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 get: description: > The GET method allows the server to test the notification endpoint that @@ -120,19 +120,19 @@ paths: "204": $ref: "#/components/responses/AlarmClearedNotification.Get.204" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification: post: description: > @@ -149,19 +149,19 @@ paths: "204": $ref: "#/components/responses/AlarmListRebuiltNotification.Post.204" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 get: description: > The GET method allows the server to test the notification endpoint that @@ -173,19 +173,19 @@ paths: "204": $ref: "#/components/responses/AlarmListRebuiltNotification.Get.204" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 components: requestBodies: @@ -195,7 +195,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoFaultManagementNotification_def.yaml#/components/schemas/AlarmNotification" + $ref: "./definitions/NFVManoFaultManagementNotification_def.yaml#/definitions/schemas/AlarmNotification" required: true AlarmClearedNotification: @@ -204,7 +204,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoFaultManagementNotification_def.yaml#/components/schemas/AlarmClearedNotification" + $ref: "./definitions/NFVManoFaultManagementNotification_def.yaml#/definitions/schemas/AlarmClearedNotification" required: true AlarmListRebuiltNotification: @@ -214,7 +214,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoFaultManagementNotification_def.yaml#/components/schemas/AlarmListRebuiltNotification" + $ref: "./definitions/NFVManoFaultManagementNotification_def.yaml#/definitions/schemas/AlarmListRebuiltNotification" required: true responses: diff --git a/src/SOL009/NFVManoFaultManagementNotification/components/NFVManoFaultManagementNotification_def.yaml b/src/SOL009/NFVManoFaultManagementNotification/definitions/NFVManoFaultManagementNotification_def.yaml similarity index 78% rename from src/SOL009/NFVManoFaultManagementNotification/components/NFVManoFaultManagementNotification_def.yaml rename to src/SOL009/NFVManoFaultManagementNotification/definitions/NFVManoFaultManagementNotification_def.yaml index 087eb3e9191499e536ad07388d1163a846c61087..cb680f62b1185a8e6fe7f61179102cb6c989e8e4 100644 --- a/src/SOL009/NFVManoFaultManagementNotification/components/NFVManoFaultManagementNotification_def.yaml +++ b/src/SOL009/NFVManoFaultManagementNotification/definitions/NFVManoFaultManagementNotification_def.yaml @@ -1,4 +1,4 @@ -components: +definitions: schemas: AlarmNotification: description: > @@ -22,7 +22,7 @@ components: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to @@ -33,16 +33,16 @@ components: subscriptionId: description: > Identifier of the subscription that this notification relates to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" timeStamp: description: > Date-time of the generation of the notification. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" alarm: description: > Information about an alarm including AlarmId, affected VNF identifier, and FaultDetails. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Alarm" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Alarm" _links: description: > Links to resources related to this notification. @@ -53,7 +53,7 @@ components: subscription: description: > Link to the related subscription. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" AlarmClearedNotification: description: > @@ -75,7 +75,7 @@ components: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to @@ -86,15 +86,15 @@ components: subscriptionId: description: > Identifier of the subscription that this notification relates to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" timeStamp: description: > Date-time of the generation of the notification. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" alarmId: description: > Alarm identifier. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" alarmClearedTime: description: > The time stamp indicating when the alarm was cleared. @@ -109,11 +109,11 @@ components: subscription: description: > Link to the related subscription. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" alarm: description: > Link to the resource that represents the related alarm. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" AlarmListRebuiltNotification: description: > @@ -135,7 +135,7 @@ components: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to @@ -146,11 +146,11 @@ components: subscriptionId: description: > Identifier of the subscription that this notification relates to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" timeStamp: description: > Date-time of the generation of the notification. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" _links: description: > Links to resources related to this notification. @@ -162,8 +162,8 @@ components: subscription: description: > Link to the related subscription. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" alarms: description: > Link to the alarm list, i.e. the "Alarms" resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" diff --git a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml index 1f8dd77ed960027908b1a78240d486f66693656d..0bea4125c3a88bac4c3e492e1a943b69719f0dd3 100644 --- a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml +++ b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml @@ -19,8 +19,8 @@ info: version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V3.6.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf + description: ETSI GS NFV-SOL 009 V4.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/04.03.01_60/gs_NFV-SOL009v040301p.pdf servers: - url: http://127.0.0.1/nfvmanologm/v1 @@ -47,25 +47,25 @@ paths: "201": $ref: '#/components/responses/LoggingJobs.Post.201' "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 get: description: >- The API consumer can use this method to retrieve information about logging jobs. See clause 8.5.3.3.2. @@ -83,25 +83,25 @@ paths: "200": $ref: '#/components/responses/LoggingJobs.Get.200' "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 "/log_jobs/{logJobId}": description: >- @@ -121,25 +121,25 @@ paths: "200": $ref: '#/components/responses/IndividualLoggingJob.Get.200' "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 delete: description: >- @@ -151,25 +151,25 @@ paths: "204": $ref: '#/components/responses/IndividualLoggingJob.Delete.204' "400": - $ref: '../components/SOL009_resp.yaml#/components/responses/400' + $ref: '../responses/SOL009_resp.yaml#/responses/400' "401": - $ref: '../components/SOL009_resp.yaml#/components/responses/401' + $ref: '../responses/SOL009_resp.yaml#/responses/401' "403": - $ref: '../components/SOL009_resp.yaml#/components/responses/403' + $ref: '../responses/SOL009_resp.yaml#/responses/403' "404": - $ref: '../components/SOL009_resp.yaml#/components/responses/404' + $ref: '../responses/SOL009_resp.yaml#/responses/404' "405": - $ref: '../components/SOL009_resp.yaml#/components/responses/405' + $ref: '../responses/SOL009_resp.yaml#/responses/405' "406": - $ref: '../components/SOL009_resp.yaml#/components/responses/406' + $ref: '../responses/SOL009_resp.yaml#/responses/406' "422": - $ref: '../components/SOL009_resp.yaml#/components/responses/422' + $ref: '../responses/SOL009_resp.yaml#/responses/422' "500": - $ref: '../components/SOL009_resp.yaml#/components/responses/500' + $ref: '../responses/SOL009_resp.yaml#/responses/500' "503": - $ref: '../components/SOL009_resp.yaml#/components/responses/503' + $ref: '../responses/SOL009_resp.yaml#/responses/503' "504": - $ref: '../components/SOL009_resp.yaml#/components/responses/504' + $ref: '../responses/SOL009_resp.yaml#/responses/504' "/log_jobs/{logJobId}/log_reports/{logReportId}": description: >- @@ -194,25 +194,25 @@ paths: "202": $ref: '#/components/responses/LogReport.Get.202' "400": - $ref: '../components/SOL009_resp.yaml#/components/responses/400' + $ref: '../responses/SOL009_resp.yaml#/responses/400' "401": - $ref: '../components/SOL009_resp.yaml#/components/responses/401' + $ref: '../responses/SOL009_resp.yaml#/responses/401' "403": - $ref: '../components/SOL009_resp.yaml#/components/responses/403' + $ref: '../responses/SOL009_resp.yaml#/responses/403' "404": - $ref: '../components/SOL009_resp.yaml#/components/responses/404' + $ref: '../responses/SOL009_resp.yaml#/responses/404' "405": - $ref: '../components/SOL009_resp.yaml#/components/responses/405' + $ref: '../responses/SOL009_resp.yaml#/responses/405' "406": - $ref: '../components/SOL009_resp.yaml#/components/responses/406' + $ref: '../responses/SOL009_resp.yaml#/responses/406' "422": - $ref: '../components/SOL009_resp.yaml#/components/responses/422' + $ref: '../responses/SOL009_resp.yaml#/responses/422' "500": - $ref: '../components/SOL009_resp.yaml#/components/responses/500' + $ref: '../responses/SOL009_resp.yaml#/responses/500' "503": - $ref: '../components/SOL009_resp.yaml#/components/responses/503' + $ref: '../responses/SOL009_resp.yaml#/responses/503' "504": - $ref: '../components/SOL009_resp.yaml#/components/responses/504' + $ref: '../responses/SOL009_resp.yaml#/responses/504' "/log_jobs/{logJobId}/compile_log": description: >- @@ -247,23 +247,23 @@ paths: "422": $ref: '#/components/responses/LogReportCompiled.Post.422' "400": - $ref: '../components/SOL009_resp.yaml#/components/responses/400' + $ref: '../responses/SOL009_resp.yaml#/responses/400' "401": - $ref: '../components/SOL009_resp.yaml#/components/responses/401' + $ref: '../responses/SOL009_resp.yaml#/responses/401' "403": - $ref: '../components/SOL009_resp.yaml#/components/responses/403' + $ref: '../responses/SOL009_resp.yaml#/responses/403' "404": - $ref: '../components/SOL009_resp.yaml#/components/responses/404' + $ref: '../responses/SOL009_resp.yaml#/responses/404' "405": - $ref: '../components/SOL009_resp.yaml#/components/responses/405' + $ref: '../responses/SOL009_resp.yaml#/responses/405' "406": - $ref: '../components/SOL009_resp.yaml#/components/responses/406' + $ref: '../responses/SOL009_resp.yaml#/responses/406' "500": - $ref: '../components/SOL009_resp.yaml#/components/responses/500' + $ref: '../responses/SOL009_resp.yaml#/responses/500' "503": - $ref: '../components/SOL009_resp.yaml#/components/responses/503' + $ref: '../responses/SOL009_resp.yaml#/responses/503' "504": - $ref: '../components/SOL009_resp.yaml#/components/responses/504' + $ref: '../responses/SOL009_resp.yaml#/responses/504' "/subscriptions": description: >- @@ -285,25 +285,25 @@ paths: "303": $ref: '#/components/responses/Subscriptions.Post.303' "422": - $ref: '../components/SOL009_resp.yaml#/components/responses/422' + $ref: '../responses/SOL009_resp.yaml#/responses/422' "400": - $ref: '../components/SOL009_resp.yaml#/components/responses/400' + $ref: '../responses/SOL009_resp.yaml#/responses/400' "401": - $ref: '../components/SOL009_resp.yaml#/components/responses/401' + $ref: '../responses/SOL009_resp.yaml#/responses/401' "403": - $ref: '../components/SOL009_resp.yaml#/components/responses/403' + $ref: '../responses/SOL009_resp.yaml#/responses/403' "404": - $ref: '../components/SOL009_resp.yaml#/components/responses/404' + $ref: '../responses/SOL009_resp.yaml#/responses/404' "405": - $ref: '../components/SOL009_resp.yaml#/components/responses/405' + $ref: '../responses/SOL009_resp.yaml#/responses/405' "406": - $ref: '../components/SOL009_resp.yaml#/components/responses/406' + $ref: '../responses/SOL009_resp.yaml#/responses/406' "500": - $ref: '../components/SOL009_resp.yaml#/components/responses/500' + $ref: '../responses/SOL009_resp.yaml#/responses/500' "503": - $ref: '../components/SOL009_resp.yaml#/components/responses/503' + $ref: '../responses/SOL009_resp.yaml#/responses/503' "504": - $ref: '../components/SOL009_resp.yaml#/components/responses/504' + $ref: '../responses/SOL009_resp.yaml#/responses/504' callbacks: LogReportAvailableNotification: $ref: '#/components/callbacks/LogReportAvailableNotification' @@ -322,23 +322,23 @@ paths: "200": $ref: '#/components/responses/Subscriptions.Get.200' "400": - $ref: '../components/SOL009_resp.yaml#/components/responses/400' + $ref: '../responses/SOL009_resp.yaml#/responses/400' "401": - $ref: '../components/SOL009_resp.yaml#/components/responses/401' + $ref: '../responses/SOL009_resp.yaml#/responses/401' "403": - $ref: '../components/SOL009_resp.yaml#/components/responses/403' + $ref: '../responses/SOL009_resp.yaml#/responses/403' "404": - $ref: '../components/SOL009_resp.yaml#/components/responses/404' + $ref: '../responses/SOL009_resp.yaml#/responses/404' "405": - $ref: '../components/SOL009_resp.yaml#/components/responses/405' + $ref: '../responses/SOL009_resp.yaml#/responses/405' "406": - $ref: '../components/SOL009_resp.yaml#/components/responses/406' + $ref: '../responses/SOL009_resp.yaml#/responses/406' "500": - $ref: '../components/SOL009_resp.yaml#/components/responses/500' + $ref: '../responses/SOL009_resp.yaml#/responses/500' "503": - $ref: '../components/SOL009_resp.yaml#/components/responses/503' + $ref: '../responses/SOL009_resp.yaml#/responses/503' "504": - $ref: '../components/SOL009_resp.yaml#/components/responses/504' + $ref: '../responses/SOL009_resp.yaml#/responses/504' "/subscriptions/{subscriptionId}": description: >- @@ -359,23 +359,23 @@ paths: "200": $ref: '#/components/responses/Subscription.Get.200' "400": - $ref: '../components/SOL009_resp.yaml#/components/responses/400' + $ref: '../responses/SOL009_resp.yaml#/responses/400' "401": - $ref: '../components/SOL009_resp.yaml#/components/responses/401' + $ref: '../responses/SOL009_resp.yaml#/responses/401' "403": - $ref: '../components/SOL009_resp.yaml#/components/responses/403' + $ref: '../responses/SOL009_resp.yaml#/responses/403' "404": - $ref: '../components/SOL009_resp.yaml#/components/responses/404' + $ref: '../responses/SOL009_resp.yaml#/responses/404' "405": - $ref: '../components/SOL009_resp.yaml#/components/responses/405' + $ref: '../responses/SOL009_resp.yaml#/responses/405' "406": - $ref: '../components/SOL009_resp.yaml#/components/responses/406' + $ref: '../responses/SOL009_resp.yaml#/responses/406' "500": - $ref: '../components/SOL009_resp.yaml#/components/responses/500' + $ref: '../responses/SOL009_resp.yaml#/responses/500' "503": - $ref: '../components/SOL009_resp.yaml#/components/responses/503' + $ref: '../responses/SOL009_resp.yaml#/responses/503' "504": - $ref: '../components/SOL009_resp.yaml#/components/responses/504' + $ref: '../responses/SOL009_resp.yaml#/responses/504' delete: description: >- @@ -387,25 +387,25 @@ paths: "204": $ref: '#/components/responses/Subscription.Delete.204' "400": - $ref: '../components/SOL009_resp.yaml#/components/responses/400' + $ref: '../responses/SOL009_resp.yaml#/responses/400' "401": - $ref: '../components/SOL009_resp.yaml#/components/responses/401' + $ref: '../responses/SOL009_resp.yaml#/responses/401' "403": - $ref: '../components/SOL009_resp.yaml#/components/responses/403' + $ref: '../responses/SOL009_resp.yaml#/responses/403' "404": - $ref: '../components/SOL009_resp.yaml#/components/responses/404' + $ref: '../responses/SOL009_resp.yaml#/responses/404' "405": - $ref: '../components/SOL009_resp.yaml#/components/responses/405' + $ref: '../responses/SOL009_resp.yaml#/responses/405' "406": - $ref: '../components/SOL009_resp.yaml#/components/responses/406' + $ref: '../responses/SOL009_resp.yaml#/responses/406' "422": - $ref: '../components/SOL009_resp.yaml#/components/responses/422' + $ref: '../responses/SOL009_resp.yaml#/responses/422' "500": - $ref: '../components/SOL009_resp.yaml#/components/responses/500' + $ref: '../responses/SOL009_resp.yaml#/responses/500' "503": - $ref: '../components/SOL009_resp.yaml#/components/responses/503' + $ref: '../responses/SOL009_resp.yaml#/responses/503' "504": - $ref: '../components/SOL009_resp.yaml#/components/responses/504' + $ref: '../responses/SOL009_resp.yaml#/responses/504' components: parameters: @@ -457,7 +457,7 @@ components: Identifier of the logging job. required: true schema: - $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' logReportId: name: logReportId in: path @@ -465,7 +465,7 @@ components: Identifier of the report. required: true schema: - $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' subscriptionId: name: subscriptionId in: path @@ -473,7 +473,7 @@ components: Identifier of the subscription required: true schema: - $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' requestBodies: LogmSubscriptionRequest: @@ -482,7 +482,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogmSubscriptionRequest" + $ref: "./definitions/NFVManoLogManagement_def.yaml#/definitions/schemas/LogmSubscriptionRequest" required: true CreateLoggingJobRequest: @@ -492,7 +492,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/CreateLoggingJobRequest" + $ref: "./definitions/NFVManoLogManagement_def.yaml#/definitions/schemas/CreateLoggingJobRequest" required: true CompileLogRequest: description: >- @@ -500,7 +500,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/CompileLogRequest" + $ref: "./definitions/NFVManoLogManagement_def.yaml#/definitions/schemas/CompileLogRequest" required: true LogReportAvailableNotification: description: >- @@ -508,7 +508,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogReportAvailableNotification" + $ref: "./definitions/NFVManoLogManagement_def.yaml#/definitions/schemas/LogReportAvailableNotification" required: true responses: @@ -563,7 +563,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogmSubscription" + $ref: "./definitions/NFVManoLogManagement_def.yaml#/definitions/schemas/LogmSubscription" Subscriptions.Get.200: description: > @@ -600,7 +600,7 @@ components: schema: type: array items: - $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogmSubscription" + $ref: "./definitions/NFVManoLogManagement_def.yaml#/definitions/schemas/LogmSubscription" Subscriptions.Post.201: description: > @@ -636,7 +636,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogmSubscription" + $ref: "./definitions/NFVManoLogManagement_def.yaml#/definitions/schemas/LogmSubscription" Subscriptions.Post.303: description: > @@ -704,7 +704,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogReport" + $ref: "./definitions/NFVManoLogManagement_def.yaml#/definitions/schemas/LogReport" subscriptions.post.422: description: > @@ -740,7 +740,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" LogReportCompiled.Post.202: description: > @@ -839,7 +839,7 @@ components: content: application/json: schema: - $ref: '../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails' + $ref: '../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails' LogReport.Get.200: description: > @@ -868,7 +868,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogReport" + $ref: "./definitions/NFVManoLogManagement_def.yaml#/definitions/schemas/LogReport" LogReport.Get.202: description: > @@ -922,7 +922,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LoggingJob" + $ref: "./definitions/NFVManoLogManagement_def.yaml#/definitions/schemas/LoggingJob" IndividualLoggingJob.Delete.204: description: > @@ -970,7 +970,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LoggingJob" + $ref: "./definitions/NFVManoLogManagement_def.yaml#/definitions/schemas/LoggingJob" LoggingJobs.Get.200: description: > @@ -1011,7 +1011,7 @@ components: schema: type: array items: - $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LoggingJob" + $ref: "./definitions/NFVManoLogManagement_def.yaml#/definitions/schemas/LoggingJob" LogReportAvailableNotification.Post.204: description: > @@ -1083,25 +1083,25 @@ components: "204": $ref: '#/components/responses/LogReportAvailableNotification.Post.204' "400": - $ref: '../components/SOL009_resp.yaml#/components/responses/400' + $ref: '../responses/SOL009_resp.yaml#/responses/400' "401": - $ref: '../components/SOL009_resp.yaml#/components/responses/401' + $ref: '../responses/SOL009_resp.yaml#/responses/401' "403": - $ref: '../components/SOL009_resp.yaml#/components/responses/403' + $ref: '../responses/SOL009_resp.yaml#/responses/403' "404": - $ref: '../components/SOL009_resp.yaml#/components/responses/404' + $ref: '../responses/SOL009_resp.yaml#/responses/404' "405": - $ref: '../components/SOL009_resp.yaml#/components/responses/405' + $ref: '../responses/SOL009_resp.yaml#/responses/405' "406": - $ref: '../components/SOL009_resp.yaml#/components/responses/406' + $ref: '../responses/SOL009_resp.yaml#/responses/406' "422": - $ref: '../components/SOL009_resp.yaml#/components/responses/422' + $ref: '../responses/SOL009_resp.yaml#/responses/422' "500": - $ref: '../components/SOL009_resp.yaml#/components/responses/500' + $ref: '../responses/SOL009_resp.yaml#/responses/500' "503": - $ref: '../components/SOL009_resp.yaml#/components/responses/503' + $ref: '../responses/SOL009_resp.yaml#/responses/503' "504": - $ref: '../components/SOL009_resp.yaml#/components/responses/504' + $ref: '../responses/SOL009_resp.yaml#/responses/504' get: description: >- The GET method allows the API producer to test the notification endpoint that is provided by the API @@ -1116,22 +1116,22 @@ components: "204": $ref: '#/components/responses/LogReportAvailableNotification.Get.204' "400": - $ref: '../components/SOL009_resp.yaml#/components/responses/400' + $ref: '../responses/SOL009_resp.yaml#/responses/400' "401": - $ref: '../components/SOL009_resp.yaml#/components/responses/401' + $ref: '../responses/SOL009_resp.yaml#/responses/401' "403": - $ref: '../components/SOL009_resp.yaml#/components/responses/403' + $ref: '../responses/SOL009_resp.yaml#/responses/403' "404": - $ref: '../components/SOL009_resp.yaml#/components/responses/404' + $ref: '../responses/SOL009_resp.yaml#/responses/404' "405": - $ref: '../components/SOL009_resp.yaml#/components/responses/405' + $ref: '../responses/SOL009_resp.yaml#/responses/405' "406": - $ref: '../components/SOL009_resp.yaml#/components/responses/406' + $ref: '../responses/SOL009_resp.yaml#/responses/406' "422": - $ref: '../components/SOL009_resp.yaml#/components/responses/422' + $ref: '../responses/SOL009_resp.yaml#/responses/422' "500": - $ref: '../components/SOL009_resp.yaml#/components/responses/500' + $ref: '../responses/SOL009_resp.yaml#/responses/500' "503": - $ref: '../components/SOL009_resp.yaml#/components/responses/503' + $ref: '../responses/SOL009_resp.yaml#/responses/503' "504": - $ref: '../components/SOL009_resp.yaml#/components/responses/504' + $ref: '../responses/SOL009_resp.yaml#/responses/504' diff --git a/src/SOL009/NFVManoLogManagement/components/NFVManoLogManagement_def.yaml b/src/SOL009/NFVManoLogManagement/definitions/NFVManoLogManagement_def.yaml similarity index 89% rename from src/SOL009/NFVManoLogManagement/components/NFVManoLogManagement_def.yaml rename to src/SOL009/NFVManoLogManagement/definitions/NFVManoLogManagement_def.yaml index e70482bb9f0a32c3baa8f4fc08ad92f294bdb942..61edc66582dcada8dd4e31051f6b2e0049ad27c5 100644 --- a/src/SOL009/NFVManoLogManagement/components/NFVManoLogManagement_def.yaml +++ b/src/SOL009/NFVManoLogManagement/definitions/NFVManoLogManagement_def.yaml @@ -1,4 +1,4 @@ -components: +definitions: schemas: LogmSubscription: description: >- @@ -12,17 +12,17 @@ components: id: description: >- Identifier that identifies the subscription. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' filter: description: >- Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter - $ref: "#/components/schemas/LogmNotificationsFilter" + $ref: "#/definitions/schemas/LogmNotificationsFilter" callbackUri: description: >- The URI of the endpoint to send the notification to. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Uri' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Uri' _links: description: >- Links to resources related to this resource. @@ -33,7 +33,7 @@ components: self: description: >- URI of this resource. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Link' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Link' LogmNotificationsFilter: description: >- @@ -46,7 +46,7 @@ components: objectInstanceFilter: description: >- Filter criteria to select object instance about which to notify. - $ref: "#/components/schemas/ManoEntitySubscriptionFilter" + $ref: "#/definitions/schemas/ManoEntitySubscriptionFilter" notificationTypes: description: >- Match particular notification types. @@ -81,13 +81,13 @@ components: manoEntityId: description: >- If present, match the NFV-MANO functional entity with an instance identifier listed in this attribute. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' manoServiceIds: description: >- If present, match NFV-MANO services with an instance identifier listed in this attribute. type: array items: - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity' manoServiceNames: description: >- If present, match NFV-MANO services with an NFV-MANO service name listed in this attribute. @@ -100,7 +100,7 @@ components: identifier listed in this attribute. type: array items: - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity' manoServiceInterfaceNames: description: >- If present, match NFV-MANO functional entity produced interfaces with an instance Name listed in @@ -114,7 +114,7 @@ components: listed in this attribute. type: array items: - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' consumedManoInterfaceNames: description: >- If present, match NFV-MANO functional entity consumed interfaces with an instance Name @@ -135,7 +135,7 @@ components: value shall correspond to an object instance for which log data is being collected as specified in the corresponding "LoggingJob". If not present, the compile log request is requested for all managed object instances associated to the logging job. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ManoManagedObjectReference" LogReport: description: > This type represents a log report, which provides information about a compiled log and how to obtain it. @@ -155,13 +155,13 @@ components: id: description: >- Identifier of this log report. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' objectInstanceId: description: >- Identifiers of the object instance for which logging information is collected. This attribute shall contain the identifier of the instance of the object that is logged according to their type. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/ManoManagedObjectReference' compilationTrigger: description: >- The trigger for the compilation of the log file. @@ -174,11 +174,11 @@ components: readyTime: description: >- The time when the report and log file was made available. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/DateTime' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime' expiryTime: description: >- The time when the report and log file will expire. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/DateTime' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime' fileSize: description: >- The size of the compiled log file in bytes, if known. @@ -269,14 +269,14 @@ components: self: description: >- URI of this resource. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Link' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Link' objects: description: >- Links to resources representing the object instances that are logged. Shall be present if the logged object instance information is accessible as a resource. type: array items: - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Link' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Link' LogmSubscriptionRequest: description: >- @@ -291,17 +291,17 @@ components: Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. - $ref: "#/components/schemas/LogmNotificationsFilter" + $ref: "#/definitions/schemas/LogmNotificationsFilter" callbackUri: description: > The URI of the endpoint to send the notification to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" authentication: description: > Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013. This attribute shall only be present if the subscriber requires authorization of notifications. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/SubscriptionAuthentication" CreateLoggingJobRequest: description: >- @@ -321,15 +321,15 @@ components: type: array minItems: 1 items: - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ManoManagedObjectReference" jobCriteria: description: >- Criteria of the collection of logging information. - $ref: "#/components/schemas/LoggingJobCriteria" + $ref: "#/definitions/schemas/LoggingJobCriteria" jobConfig: description: >- Configuration about the logging job. - $ref: "#/components/schemas/LoggingJobConfig" + $ref: "#/definitions/schemas/LoggingJobConfig" LoggingJob: description: >- @@ -345,22 +345,22 @@ components: id: description: >- Identifier of this logging job. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' objectInstanceIds: description: >- Identifiers of the object instance for which logging information is collected. This attribute shall contain the identifier of the instance of the object that is logged according to their type. type: array items: - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ManoManagedObjectReference" jobCriteria: description: >- Criteria of the collection of logging information. - $ref: "#/components/schemas/LoggingJobCriteria" + $ref: "#/definitions/schemas/LoggingJobCriteria" jobConfig: description: >- Configuration about the logging job. - $ref: "#/components/schemas/LoggingJobConfig" + $ref: "#/definitions/schemas/LoggingJobConfig" logReports: description: >- Information about available log reports created by the logging job. @@ -374,11 +374,11 @@ components: logReportId: description: >- Identifier of the available log report. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' logReportLoc: description: >- Link to the available log report. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Link' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Link' _links: description: >- Links for this resource. @@ -389,14 +389,14 @@ components: self: description: >- URI of this resource. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Link' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Link' objects: description: >- Links to resources representing the object instances that are logged. Shall be present if the logged object instance information is accessible as a resource. type: array items: - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Link' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Link' LoggingJobCriteria: description: >- @@ -425,18 +425,18 @@ components: Values for the collection of logged NFV-MANO service interface messages. Shall be present if loggingType="MESSAGES". type: object - $ref: "#/components/schemas/LoggingJobMessagesCriteria" + $ref: "#/definitions/schemas/LoggingJobMessagesCriteria" servicesLogDetail: description: >- Values for the collection of logged NFV-MANO service messages. Shall be present if loggingType="SERVICES". type: object - $ref: "#/components/schemas/LoggingJobServicesCriteria" + $ref: "#/definitions/schemas/LoggingJobServicesCriteria" systemLogDetail: description: >- Values for the collection of logged messages about the NFV-MANO functional entity’s system. Shall be present if loggingType="SYSTEM". type: object - $ref: "#/components/schemas/LoggingJobSystemCriteria" + $ref: "#/definitions/schemas/LoggingJobSystemCriteria" LoggingJobMessagesCriteria: description: >- @@ -483,7 +483,7 @@ components: description: >- IP address to match the source IP address of request messages to log. The API producer shall support this attribute. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/IpAddress' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/IpAddress' requestMethod: description: >- HTTP request method to be matched. To match, the HTTP request method of the message shall be the @@ -501,7 +501,7 @@ components: description: >- IP address to match the destination IP address of response messages to log. The API producer shall support this attribute - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/IpAddress' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/IpAddress' responseCodes: description: >- HTTP response codes or patterns to match. A list of all valid HTTP response codes and their @@ -569,7 +569,7 @@ components: systemLogs: description: >- Values for the provider enabled system logs. See note. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs" severityLevelScheme: description: >- Identifies a severity level scheme. @@ -609,12 +609,12 @@ components: description: >- Specifies the time for the logging job to be started. If not provided, the logging job is requested to start immediately. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" endTime: description: >- Specifies the time after which the logging job will stop. Shall only be provided if the logging job is requested to stop at a specific time. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" reportingCondition: description: >- Specifies the condition under which the producer will report to the consumer about the compiled log data. @@ -720,7 +720,7 @@ components: description: >- Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' notificationType: description: >- Discriminator for the different notification types. @@ -729,16 +729,16 @@ components: subscriptionId: description: >- Identifier of the subscription that this notification relates to. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' timeStamp: description: >- Date and time of the generation of the notification. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/DateTime' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime' objectInstanceId: description: >- Identifier that identifies the object instance for which the log report is available. This attribute shall contain the identifier of the logged object according to their type. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ManoManagedObjectReference" _links: description: >- Links to resources related to this notification. @@ -750,16 +750,16 @@ components: subscription: description: >- Link to the related subscription. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink' objectInstance: description: >- Link to the resource representing the measured object instance to which the notified change applies. Shall be present if the measured object instance information is accessible as a resource. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink' LoggingJob: description: >- Link to the resource that represents the logging job for which the log report is available. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink' logReports: description: >- Link from which the available log report can be obtained. Due to the relationship of the logging @@ -767,4 +767,4 @@ components: notification link can be provided. type: array items: - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink' diff --git a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml index e0419b98e787fdbb0c0b8258a1d1abf5a593c9b2..3236d3d678c216e902d79ec8a95daf43c24d524a 100644 --- a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml +++ b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml @@ -19,8 +19,8 @@ info: version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V3.6.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf + description: ETSI GS NFV-SOL 009 V4.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/04.03.01_60/gs_NFV-SOL009v040301p.pdf servers: - url: http://127.0.0.1/callback/v1 @@ -47,25 +47,25 @@ paths: "204": $ref: '#/components/responses/Notification.Post.204' "400": - $ref: '../components/SOL009_resp.yaml#/components/responses/400' + $ref: '../responses/SOL009_resp.yaml#/responses/400' "401": - $ref: '../components/SOL009_resp.yaml#/components/responses/401' + $ref: '../responses/SOL009_resp.yaml#/responses/401' "403": - $ref: '../components/SOL009_resp.yaml#/components/responses/403' + $ref: '../responses/SOL009_resp.yaml#/responses/403' "404": - $ref: '../components/SOL009_resp.yaml#/components/responses/404' + $ref: '../responses/SOL009_resp.yaml#/responses/404' "405": - $ref: '../components/SOL009_resp.yaml#/components/responses/405' + $ref: '../responses/SOL009_resp.yaml#/responses/405' "406": - $ref: '../components/SOL009_resp.yaml#/components/responses/406' + $ref: '../responses/SOL009_resp.yaml#/responses/406' "422": - $ref: '../components/SOL009_resp.yaml#/components/responses/422' + $ref: '../responses/SOL009_resp.yaml#/responses/422' "500": - $ref: '../components/SOL009_resp.yaml#/components/responses/500' + $ref: '../responses/SOL009_resp.yaml#/responses/500' "503": - $ref: '../components/SOL009_resp.yaml#/components/responses/503' + $ref: '../responses/SOL009_resp.yaml#/responses/503' "504": - $ref: '../components/SOL009_resp.yaml#/components/responses/504' + $ref: '../responses/SOL009_resp.yaml#/responses/504' get: description: >- @@ -79,25 +79,25 @@ paths: "204": $ref: '#/components/responses/Notification.Get.204' "400": - $ref: '../components/SOL009_resp.yaml#/components/responses/400' + $ref: '../responses/SOL009_resp.yaml#/responses/400' "401": - $ref: '../components/SOL009_resp.yaml#/components/responses/401' + $ref: '../responses/SOL009_resp.yaml#/responses/401' "403": - $ref: '../components/SOL009_resp.yaml#/components/responses/403' + $ref: '../responses/SOL009_resp.yaml#/responses/403' "404": - $ref: '../components/SOL009_resp.yaml#/components/responses/404' + $ref: '../responses/SOL009_resp.yaml#/responses/404' "405": - $ref: '../components/SOL009_resp.yaml#/components/responses/405' + $ref: '../responses/SOL009_resp.yaml#/responses/405' "406": - $ref: '../components/SOL009_resp.yaml#/components/responses/406' + $ref: '../responses/SOL009_resp.yaml#/responses/406' "422": - $ref: '../components/SOL009_resp.yaml#/components/responses/422' + $ref: '../responses/SOL009_resp.yaml#/responses/422' "500": - $ref: '../components/SOL009_resp.yaml#/components/responses/500' + $ref: '../responses/SOL009_resp.yaml#/responses/500' "503": - $ref: '../components/SOL009_resp.yaml#/components/responses/503' + $ref: '../responses/SOL009_resp.yaml#/responses/503' "504": - $ref: '../components/SOL009_resp.yaml#/components/responses/504' + $ref: '../responses/SOL009_resp.yaml#/responses/504' components: requestBodies: @@ -107,7 +107,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoLogManagementNotification_def.yaml#/components/schemas/LogReportAvailableNotification" + $ref: "./definitions/NFVManoLogManagementNotification_def.yaml#/definitions/schemas/LogReportAvailableNotification" required: true responses: diff --git a/src/SOL009/NFVManoLogManagementNotification/components/NFVManoLogManagementNotification_def.yaml b/src/SOL009/NFVManoLogManagementNotification/definitions/NFVManoLogManagementNotification_def.yaml similarity index 78% rename from src/SOL009/NFVManoLogManagementNotification/components/NFVManoLogManagementNotification_def.yaml rename to src/SOL009/NFVManoLogManagementNotification/definitions/NFVManoLogManagementNotification_def.yaml index cd2efbdda0dfce65d466d6f8cb498936b206b5da..78f9ceb153cf262b7179630e7abb3fd58c20d536 100644 --- a/src/SOL009/NFVManoLogManagementNotification/components/NFVManoLogManagementNotification_def.yaml +++ b/src/SOL009/NFVManoLogManagementNotification/definitions/NFVManoLogManagementNotification_def.yaml @@ -1,4 +1,4 @@ -components: +definitions: schemas: LogReportAvailableNotification: description: >- @@ -19,7 +19,7 @@ components: description: >- Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' notificationType: description: >- Discriminator for the different notification types. @@ -28,16 +28,16 @@ components: subscriptionId: description: >- Identifier of the subscription that this notification relates to. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' timeStamp: description: >- Date and time of the generation of the notification. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/DateTime' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime' objectInstanceId: description: >- Identifier that identifies the object instance for which the log report is available. This attribute shall contain the identifier of the logged object according to their type. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ManoManagedObjectReference" _links: description: >- Links to resources related to this notification. @@ -49,16 +49,16 @@ components: subscription: description: >- Link to the related subscription. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink' objectInstance: description: >- Link to the resource representing the measured object instance to which the notified change applies. Shall be present if the measured object instance information is accessible as a resource. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink' LoggingJob: description: >- Link to the resource that represents the logging job for which the log report is available. - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink' logReports: description: >- Link from which the available log report can be obtained. Due to the relationship of the logging @@ -66,4 +66,4 @@ components: notification link can be provided. type: array items: - $ref: '../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink' + $ref: '../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink' diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index 5da440b2345c673e62e76a9ae123ea70ac35c2a6..1af6c7edec4ae896b15338fc319c237d4b6262d7 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -20,8 +20,8 @@ info: version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V3.6.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf + description: ETSI GS NFV-SOL 009 V4.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/04.03.01_60/gs_NFV-SOL009v040301p.pdf servers: - url: http://127.0.0.1/nfvmanopm/v2 @@ -45,25 +45,25 @@ paths: "201": $ref: "#/components/responses/pm_jobs.Post.201" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 get: description: > The client can use this method to retrieve information about PM jobs. See clause 6.5.3.3.2. @@ -83,23 +83,23 @@ paths: "400": $ref: "#/components/responses/pm_jobs.Get.400" "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /pm_jobs/{pmJobId}: parameters: @@ -115,25 +115,25 @@ paths: "200": $ref: "#/components/responses/IndividualPmJob.Get.200" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 patch: description: > This method allows to modify an "individual PM job" resource. See clause 6.5.4.3.4. @@ -151,25 +151,25 @@ paths: "422": $ref: "#/components/responses/IndividualPmJob.Patch.422" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "409": - $ref: ../components/SOL009_resp.yaml#/components/responses/409 + $ref: ../responses/SOL009_resp.yaml#/responses/409 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 delete: description: > This method terminates an individual PM job. See clause 6.5.4.3.5. @@ -181,25 +181,25 @@ paths: "204": $ref: "#/components/responses/IndividualPmJob.Delete.204" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /pm_jobs/{pmJobId}/reports/{reportId}: parameters: @@ -216,25 +216,25 @@ paths: "200": $ref: "#/components/responses/IndividualPerformanceReport.Get.200" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /thresholds: post: @@ -252,23 +252,23 @@ paths: "422": $ref: "#/components/responses/Thresholds.Post.422" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 get: description: > The client can use this method to query information about thresholds. See clause 6.5.6.3.2. @@ -284,23 +284,23 @@ paths: "400": $ref: "#/components/responses/Thresholds.Get.400" "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 /thresholds/{thresholdId}: parameters: @@ -316,25 +316,25 @@ paths: "200": $ref: "#/components/responses/Threshold.Get.200" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 patch: description: > This method allows to modify an "Individual threshold" resource. See clause 6.5.7.3.4. @@ -352,25 +352,25 @@ paths: "422": $ref: "#/components/responses/Threshold.Patch.422" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "409": - $ref: ../components/SOL009_resp.yaml#/components/responses/409 + $ref: ../responses/SOL009_resp.yaml#/responses/409 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 delete: description: > This method allows to delete a threshold. See clause 6.5.7.3.5. @@ -382,25 +382,25 @@ paths: "204": $ref: "#/components/responses/Threshold.Delete.204" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 components: responses: @@ -431,7 +431,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/PmJob" + $ref: "./definitions/NFVManoPerformanceManagement_def.yaml#/definitions/schemas/PmJob" pm_jobs.Post.422: description: > 422 Unprocessable Entity @@ -466,7 +466,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" pm_jobs.Get.200: description: > @@ -514,7 +514,7 @@ components: schema: type: array items: - $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/PmJob" + $ref: "./definitions/NFVManoPerformanceManagement_def.yaml#/definitions/schemas/PmJob" pm_jobs.Get.400: description: > 400 BAD REQUEST @@ -547,7 +547,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" IndividualPmJob.Get.200: description: > @@ -574,7 +574,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/PmJob" + $ref: "./definitions/NFVManoPerformanceManagement_def.yaml#/definitions/schemas/PmJob" IndividualPmJob.Patch.200: description: > 200 OK @@ -598,7 +598,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/PmJobModifications" + $ref: "./definitions/NFVManoPerformanceManagement_def.yaml#/definitions/schemas/PmJobModifications" IndividualPmJob.Patch.412: description: > 412 PRECONDITION FAILED @@ -627,7 +627,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" IndividualPmJob.Patch.422: description: > 422 Unprocessable Entity @@ -662,7 +662,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" IndividualPmJob.Delete.204: description: > 204 NO CONTENT @@ -710,7 +710,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/PerformanceReport" + $ref: "./definitions/NFVManoPerformanceManagement_def.yaml#/definitions/schemas/PerformanceReport" Thresholds.Post.201: description: > @@ -749,7 +749,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/Threshold" + $ref: "./definitions/NFVManoPerformanceManagement_def.yaml#/definitions/schemas/Threshold" Thresholds.Post.422: description: > 422 Unprocessable Entity @@ -784,7 +784,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" Thresholds.Get.200: description: > @@ -822,7 +822,7 @@ components: schema: type: array items: - $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/Threshold" + $ref: "./definitions/NFVManoPerformanceManagement_def.yaml#/definitions/schemas/Threshold" Thresholds.Get.400: description: > 400 BAD REQUEST @@ -852,7 +852,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" Threshold.Get.200: description: > @@ -879,7 +879,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/Threshold" + $ref: "./definitions/NFVManoPerformanceManagement_def.yaml#/definitions/schemas/Threshold" Threshold.Patch.200: description: > @@ -904,7 +904,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/ThresholdModifications" + $ref: "./definitions/NFVManoPerformanceManagement_def.yaml#/definitions/schemas/ThresholdModifications" Threshold.Patch.412: description: > 412 PRECONDITION FAILED @@ -933,7 +933,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" Threshold.Patch.422: description: > 422 Unprocessable Entity @@ -968,7 +968,7 @@ components: content: application/json: schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" Threshold.Delete.204: description: > @@ -1051,7 +1051,7 @@ components: Identifier of the PM Job required: true schema: - $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' reportId: name: reportId @@ -1060,7 +1060,7 @@ components: Identifier of the PM report required: true schema: - $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' thresholdId: name: thresholdId @@ -1069,7 +1069,7 @@ components: Identifier of the PM threshold required: true schema: - $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' + $ref: '../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' requestBodies: CreatePMJobRequest: @@ -1078,7 +1078,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/CreatePmJobRequest" + $ref: "./definitions/NFVManoPerformanceManagement_def.yaml#/definitions/schemas/CreatePmJobRequest" required: true CreateThresholdRequest: @@ -1087,7 +1087,7 @@ components: content: application/json: schema: - $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/CreateThresholdRequest" + $ref: "./definitions/NFVManoPerformanceManagement_def.yaml#/definitions/schemas/CreateThresholdRequest" required: true ThresholdModificationRequest: @@ -1099,7 +1099,7 @@ components: content: application/merge-patch+json: schema: - $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/ThresholdModifications" + $ref: "./definitions/NFVManoPerformanceManagement_def.yaml#/definitions/schemas/ThresholdModifications" required: true PmJobModificationRequest: @@ -1111,5 +1111,5 @@ components: content: application/merge-patch+json: schema: - $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/PmJobModifications" + $ref: "./definitions/NFVManoPerformanceManagement_def.yaml#/definitions/schemas/PmJobModifications" required: true \ No newline at end of file diff --git a/src/SOL009/NFVManoPerformanceManagement/components/NFVManoPerformanceManagement_def.yaml b/src/SOL009/NFVManoPerformanceManagement/definitions/NFVManoPerformanceManagement_def.yaml similarity index 85% rename from src/SOL009/NFVManoPerformanceManagement/components/NFVManoPerformanceManagement_def.yaml rename to src/SOL009/NFVManoPerformanceManagement/definitions/NFVManoPerformanceManagement_def.yaml index 07f690632281ab6bb0ce5d035c3a830a8e26c6c2..8d08f56868e85e7c76fced339f8f298a3efd4604 100644 --- a/src/SOL009/NFVManoPerformanceManagement/components/NFVManoPerformanceManagement_def.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/definitions/NFVManoPerformanceManagement_def.yaml @@ -1,4 +1,4 @@ -components: +definitions: schemas: CreatePmJobRequest: description: > @@ -25,7 +25,7 @@ components: object instances of the same type, for which the same criteria is then applicable. type: array items: - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" minItems: 1 subObjectInstanceIds: description: > @@ -40,15 +40,15 @@ components: be taken for all sub-object instances of the measured object instance. type: array items: - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity" criteria: description: > Criteria of the collection of performance information. - $ref: "#/components/schemas/PmJobCriteria" + $ref: "#/definitions/schemas/PmJobCriteria" callbackUri: description: > The URI of the endpoint to send the notification to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" authentication: description: > Authentication parameters to configure the use of Authorization when @@ -57,7 +57,7 @@ components: This attribute shall only be present if the subscriber requires authorization of notifications. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/SubscriptionAuthentication" PmJob: description: > @@ -74,7 +74,7 @@ components: id: description: > Identifier of this PM job. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" objectType: description: > Type of measured object. The applicable measured object type for a measurement is @@ -88,7 +88,7 @@ components: See also definitions in clause 8.2 of ETSI GS NFV-IFA 031. type: array items: - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" minItems: 1 subObjectInstanceIds: description: > @@ -103,15 +103,15 @@ components: be taken for all sub-object instances of the measured object instance. type: array items: - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity" criteria: description: > Criteria of the collection of performance information. - $ref: "#/components/schemas/PmJobCriteria" + $ref: "#/definitions/schemas/PmJobCriteria" callbackUri: description: > The URI of the endpoint to send the notification to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" reports: description: > Information about available reports collected by this PM job. @@ -122,19 +122,19 @@ components: href: description: > The Uri where the report can be obtained. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" readyTime: description: > The time when the report was made available. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" expiryTime: description: > The time when the report will expire. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" fileSize: description: > The size of the report file in bytes, if known. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/UnsignedInt" required: - href - readyTime @@ -146,7 +146,7 @@ components: self: description: > URI of this resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link" objects: description: > Links to resources representing the measured object instances for which @@ -154,7 +154,7 @@ components: object instance information is accessible as a resource. type: array items: - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link" required: - self @@ -179,7 +179,7 @@ components: This attribute shall contain the identifier of the instance of the measure object according to their type. See also definitions in clause 8.2 of ETSI GS NFV-IFA 031. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" subjObjectInstanceIds: description: > Identifiers of the sub-object instances of the measured object instance @@ -191,15 +191,15 @@ components: for all sub-object instances of the measured object instance. type: array items: - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity" criteria: description: > Criteria that define this threshold. - $ref: "#/components/schemas/ThresholdCriteria" + $ref: "#/definitions/schemas/ThresholdCriteria" callbackUri: description: > The URI of the endpoint to send the notification to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" authentication: description: > Authentication parameters to configure the use of Authorization when @@ -208,7 +208,7 @@ components: This attribute shall only be present if the subscriber requires authorization of notifications. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/SubscriptionAuthentication" Threshold: description: > @@ -226,7 +226,7 @@ components: id: description: > Identifier of this threshold resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" objectType: description: > Type of measured object. The applicable measured object type for a measurement @@ -238,7 +238,7 @@ components: This attribute shall contain the identifier of the instance of the measure object according to their type. See also definitions in clause 8.2 of ETSI GS NFV-IFA 031. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" subjObjectInstanceIds: description: > Identifiers of the sub-object instances of the measured object instance @@ -250,15 +250,15 @@ components: all sub-object instances of the measured object instance. type: array items: - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity" criteria: description: > Criteria that define this threshold. - $ref: "#/components/schemas/ThresholdCriteria" + $ref: "#/definitions/schemas/ThresholdCriteria" callbackUri: description: > The URI of the endpoint to send the notification to. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" _links: description: > Links for this resource. @@ -267,13 +267,13 @@ components: self: description: > URI for this resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link" object: description: > Link to a resource representing the measured object instance for which performance information is collected. Shall be present if the measured object instance information is accessible as a resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link" required: - self @@ -306,13 +306,13 @@ components: is reported. This attribute shall contain the identifier of the instance of the measure object according to their type. See also definitions in clause 8.2 of ETSI GS NFV-IFA 031. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ManoManagedObjectReference" subObjectInstanceId: description: > Identifier of the sub-object instance of the measured object instance for which the performance metric is reported. Shall be present if this is required in clause 8.2 of ETSI GS NFV-IFA 031 [1] for the related measured object type. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity" performanceMetric: description: > Name of the metric collected. This attribute shall contain the related @@ -328,7 +328,7 @@ components: timeStamp: description: > Time stamp indicating when the data was collected. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" value: description: > Value of the metric collected. The type of this attribute shall correspond to @@ -337,7 +337,7 @@ components: description: > Measurement context information related to the measured value. The set of applicable keys is defined per measurement in clause 8.4 of ETSI GS NFV-IFA 031. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs" required: - timeStamp - value @@ -358,7 +358,7 @@ components: callbackUri: description: > New value of the "callbackUri" attribute.The value "null" is not permitted. See note. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" authentication: description: > New value of the "authentication" attribute, or "null" to remove the attribute. @@ -366,7 +366,7 @@ components: to the rules of JSONMerge PATCH (see IETF RFC 7396). This attribute shall not be present in response bodies. See note. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/SubscriptionAuthentication" ThresholdModifications: description: > @@ -377,7 +377,7 @@ components: callbackUri: description: > New value of the "callbackUri" attribute.The value "null" is not permitted. See note. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri" authentication: description: > New value of the "authentication" attribute, or "null" to remove the attribute. @@ -385,7 +385,7 @@ components: to the rules of JSONMerge PATCH (see IETF RFC 7396). This attribute shall not be present in response bodies. See note. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/SubscriptionAuthentication" #---------- @@ -438,7 +438,7 @@ components: Identifies a time boundary after which the reporting will stop. The boundary shall allow a single reporting as well as periodic reporting up to the boundary. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" ThresholdCriteria: description: > @@ -479,7 +479,7 @@ components: thresholdValue: description: > The threshold value. Shall be represented as a floating point number. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Number" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Number" hysteresis: description: > The hysteresis of the threshold. @@ -493,7 +493,7 @@ components: When processing a request to create a threshold, implementations should enforce a suitable minimum value for this attribute (e.g. override the value or reject the request). - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Number" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Number" required: - thresholdValue - hysteresis diff --git a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml index ce2cca6c1e55e3e2548c81744d1053edb9728f9b..7fd30cf2aa45e40cba980ffc1e54b19d4c1bca71 100644 --- a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml +++ b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml @@ -19,9 +19,8 @@ info: version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V3.6.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf - + description: ETSI GS NFV-SOL 009 V4.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/04.03.01_60/gs_NFV-SOL009v040301p.pdf servers: - url: http://127.0.0.1/callback/v2 - url: https://127.0.0.1/callback/v2 @@ -48,25 +47,25 @@ paths: "204": $ref: "#/components/responses/Notification.Post.204" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 get: description: > @@ -80,25 +79,25 @@ paths: "204": $ref: "#/components/responses/Notification.Get.204" "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 + $ref: ../responses/SOL009_resp.yaml#/responses/400 "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 + $ref: ../responses/SOL009_resp.yaml#/responses/401 "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 + $ref: ../responses/SOL009_resp.yaml#/responses/403 "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 + $ref: ../responses/SOL009_resp.yaml#/responses/404 "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 + $ref: ../responses/SOL009_resp.yaml#/responses/405 "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 + $ref: ../responses/SOL009_resp.yaml#/responses/406 "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 + $ref: ../responses/SOL009_resp.yaml#/responses/422 "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 + $ref: ../responses/SOL009_resp.yaml#/responses/500 "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 + $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 + $ref: ../responses/SOL009_resp.yaml#/responses/504 components: responses: @@ -152,8 +151,8 @@ components: application/json: schema: oneOf: - - $ref: "./components/NFVManoPerformanceManagementNotification_def.yaml#/components/schemas/PerformanceInformationAvailableNotification" - - $ref: "./components/NFVManoPerformanceManagementNotification_def.yaml#/components/schemas/ThresholdCrossedNotification" + - $ref: "./definitions/NFVManoPerformanceManagementNotification_def.yaml#/definitions/schemas/PerformanceInformationAvailableNotification" + - $ref: "./definitions/NFVManoPerformanceManagementNotification_def.yaml#/definitions/schemas/ThresholdCrossedNotification" required: true diff --git a/src/SOL009/NFVManoPerformanceManagementNotification/components/NFVManoPerformanceManagementNotification_def.yaml b/src/SOL009/NFVManoPerformanceManagementNotification/definitions/NFVManoPerformanceManagementNotification_def.yaml similarity index 77% rename from src/SOL009/NFVManoPerformanceManagementNotification/components/NFVManoPerformanceManagementNotification_def.yaml rename to src/SOL009/NFVManoPerformanceManagementNotification/definitions/NFVManoPerformanceManagementNotification_def.yaml index 4e4fefd6a8474f43fa3aec2914277ef746061ff5..e6720354230dff71a0e87be8ccc29e5b92850a7f 100644 --- a/src/SOL009/NFVManoPerformanceManagementNotification/components/NFVManoPerformanceManagementNotification_def.yaml +++ b/src/SOL009/NFVManoPerformanceManagementNotification/definitions/NFVManoPerformanceManagementNotification_def.yaml @@ -1,4 +1,4 @@ -components: +definitions: schemas: ThresholdCrossedNotification: description: > @@ -27,47 +27,47 @@ components: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to "ThresholdCrossedNotification" for this notification type. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/String" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/String" timeStamp: description: > Date and time of the generation of the notification. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" thresholdId: description: > Identifier of the threshold which has been crossed. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" crossingDirection: description: > An indication of whether the threshold was crossed in upward or downward direction. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/CrossingDirectionType" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/CrossingDirectionType" objectType: description: > Type of measured object.The applicable measured object type for a measurement is defined in clause 8.2 of ETSI GS NFV-IFA 031. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/String" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/String" objectInstanceId: description: > Identifier of the measured object instance. This attribute shall contain the identifier of the instance of the measure object according to their type. See also definitions in clause 8.2 of ETSI GS NFV-IFA 031 - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" subObjectInstanceId: description: > Identifier of the sub-object of the measured object to which the measurement applies. Shall be present if this is required in clause 8.2 of ETSI GS NFV-IFA 031 for the related measured object type. Shall be absent otherwise. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity" performanceMetric: description: > Performance metric associated with the threshold. This attribute shall contain the related "Measurement Name" value as defined in clause 8.4 of ETSI GS NFV-IFA 031 - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/String" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/String" performanceValue: description: > Value of the metric that resulted in threshold crossing. @@ -77,7 +77,7 @@ components: description: >- Measurement context information related to the measured value. The set of applicable keys is defined per measurement in clause 8.4 of ETSI GS NFV-IFA 031. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs" _links: description: > Links to resources related to this notification. @@ -88,11 +88,11 @@ components: Link to the resource representing the measured object instance to which the notified change applies. Shall be present if the measured object instance information is accessible as a resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" threshold: description: > Link to the resource that represents the threshold that was crossed. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" required: - objectInstance @@ -114,33 +114,33 @@ components: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to "PerformanceInformationAvailableNotification" for this notification type. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/String" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/String" timeStamp: description: > Date and time of the generation of the notification. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime" pmJobId: description: > Identifier of the PM job for which performance information is available. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" objectType: description: > Type of measured object. The applicable measured object type for a measurement is defined in clause 8.2 of ETSI GS NFV-IFA 031. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/String" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/String" objectInstanceId: description: > Type of measured object. The applicable measured object type for a measurement is defined in clause 8.2 of ETSI GS NFV-IFA 031 - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier" subObjectInstanceId: description: > Identifier of the sub-object of the measured object instance for which the @@ -148,7 +148,7 @@ components: set up to measure a sub-object instance of the measured object instance and a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031 for the related measured object type. Shall be absent otherwise. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity" _links: description: > Links to resources related to this notification. @@ -159,18 +159,18 @@ components: Link to the resource representing the measured object instance to which the notification applies. Shall be present if the measured object instance information is accessible as a resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" pmJob: description: > Link to the resource that represents the PM job for which performance information is available. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" PerformanceReport: description: > Link from which the available performance information of data type "PerformanceReport" can be obtained. This link should point to an "Individual performance report" resource. - $ref: "../../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink" required: - pmJob - performanceReport diff --git a/src/SOL009/components/SOL009_resp.yaml b/src/SOL009/components/__SOL009_resp.yaml similarity index 100% rename from src/SOL009/components/SOL009_resp.yaml rename to src/SOL009/components/__SOL009_resp.yaml diff --git a/src/SOL009/components/SOL009_schemas.yaml b/src/SOL009/components/__SOL009_schemas.yaml similarity index 100% rename from src/SOL009/components/SOL009_schemas.yaml rename to src/SOL009/components/__SOL009_schemas.yaml diff --git a/src/SOL009/definitions/SOL009_def.yaml b/src/SOL009/definitions/SOL009_def.yaml new file mode 100644 index 0000000000000000000000000000000000000000..53aca3ff0c14ee17547e479fd19b0c99470a7f25 --- /dev/null +++ b/src/SOL009/definitions/SOL009_def.yaml @@ -0,0 +1,666 @@ +definitions: + schemas: + Link: + description: > + This type represents a link to a resource using an absolute URI. + type: object + required: + - href + properties: + href: + description: > + URI of another resource referenced from a resource. + Shall be an absolute URI (i.e. a UTI that contains {apiRoot}). + $ref: "#/definitions/schemas/Uri" + + NotificationLink: + description: > + This type represents a link to a resource in a notification, using an absolute or relative URI. + type: object + required: + - href + properties: + href: + description: > + URI of a resource referenced from a notification. + Should be an absolute URI (i.e. a URI that contains + {apiRoot}), however, may be a relative URI (i.e. a URI + where the {apiRoot} part is omitted) if the {apiRoot} + information is not available. + $ref: "#/definitions/schemas/Uri" + + IpAddress: + description: > + An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal + integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that + consists of groups of zero to four hexadecimal digits, separated by colons. + type: string + format: IP + + KeyValuePairs: + description: > + This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, + a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 + of IETF RFC 8259. In the following example, a list of key-value pairs with four keys ("aString", "aNumber", + "anArray" and "anObject") is provided to illustrate that the values associated with different keys can be of + different type. + type: object + + ApiVersionInformation: + description: > + This type represents API version information. + type: object + required: + - uriPrefix + - apiVersions + properties: + uriPrefix: + description: > + Specifies the URI prefix for the API, in the following + form {apiRoot}/{apiName}/{apiMajorVersion}/. + type: string + apiVersions: + description: > + Version(s) supported for the API signaled by the + uriPrefix attribute. + type: array + items: + type: object + required: + - version + properties: + version: + description: > + Identifies a supported version. The value of the + version attribute shall be a version identifier as + specified in clause 9.1 (SOL013). + type: string + isDeprecated: + description: > + If such information is available, this attribute indicates + whether use of the version signaled by the version + attribute is deprecated (true) or not (false). + + A deprecated version is still supported by the API producer but is recommended + not to be used any longer. + When a version is no longer supported, it does not appear in the response body. + type: boolean + retirementDate: + description: > + The date and time after which the API version will no + longer be supported. + This attribute may be included if the value of the + isDeprecated attribute is set to true and shall be + absent otherwise. + $ref: "#/definitions/schemas/DateTime" + + Identifier: + description: > + An identifier with the intention of being globally unique. + type: string + + IdentifierInManoEntity: + description: > + An identifier that is unique for the respective type within a NFV-MANO functional entity, + but that need not be globally unique. Representation: string of variable length.. + type: string + + IdentifierLocal: + description: > + An identifier that is unique within a limited local scope other than above listed identifiers, + such as within a complex data structure or within a request-response pair. + Representation: string of variable length. + type: string + + DateTime: + description: > + Date-time stamp. + Representation: String formatted according to IETF RFC 3339. + type: string + format: date-time + + Uri: + description: > + String formatted according to IETF RFC 3986. + type: string + + Boolean: + description: > + The Boolean is a data type having two values (true and false). + type: boolean + + Version: + description: > + A version. + type: string + + String: + description: > + A string defined in IETF RFC 8259. + type: string + + Number: + description: > + A number defined in IETF RFC 8259. + type: number + + UnsignedInt: + description: > + Unsigned integer + type: number + + ManoManagedObjectReference: + description: > + This type represents the identifier to reference a managed object of a + particular type. + type: object + properties: + type: + description: > + Indicates the type of managed object. + Permitted values: + - MANO_ENTITY + - MANO_SERVICE + - MANO_SERVICE_IF + - CONSUMED_MANO_IF + - MANO_ENTITY_COMPONENT + + The "MANO_ENTITY COMPONENT" is only applicable if attribute + "manoEntityComponents" in "ManoEntity" is supported by the API producer. + type: string + enum: + - MANO_ENTITY + - MANO_SERVICE + - MANO_SERVICE_IF + - CONSUMED_MANO_IF + - MANO_ENTITY_COMPONENT + objectId: + description: > + Identifier of the managed object. + - If type="MANO_ENTITY", it corresponds to the value of the attribute "id" + of the "ManoEntity" representing an NFV-MANO functional entity. + - If type="MANO_SERVICE", it corresponds to the value of the attribute "id" + of the "ManoEntity" representing the NFV-MANO functional entity that contains + the "ManoService" sub-object. + - If type="MANO_SERVICE_IF", it corresponds to the value of the attribute "id" + of the "ManoServiceInterface" representing the NFV-MANO functional entity that + contains the "ManoServiceInterface" sub-object. + - If type="CONSUMED_MANO_IF", the value corresponds to the value of the attribute + "id" of the "ConsumedManoInterfaceInfo" representing a consumed NFV-MANO service + interface from a peer functional entity. + - If type="MANO_ENTITY_COMPONENT", the value corresponds to the value of + the attribute "id" of the "ManoEntity" representing the NFV-MANO functional + entity that contains the "ManoEntityComponent" sub-object. + + The "MANO_ENTITY COMPONENT" is only applicable if attribute + "manoEntityComponents" in "ManoEntity" is supported by the API producer. + $ref: "#/definitions/schemas/Identifier" + subObjectId: + description: > + Identifier of the managed sub-object. It shall be present if type equals to + "MANO_SERVICE" or "MANO_SERVICE_IF" or "MANO_ENTITY_COMPONENT". + - If type="MANO_SERVICE", it corresponds to the value of the attribute "id" + of the "ManoService" representing an individual NFV-MANO service. + - If type="MANO_SERVICE_IF", it corresponds to the value of the attribute "id" + of the "ManoServiceInterface" representing an individual NFV-MANO service + interface. + - If type="MANO_ENTITY_COMPONENT", it corresponds to the value of the attribute + "id" of the "ManoEntityComponent" representing an NFV-MANO functional entity + component. + + The "MANO_ENTITY COMPONENT" is only applicable if attribute + "manoEntityComponents" in "ManoEntity" is supported by the API producer. + $ref: "#/definitions/schemas/IdentifierInManoEntity" + required: + - type + - objectId + + SubscriptionAuthentication: + type: object + required: + - authType + properties: + authType: + description: > + Defines the types of Authentication / Authorization which the API + consumer is willing to accept when receiving a notification. + Permitted values: + * BASIC: In every HTTP request to the notification endpoint, use + HTTP Basic authentication with the client credentials. + * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the + notification endpoint, use an OAuth 2.0 Bearer token, obtained + using the client credentials grant type. + * TLS_CERT: Every HTTP request to the notification endpoint is sent + over a mutually authenticated TLS session, i.e. not only the + server is authenticated, but also the client is authenticated + during the TLS tunnel setup. + type: array + items: + type: string + enum: + - BASIC + - OAUTH2_CLIENT_CREDENTIALS + - TLS_CERT + paramsBasic: + description: > + Parameters for authentication/authorization using BASIC. + Shall be present if authType is "BASIC" and the contained + information has not been provisioned out of band. + Shall be absent otherwise. + type: object + properties: + userName: + description: > + Username to be used in HTTP Basic authentication. Shall be + present if it has not been provisioned out of band. + type: string + password: + description: > + Password to be used in HTTP Basic authentication. Shall be + present if it has not been provisioned out of band. + type: string + paramsOauth2ClientCredentials: + description: > + Parameters for authentication/authorization using + OAUTH2_CLIENT_CREDENTIALS. + Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the + contained information has not been provisioned out of band. + Shall be absent otherwise. + type: object + properties: + clientId: + description: > + Client identifier to be used in the access token request of the + OAuth 2.0 client credentials grant type. + Shall be present if it has not been provisioned out of band. + The clientId and clientPassword passed in a subscription shall + not be the same as the clientId and clientPassword that are used + to obtain authorization for API requests. Client credentials may + differ between subscriptions. The value of clientPassword should + be generated by a random process. + type: string + clientPassword: + description: > + Client password to be used in the access token request of the + OAuth 2.0 client credentials grant type. + Shall be present if it has not been provisioned out of band. + The clientId and clientPassword passed in a subscription shall + not be the same as the clientId and clientPassword that are used + to obtain authorization for API requests. Client credentials may + differ between subscriptions. The value of clientPassword should + be generated by a random process. + type: string + tokenEndpoint: + description: > + The token endpoint from which the access token can be obtained. + Shall be present if it has not been provisioned out of band. + $ref: "#/definitions/schemas/Uri" + + ManoEntitySubscriptionFilter: + description: > + This type represents subscription filter criteria to match NFV-MANO functional + entities and their associated managed objects. + type: object + properties: + manoEntityId: + description: > + If present, match the NFV-MANO functional entity with an + instance identifier listed in this attribute. + $ref: "#/definitions/schemas/Identifier" + manoServiceIds: + description: > + manoServiceIds IdentifierInManoEntity 0..N If present, match NFV-MANO + services with an instance identifier listed in this attribute. + + The attributes "manoServiceIds" and "manoServiceNames" are alternatives + to reference to NFV-MANO services in a filter. They should not be used + together in the same filter instance, but one alternative should be chosen. + type: array + items: + $ref: "#/definitions/schemas/IdentifierInManoEntity" + manoServiceNames: + description: > + If present, match NFV-MANO services with an NFV-MANO service name listed + in this attribute. + + The attributes "manoServiceIds" and "manoServiceNames" are alternatives + to reference to NFV-MANO services in a filter. They should not be used + together in the same filter instance, but one alternative should be chosen. + type: array + items: + type: string + manoServiceInterfaceIds: + description: > + If present, match NFV-MANO functional entity produced interfaces with an + instance identifier listed in this attribute. + + The attributes "manoServiceInterfaceIds" and "manoServiceInterfaceNames" + are alternatives to reference to NFV-MANO functional entity produced + interfaces in a filter. They should not be used both in the same filter + instance, but one alternative should be chosen. + type: array + items: + $ref: "#/definitions/schemas/IdentifierInManoEntity" + manoServiceInterfaceNames: + description: > + If present, match NFV-MANO functional entity produced interfaces with an + instance Name listed in this attribute. + + The attributes "manoServiceInterfaceIds" and "manoServiceInterfaceNames" + are alternatives to reference to NFV-MANO functional entity produced + interfaces in a filter. They should not be used both in the same filter + instance, but one alternative should be chosen. + type: array + items: + type: string + consumedManoInterfaceIds: + description: > + If present, match NFV-MANO functional entity consumed interfaces with an + instance identifier listed in this attribute. + + The attributes "consumedManoInterfaceIds" and "consumedManoInterfaceNames" + are alternatives to reference to NFV-MANO functional entity consumed + interfaces in a filter. They should not be used both in the same filter + instance, but one alternative should be chosen. + type: array + items: + $ref: "#/definitions/schemas/Identifier" + consumedManoInterfaceNames: + description: > + If present, match NFV-MANO functional entity consumed interfaces with an + instance Name listed in this attribute. + + The attributes "consumedManoInterfaceIds" and "consumedManoInterfaceNames" + are alternatives to reference to NFV-MANO functional entity consumed + interfaces in a filter. They should not be used both in the same filter + instance, but one alternative should be chosen. + type: array + items: + type: string + + CrossingDirectionType: + description: > + CrossingDirectionType enumeration. + Permited values: + - UP: The threshold was crossed in upward direction. + - DOWN : The threshold was crossed in downward direction. + type: string + enum: + - UP + - DOWN + + ProblemDetails: + description: > + The definition of the general "ProblemDetails" data structure from + IETF RFC 7807 [19] is reproduced inthis structure. Compared to the + general framework defined in IETF RFC 7807 [19], the "status" and + "detail" attributes are mandated to be included by the present document, + to ensure that the response contains additional textual information about + an error. IETF RFC 7807 [19] foresees extensibility of the + "ProblemDetails" type. It is possible that particular APIs in the present + document, or particular implementations, define extensions to define + additional attributes that provide more information about the error. + The description column only provides some explanation of the meaning to + Facilitate understanding of the design. For a full description, see + IETF RFC 7807 [19]. + type: object + required: + - status + - detail + properties: + type: + description: > + A URI reference according to IETF RFC 3986 [5] that identifies the + problem type. It is encouraged that the URI provides human-readable + documentation for the problem (e.g. using HTML) when dereferenced. + When this member is not present, its value is assumed to be + "about:blank". + type: string + format: URI + title: + description: > + A short, human-readable summary of the problem type. It should not + change from occurrence to occurrence of the problem, except for + purposes of localization. If type is given and other than + "about:blank", this attribute shall also be provided. + A short, human-readable summary of the problem + type. It SHOULD NOT change from occurrence to occurrence of the + problem, except for purposes of localization (e.g., using + proactive content negotiation; see [RFC7231], Section 3.4). + type: string + status: + description: > + The HTTP status code for this occurrence of the problem. + The HTTP status code ([RFC7231], Section 6) generated by the origin + server for this occurrence of the problem. + type: integer + detail: + description: > + A human-readable explanation specific to this occurrence of the + problem. + type: string + instance: + description: > + A URI reference that identifies the specific occurrence of the + problem. It may yield further information if dereferenced. + type: string + format: URI + #TODO: How to express "any additional attributes"? + + Alarm: + description: > + The alarm data type encapsulates information about an alarm. + type: object + required: + - id + - managedObjectId + - alarmRaisedTime + - ackState + - perceivedSeverity + - eventTime + - eventType + - probableCause + - isRootCause + - _links + properties: + id: + description: > + Identifier of this Alarm information element. + $ref: "#/definitions/schemas/Identifier" + managedObjectId: + description: > + Identifier of the affected NFV-MANO instance. + $ref: "#/definitions/schemas/Identifier" + associatedFaultyInstanceId: + description: > + The resources that are causing the fault. + $ref: "#/definitions/schemas/ManoManagedObjectReference" + alarmRaisedTime: + description: > + Time stamp indicating when the alarm is raised by the managed + object. + $ref: "#/definitions/schemas/DateTime" + alarmChangedTime: + description: > + Time stamp indicating when the alarm was last changed. It shall be + present if the alarm has been updated. + $ref: "#/definitions/schemas/DateTime" + alarmClearedTime: + description: > + Time stamp indicating when the alarm was cleared. It shall be + present if the alarm has been cleared. + $ref: "#/definitions/schemas/DateTime" + ackState: + description: > + Acknowledgement state of the alarm. + Permitted values: + * UNACKNOWLEDGED + * ACKNOWLEDGED. + type: string + enum: + - UNACKNOWLEDGED + - ACKNOWLEDGED + perceivedSeverity: + description: > + Perceived severity of the managed object failure. + $ref: "#/definitions/schemas/PerceivedSeverityType" + eventTime: + description: > + Time stamp indicating when the fault was observed. + $ref: "#/definitions/schemas/DateTime" + eventType: + description: > + Type of event. + $ref: "#/definitions/schemas/EventType" + faultType: + description: > + Additional information to clarify the type of the fault. + type: string + probableCause: + description: > + Information about the probable cause of the fault. + type: string + isRootCause: + description: > + Attribute indicating if this fault is the root for other correlated + alarms. If true, then the alarms listed in the attribute + CorrelatedAlarmId are caused by this fault. + type: boolean + correlatedAlarmIds: + description: > + List of identifiers of other alarms correlated to this fault. + type: array + items: + $ref: "#/definitions/schemas/Identifier" + faultDetails: + description: > + Provides additional information about the fault. + type: array + items: + type: string + _links: + description: > + Links for this resource. + type: object + required: + - self + properties: + self: + description: > + URI of this resource. + $ref: "#/definitions/schemas/Link" + objectInstance: + description: > + Link to the resource representing the VNF instance to which the + notified alarm is correlated. Shall be present if the VNF + instance information is accessible as a resource. + $ref: "#/definitions/schemas/Link" + + EventType: + description: > + The enumeration EventType represents those types of events that trigger + an alarm. + * COMMUNICATIONS_ALARM: An alarm of this type is associated with the + procedure and/or process required conveying information from one point + to another (ITU-T Recommendation X.733). + * PROCESSING_ERROR_ALARM: An alarm of this type is associated with a + software or processing fault (ITU-T Recommendation X.733). + * ENVIRONMENTAL_ALARM: An alarm of this type is associated with a + condition related to an enclosure in which the equipment resides + (ITU-T Recommendation X.733). + * QOS_ALARM: An alarm of this type is associated with degradation in the + quality of a service (ITU-T Recommendation X.733). + * EQUIPMENT_ALARM: An alarm of this type is associated with an equipment + fault (ITU-T Recommendation X.733). + type: string + enum: + - COMMUNICATIONS_ALARM + - PROCESSING_ERROR_ALARM + - ENVIRONMENTAL_ALARM + - QOS_ALARM + - EQUIPMENT_ALARM + + PerceivedSeverityType: + description: > + Indicates the relative level of urgency for operator attention. + * CRITICAL: The Critical severity level indicates that a service + affecting condition has occurred and an immediate corrective action + is required. Such a severity can be reported, for example, when a + managed object becomes totally out of service and its capability needs + to be restored (ITU-T Recommendation X.733). + * MAJOR: The Major severity level indicates that a service affecting + condition has developed and an urgent corrective action is required. + Such a severity can be reported, for example, when there is a severe + degradation in the capability of the managed object and its full + capability needs to be restored (ITU-T Recommendation X.733). + * MINOR: The Minor severity level indicates the existence of a + non-service affecting fault condition and that corrective action + should be taken in order to prevent a more serious (for example, + service affecting) fault. Such a severity can be reported, for + example, when the detected alarm condition is not currently degrading + the capacity of the managed object (ITU-T Recommendation X.733). + * WARNING: The Warning severity level indicates the detection of a + potential or impending service affecting fault, before any significant + effects have been felt. Action should be taken to further diagnose (if + necessary) and correct the problem in order to prevent it from + becoming a more serious service affecting fault (ITU-T Recommendation + X.733). + * INDETERMINATE: The Indeterminate severity level indicates that the + severity level cannot be determined (ITU-T Recommendation X.733). + * CLEARED: The Cleared severity level indicates the clearing of one or + more previously reported alarms. This alarm clears all alarms for this + managed object that have the same Alarm type, Probable cause and + Specific problems (if given) (ITU-T Recommendation X.733). + type: string + enum: + - CRITICAL + - MAJOR + - MINOR + - WARNING + - INDETERMINATE + - CLEARED + + AdministrativeStateEnumType: + description: > + The enumeration AdministrativeStateEnumType defines values representing + the administrative state of a managed entity. + The AdministrativeStateEnumType shall comply with the provisions: + - LOCKED The managed entity is administratively prohibited to be used. + - UNLOCKED The managed entity is administratively allowed to be used. + - LOCKING The managed entity is in the transition to be locked. + type: string + enum: + - LOCKED + - UNLOCKED + - LOCKING + + OperationalStateEnumType: + description: > + The enumeration OperationalStateEnumType defines values representing the + operational state of an NFV-MANO functional application type of managed entity. + The OperationalStateEnumType shall comply with the provisions: + - STARTED The managed entity is operational. + - STOPPED The managed entity is not operational. + - STOPPING The managed entity is in the transition to stop. + - STARTING The managed entity is in the transition to start and become operational. + - RESTARTING The managed entity is in the transition to stop and start again. + type: string + enum: + - STARTED + - STOPPED + - STOPPING + - STARTING + - RESTARTING + + ChangeStateOpOccStateEnumType: + description: > + The enumeration ChangeStateOpOccStateEnumType defines permitted values + for the change state operation. It shall comply with the provisions : + - PROCESSING The change state operation is currently in execution. + - COMPLETED The change state operation has been completed successfully. + - FAILED The change state operation has failed. + type: string + enum: + - PROCESSING + - COMPLETED + - FAILED diff --git a/src/SOL009/endpoints/SOL009_endpoints.yaml b/src/SOL009/endpoints/SOL009_endpoints.yaml index b71fe1e0a1dfd9d3132b482e7ed37f9b33cdc4bd..6170b2dac2c3d7f49366605e74772c27a6a04381 100644 --- a/src/SOL009/endpoints/SOL009_endpoints.yaml +++ b/src/SOL009/endpoints/SOL009_endpoints.yaml @@ -3,13 +3,6 @@ endpoints: api_versions: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: false - schema: - type: string - name: Authorization description: >- The authorization token for the request. Reference: IETF RFC 7235 @@ -33,7 +26,7 @@ endpoints: content: application/json: schema: - $ref: '../components/SOL009_schemas.yaml#/components/schemas/ApiVersionInformation' + $ref: '../definitions/SOL009_def.yaml#/definitions/schemas/ApiVersionInformation' headers: Content-Type: description: The MIME type of the body of the response. @@ -57,56 +50,56 @@ endpoints: maximum: 1 minimum: 1 400: - $ref: '../components/SOL009_resp.yaml#/components/responses/400' + $ref: '../responses/SOL009_resp.yaml#/responses/400' 401: - $ref: '../components/SOL009_resp.yaml#/components/responses/401' + $ref: '../responses/SOL009_resp.yaml#/responses/401' 403: - $ref: '../components/SOL009_resp.yaml#/components/responses/403' + $ref: '../responses/SOL009_resp.yaml#/responses/403' 404: - $ref: '../components/SOL009_resp.yaml#/components/responses/404' + $ref: '../responses/SOL009_resp.yaml#/responses/404' 406: - $ref: '../components/SOL009_resp.yaml#/components/responses/406' + $ref: '../responses/SOL009_resp.yaml#/responses/406' 413: - $ref: '../components/SOL009_resp.yaml#/components/responses/413' + $ref: '../responses/SOL009_resp.yaml#/responses/413' 414: - $ref: '../components/SOL009_resp.yaml#/components/responses/414' + $ref: '../responses/SOL009_resp.yaml#/responses/414' 416: - $ref: '../components/SOL009_resp.yaml#/components/responses/416' + $ref: '../responses/SOL009_resp.yaml#/responses/416' 422: - $ref: '../components/SOL009_resp.yaml#/components/responses/422' + $ref: '../responses/SOL009_resp.yaml#/responses/422' 429: - $ref: '../components/SOL009_resp.yaml#/components/responses/429' + $ref: '../responses/SOL009_resp.yaml#/responses/429' 500: - $ref: '../components/SOL009_resp.yaml#/components/responses/500' + $ref: '../responses/SOL009_resp.yaml#/responses/500' 503: - $ref: '../components/SOL009_resp.yaml#/components/responses/503' + $ref: '../responses/SOL009_resp.yaml#/responses/503' 504: - $ref: '../components/SOL009_resp.yaml#/components/responses/504' + $ref: '../responses/SOL009_resp.yaml#/responses/504' post: description: > This method is not supported. When this method is requested on this resource, the API producer shall return a "405 Method Not Allowed" response as defined in SOL013 clause 6.4. responses: 405: - $ref: '../components/SOL009_resp.yaml#/components/responses/405' + $ref: '../responses/SOL009_resp.yaml#/responses/405' put: description: > This method is not supported. When this method is requested on this resource, the API producer shall return a "405 Method Not Allowed" response as defined in SOL013 clause 6.4. responses: 405: - $ref: '../components/SOL009_resp.yaml#/components/responses/405' + $ref: '../responses/SOL009_resp.yaml#/responses/405' patch: description: > This method is not supported. When this method is requested on this resource, the API producer shall return a "405 Method Not Allowed" response as defined in SOL013 clause 6.4. responses: 405: - $ref: '../components/SOL009_resp.yaml#/components/responses/405' + $ref: '../responses/SOL009_resp.yaml#/responses/405' delete: description: > This method is not supported. When this method is requested on this resource, the API producer shall return a "405 Method Not Allowed" response as defined in SOL013 clause 6.4. responses: 405: - $ref: '../components/SOL009_resp.yaml#/components/responses/405' \ No newline at end of file + $ref: '../responses/SOL009_resp.yaml#/responses/405' \ No newline at end of file diff --git a/src/SOL009/responses/SOL009_resp.yaml b/src/SOL009/responses/SOL009_resp.yaml new file mode 100644 index 0000000000000000000000000000000000000000..5b43976370c15ef77a6e84e110cc9cdbb1768bfa --- /dev/null +++ b/src/SOL009/responses/SOL009_resp.yaml @@ -0,0 +1,657 @@ +responses: + 206: + description: > + 206 PARTIAL CONTENT + headers: + Content-Type: + description: > + The MIME type of the body of the response. + schema: + type: string + maximum: 1 + minimum: 1 + Content-Range: + description: > + The Content-Range response HTTP header indicates where in a full body message a partial message belongs. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 303: + description: > + 303 See Other + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + + 400: + description: > + 400 BAD REQUEST + + 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the + "ProblemDetails" structure to be returned. + + If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect + query parameters or the payload body contains a syntactically incorrect data structure), + the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, + and should include in the "detail" attribute more information about the source of the problem. + + If the response to a GET request which queries a container resource would be so big that the performance + of the API producer is adversely affected, and the API producer does not support paging for the affected resource, + it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include + in the "detail" attribute more information about the source of the problem. + + If there is an application error related to the client's input that cannot be easily mapped to any other + HTTP response code ("catch all error"), the API producer shall respond with this response code. + The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information + about the source of the problem. + + If the request contains a malformed access token, the API producer should respond with this response. + The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 + and IETF RFC 7235. The ProblemDetails structure may be provided. + + The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 + for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 401: + description: > + 401 UNAUTHORIZED + + If the request contains no access token even though one is required, or if the request contains an authorization + token that is invalid (e.g. expired or revoked), the API producer should respond with this response. + The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 + and IETF RFC 7235. The ProblemDetails structure may be provided. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 403: + description: > + 403 FORBIDDEN + + If the API consumer is not allowed to perform a particular request to a particular resource, + the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. + It should include in the "detail" attribute information about the source of the problem, + and may indicate how to solve it. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 404: + description: > + 404 NOT FOUND + + If the API producer did not find a current representation for the resource addressed by the URI passed + in the request or is not willing to disclose that one exists, it shall respond with this response code. + The "ProblemDetails" structure may be provided, including in the "detail" attribute information about + the source of the problem, e.g. a wrong resource URI variable. + + This response code is not appropriate in case the resource addressed by the URI is a container resource + which is designed to contain child resources, but does not contain any child resource at the time + the request is received. For a GET request to an existing empty container resource, a typical response + contains a 200 OK response code and a payload body with an empty array. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 405: + description: > + 405 METHOD NOT ALLOWED + + If a particular HTTP method is not supported for a particular resource, the API producer shall respond + with this response code. The "ProblemDetails" structure may be omitted. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 406: + description: > + 406 NOT ACCEPTABLE + + If the "Accept" HTTP header does not contain at least one name of a content type + that is acceptable to the API producer, the API producer shall respond with this + response code. The "ProblemDetails" structure may be omitted. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 409: + description: > + 409 CONFLICT + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 412: + description: > + 412 PRECONDITION FAILED + + Error: A precondition given in an HTTP request header is not fulfilled. + Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity. + The response body should 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. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 413: + description: > + 413 PAYLOAD TOO LARGE + + If the payload body of a request is larger than the amount of data the API producer is willing or able to process, + it shall respond with this response code, following the provisions in IETF RFC 7231 for the use + of the "Retry-After" HTTP header and for closing the connection. The "ProblemDetails" structure may be omitted. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 414: + description: > + 414 URI TOO LONG + + If the request URI of a request is longer than the API producer is willing or able to process, + it shall respond with this response code. This condition can e.g. be caused by passing long queries + in the request URI of a GET request. The "ProblemDetails" structure may be omitted. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 416: + description: > + 416 Range Not Satisfiable + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 422: + description: > + 422 UNPROCESSABLE ENTITY + + If the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data + cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond + with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" + attribute more information about the source of the problem. + + This error response code is only applicable for methods that have a request body. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 429: + description: > + 429 TOO MANY REQUESTS + + If the API consumer has sent too many requests in a defined period of time and the API producer is able + to detect that condition ("rate limiting"), the API producer shall respond with this response code, + following the provisions in IETF RFC 6585 [17] for the use of the "Retry-After" HTTP header. + The "ProblemDetails" structure shall be provided and shall include in the "detail" attribute more information + about the source of the problem. + + The period of time and allowed number of requests are configured within the API producer by means + outside the scope of the present document. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 500: + description: > + 500 INTERNAL SERVER ERROR + + If there is an application error not related to the client's input that cannot be easily mapped to any other + HTTP response code ("catch all error"), the API producer shall respond with this response code. + The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information + about the source of the problem. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 503: + description: > + 503 SERVICE UNAVAILABLE + + If the API producer encounters an internal overload situation of itself or of a system it relies on, + it should respond with this response code, following the provisions in IETF RFC 7231 for the use of + the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" + structure may be omitted. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" + + 504: + description: > + 504 GATEWAY TIMEOUT + + If the API producer encounters a timeout while waiting for a response from an upstream server + (i.e. a server that the API producer communicates with when fulfilling a request), it should respond + with this response code. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" \ No newline at end of file