From 123a54ffb401668c4f8afdd23165c1cfaea79d49 Mon Sep 17 00:00:00 2001 From: Muhammad Umair Zafar Date: Fri, 22 Nov 2024 06:59:56 +0000 Subject: [PATCH 1/2] update SOL009 OAS as per version 5.2.1 --- .42c/conf.yaml | 3 + src/SOL009/APIVersion/APIVersion.yaml | 4 +- ...ConfigurationAndInformationManagement.yaml | 134 +++++++++++++++++- ...igurationAndInformationManagement_def.yaml | 59 +++++++- ...nAndInformationManagementNotification.yaml | 6 +- .../NFVManoFaultManagement.yaml | 6 +- .../NFVManoFaultManagementNotification.yaml | 6 +- .../NFVManoLogManagement.yaml | 6 +- .../NFVManoLogManagementNotification.yaml | 6 +- .../NFVManoPerformanceManagement.yaml | 6 +- ...ManoPerformanceManagementNotification.yaml | 6 +- src/SOL009/components/__SOL009_schemas.yaml | 33 +++++ src/SOL009/definitions/SOL009_def.yaml | 33 +++++ 13 files changed, 273 insertions(+), 35 deletions(-) create mode 100644 .42c/conf.yaml diff --git a/.42c/conf.yaml b/.42c/conf.yaml new file mode 100644 index 0000000..c5ac58a --- /dev/null +++ b/.42c/conf.yaml @@ -0,0 +1,3 @@ +apis: + src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml: + alias: sol009-nfv-mano-configuration-an diff --git a/src/SOL009/APIVersion/APIVersion.yaml b/src/SOL009/APIVersion/APIVersion.yaml index abc3950..2425451 100644 --- a/src/SOL009/APIVersion/APIVersion.yaml +++ b/src/SOL009/APIVersion/APIVersion.yaml @@ -19,8 +19,8 @@ info: version: 1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V5.1.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.01.01_60/gs_nfv-sol009v050101p.pdf + description: ETSI GS NFV-SOL 009 V5.2.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.02.01_60/gs_nfv-sol009v050201p.pdf paths: /nfvmanocim/api_versions: diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index fa4450d..95cacb3 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 2.13.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.14.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V5.1.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.01.01_60/gs_nfv-sol009v050101p.pdf + description: ETSI GS NFV-SOL 009 V5.2.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.02.01_60/gs_nfv-sol009v050201p.pdf servers: - url: http://127.0.0.1/nfvmanocim/v2 @@ -677,6 +677,47 @@ paths: $ref: ../responses/SOL009_resp.yaml#/responses/503 "504": $ref: ../responses/SOL009_resp.yaml#/responses/504 + /peer_entities/{peerEntityId}/consumed_mano_interfaces/{consumedManoInterfaceId}/change_state: + parameters: + - $ref: "#/components/parameters/peerEntityId" + - $ref: "#/components/parameters/consumedManoInterfaceId" + post: + description: > + The POST method requests to change the state of the consumed NFV-MANO service interface. + This method shall follow the provisions specified in tables 5.5.15.3.1-1 and 5.5.15.3.1-2 for URI query parameters, + request and response data structures, and response codes. + The steps and conditions that apply as the result of successfully executing this method are specified in clause 5.7. + parameters: + - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" + - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" + - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" + requestBody: + $ref: "#/components/requestBodies/ChangeStateRequest" + responses: + "202": + $ref: "#/components/responses/ChangeConsumedNFVMANOInterfaceStateTask.Post.202" + "400": + $ref: ../responses/SOL009_resp.yaml#/responses/400 + "401": + $ref: ../responses/SOL009_resp.yaml#/responses/401 + "403": + $ref: ../responses/SOL009_resp.yaml#/responses/403 + "404": + $ref: ../responses/SOL009_resp.yaml#/responses/404 + "405": + $ref: ../responses/SOL009_resp.yaml#/responses/405 + "406": + $ref: ../responses/SOL009_resp.yaml#/responses/406 + "409": + $ref: "#/components/responses/ChangeConsumedNFVMANOInterfaceStateTask.Post.409" + "422": + $ref: ../responses/SOL009_resp.yaml#/responses/422 + "500": + $ref: ../responses/SOL009_resp.yaml#/responses/500 + "503": + $ref: ../responses/SOL009_resp.yaml#/responses/503 + "504": + $ref: ../responses/SOL009_resp.yaml#/responses/504 components: parameters: @@ -831,7 +872,14 @@ components: required: true schema: $ref: '../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' - + consumedManoInterfaceId: + name: consumedManoInterfaceId + in: path + description: > + Identifier of the individual consumed NFV-MANO service interface. + required: true + schema: + $ref: '../definitions/SOL009_def.yaml#/definitions/schemas/Identifier' requestBodies: ModifyManoEntityRequest: description: > @@ -909,6 +957,15 @@ components: $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/PeerEntityConfigModificationRequest" required: true + ChangeStateRequest: + description: > + Parameters for the change state operation, as defined in + clause 5.6.2.8. + content: + application/json: + schema: + $ref: "./definitions/NFVManoConfigurationAndInformationManagement_def.yaml#/definitions/schemas/ChangeStateRequest" + required: true responses: ManoEntity.Get.200: description: > @@ -1993,5 +2050,72 @@ components: application/json: schema: $ref: "../definitions/SOL009_def.yaml#/definitions/schemas/ProblemDetails" - + ChangeConsumedNFVMANOInterfaceStateTask.Post.202: + description: > + Shall be returned when the request has been + accepted for processing. + + The response body shall be empty. + + The HTTP response shall include a "Location" + HTTP header that contains the URI of the + newly-created "Individual change state + operation occurrence" resource corresponding + to the operation. + headers: + WWW-Authenticate: + description: > + Challenge if the corresponding HTTP request has not provided + authorization, or error details if the corresponding HTTP + request has provided an invalid authorization token. + schema: + type: string + Version: + description: > + Version of the API used in the response. + schema: + type: string + Location: + description: > + The resource URI of the created "Individual subscription" resource. + schema: + type: string + format: url + minimum: 1 + maximum: 1 + ChangeConsumedNFVMANOInterfaceStateTask.Post.409: + description: > + Shall be returned upon the following error: The + operation cannot be executed currently, due to + a conflict with the state of the resource. + + Typically, this is due to the fact that the + resource is in an incompatible state, or that + another change state operation is ongoing. + + The response body shall contain a + ProblemDetails structure, in which the "detail" + attribute shall convey more information about + the error. + headers: + WWW-Authenticate: + description: > + Challenge if the corresponding HTTP request has not provided + authorization, or error details if the corresponding HTTP + request has provided an invalid authorization token. + schema: + type: string + Version: + description: > + Version of the API used in the response. + schema: + type: string + Location: + description: > + The resource URI of the created "Individual subscription" resource. + schema: + type: string + format: url + minimum: 1 + maximum: 1 #callbacks: \ No newline at end of file diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/definitions/NFVManoConfigurationAndInformationManagement_def.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/definitions/NFVManoConfigurationAndInformationManagement_def.yaml index e009764..2366ee3 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/definitions/NFVManoConfigurationAndInformationManagement_def.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/definitions/NFVManoConfigurationAndInformationManagement_def.yaml @@ -3,6 +3,9 @@ definitions: ManoEntity: description: > This type represents an NFV-MANO functional entity. + NOTE: As of the current release of the present document the Certificate Management Function (CMF) is out of + scope of ETSI GS NFV 006 [i.3] however it is included in the present document with the rest of + NFV-MANO interoperability for the purpose of discovery only. * NOTE 1: It shall be present when "type" attribute is "NFVO", and it shall be absent in any other case. * NOTE 2: It shall be present when "type" attribute is "VNFM", and it shall be absent in any other case. * NOTE 3: It shall be present when "type" attribute is "VIM", and it shall be absent in any other case. @@ -15,6 +18,7 @@ definitions: * NOTE 9: It shall be present when "type" attribute is "CCM", and it shall be absent in any other case. * NOTE 10: It shall be present when "type" attribute is "MDAF", and it shall be absent in any other case. * NOTE 11: It shall be present when "type" attribute is "CMF", and it shall be absent in any other case. + * NOTE 12: It shall be present when "type" attribute is "IM", and it shall be absent in any other case. type: object required: - id @@ -141,6 +145,14 @@ definitions: description: > The information specific to a MDAF entity. See notes 4 and 10. $ref: "#/definitions/schemas/MdafSpecificInfo" + imSpecificInfo: + description: > + The information specific to a IM entity. See notes 4 and 12. + $ref: "#/definitions/schemas/ImSpecificInfo" + cmfSpecificInfo: + description: > + The information specific to an CMF entity. See notes 4 and 11. + $ref: "#/definitions/schemas/CmfSpecificInfo" _links: description: > @@ -380,20 +392,27 @@ definitions: ChangeStateRequest: description: > - This type represents request parameters for changing the state of a managed entity. + This type represents request parameters for changing the state of a managed entity. It shall comply with the provisions + defined in table 5.6.2.8-1. + NOTE: The ChangeStateRequest data type can be used for requesting operational and administrative state + changes on different types of managed entities, such as the NFV-MANO functional entity application and + NFV-MANO service interfaces, as indicated by the supported method request/response of a resource. + * NOTE 1: In the present document version, a request shall only include an operational state change (attribute "operationalStateChange") or an administrative state change request (attribute "administrativeStateChange"), but not both. * NOTE 2: The "stopType" shall only be provided when the "operationalStateAction" attribute is equal to "STOP" or "RESTART". The "gracefulStopTimeout" shall be absent when the "stopType" attribute is equal to "FORCEFUL", and may be provided otherwise. + * NOTE 3: In the present document version, a request shall only include an operational state change (attribute + "operationalStateChange") in case of changing the state of an NFV-MANO functional entity application + and/or specific NFV-MANO service iinterface. type: object properties: operationalStateChange: description: > - A change of operational state. Shall be present if the state change request - refers to the operational state. See note 1. - but not both. + A change of operational state shall be present if the state change request refers + to the operational state. See notes 1 and 3. type: object properties: operationalStateAction: @@ -1515,7 +1534,7 @@ definitions: This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1: The information to be provided in this attribute shall relate to the specification and its version. - For instance, "ETSI GS NFV-SOL 003 (V2.4.1)". + For instance, "ETSI GS NFV-SOL 003 (V5.2.1)". * NOTE 2: Due to the security sensitive information associated to the attribute, based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute's value. In case the API consumer is not allowed to read the value of the security @@ -1531,6 +1550,7 @@ definitions: - standardVersion - apiVersion - apiEndpoint + - administrativeState properties: name: description: > @@ -1592,6 +1612,10 @@ definitions: Security related information including credentials information if needed for consuming the API. See note 2. $ref: "#/definitions/schemas/ClientInterfaceSecurityInfo" + administrativeState: + description: > + Administrative state of the consumed NFV-MANO service interface. + $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType" CimNotificationsFilter: description: > @@ -2032,6 +2056,8 @@ definitions: "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). + "pom" Represents the "Policy Management" interface produced by a VIM (refer to IFA005 and IFA006). + "dafm" Represents the "Data Flow Mirroring 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). @@ -2062,6 +2088,8 @@ definitions: "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). + "cismwkldpm" Represents the "OS container workload performance management" service interface produced by a CISM (refer to IFA040). + "cismwkldfm" Represents the "OS container workload fault management" service interface produced by a CISM (refer to IFA040). "cismcisim" Represents the "CIS instance management" service interface produced by a CISM (refer to IFA036). "cismcismccom" Represents the "CIS MCCO management" service interface produced by a CISM (refer to IFA036). "cirimgm" Represents the "OS container image management" service interface produced by a CIR (refer to IFA040). @@ -2071,9 +2099,10 @@ definitions: "ccmcisccm" Represents the "CIS cluster configuration management" service interface produced by a CCM (refer to IFA036). "ccmciscsm" Represents the "CIS cluster security management" service interface produced by a CCM (refer to IFA036). "mdafda" Represents the "Data analytics" service interface produced by a MDAF (refer to IFA047). + "imim" Represents the "Intent Management" service interface produced by a Intent Management (refer to IFA050). NOTE: "IFA005", "IFA006", "IFA007", "IFA008", "IFA013", "IFA032", "IFA040", "IFA036", "IFA037" are used as a shorthand for the specifications ETSI GS NFV-IFA 005, ETSI GS NFV-IFA 006, ETSI GS NFV-IFA 007, ETSI GS NFV IFA 008, ETSI GS NFV-IFA 013, - ETSI GS NFV-IFA 032 and ETSI GS NFV-IFA 040, ETSI GS NFV-IFA 036 and ETSI GS NFV-IFA 047 respectively. + ETSI GS NFV-IFA 032, ETSI GS NFV-IFA 040, ETSI GS NFV-IFA 036, ETSI GS NFV-IFA 047 and ETSI GS NFV-IFA 050 respectively. type: string UsageStateEnumType: @@ -2155,6 +2184,7 @@ definitions: - CCM The NFV-MANO functional entity is a CCM. - MDAF The NFV-MANO functional entity is a MDAF. - CMF The NFV-MANO functional entity is a CMF. + - IM The NFV-MANO functional entity is a Intent Management. type: string enum: - NFVO @@ -2166,6 +2196,7 @@ definitions: - CCM - MDAF - CMF + - IM PeerEntityEnumType: description: > @@ -2181,6 +2212,7 @@ definitions: - CCM The NFV-MANO functional entity is a CCM. - MDAF The peer functional entity is a MDAF. - CMF The peer functional entity is a CMF. + - IM The peer functional entity is a Intent Management. - EM The peer functional entity is an EM. - OSS The peer functional entity is an OSS/BSS. type: string @@ -2194,7 +2226,20 @@ definitions: - CCM - MDAF - CMF + - IM - EM - OSS - + ImSpecificInfo: + description: > + This type represents information attributes specific to a IM entity, and that can be relevant to more than one NFV + MANO service offered by a IM entity. It shall comply with the provisions defined in table 5.6.3.19-1. + type: object + required: + - supportedIntentObjectTypes + properties: + supportedIntentObjectTypes: + type: array + minItems: 1 + items: + type: string \ No newline at end of file diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml index adfcb39..470da1c 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 2.13.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.14.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V5.1.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.01.01_60/gs_nfv-sol009v050101p.pdf + description: ETSI GS NFV-SOL 009 V5.2.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.02.01_60/gs_nfv-sol009v050201p.pdf servers: - url: http://127.0.0.1/callback/v2 diff --git a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml index 05c1812..188db8b 100644 --- a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml +++ b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V5.1.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.01.01_60/gs_nfv-sol009v050101p.pdf + description: ETSI GS NFV-SOL 009 V5.2.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.02.01_60/gs_nfv-sol009v050201p.pdf servers: - url: http://127.0.0.1/nfvmanofm/v1 diff --git a/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml b/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml index 0815161..4555ec8 100644 --- a/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml +++ b/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V5.1.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.01.01_60/gs_nfv-sol009v050101p.pdf + description: ETSI GS NFV-SOL 009 V5.2.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.02.01_60/gs_nfv-sol009v050201p.pdf servers: - url: http://127.0.0.1/callback/v1 diff --git a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml index 24cfe41..4f61e91 100644 --- a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml +++ b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V5.1.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.01.01_60/gs_nfv-sol009v050101p.pdf + description: ETSI GS NFV-SOL 009 V5.2.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.02.01_60/gs_nfv-sol009v050201p.pdf servers: - url: http://127.0.0.1/nfvmanologm/v1 diff --git a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml index 4a107a4..25d5c6b 100644 --- a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml +++ b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V5.1.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.01.01_60/gs_nfv-sol009v050101p.pdf + description: ETSI GS NFV-SOL 009 V5.2.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.02.01_60/gs_nfv-sol009v050201p.pdf servers: - url: http://127.0.0.1/callback/v1 diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index 14fa052..ee57a16 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -17,11 +17,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V5.1.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.01.01_60/gs_nfv-sol009v050101p.pdf + description: ETSI GS NFV-SOL 009 V5.2.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.02.01_60/gs_nfv-sol009v050201p.pdf servers: - url: http://127.0.0.1/nfvmanopm/v2 diff --git a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml index 4ba7d5f..931397e 100644 --- a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml +++ b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 009 V5.1.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.01.01_60/gs_nfv-sol009v050101p.pdf + description: ETSI GS NFV-SOL 009 V5.2.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/05.02.01_60/gs_nfv-sol009v050201p.pdf servers: - url: http://127.0.0.1/callback/v2 diff --git a/src/SOL009/components/__SOL009_schemas.yaml b/src/SOL009/components/__SOL009_schemas.yaml index 8b08080..badff57 100644 --- a/src/SOL009/components/__SOL009_schemas.yaml +++ b/src/SOL009/components/__SOL009_schemas.yaml @@ -470,6 +470,12 @@ components: managedObjectId: description: > Identifier of the affected NFV-MANO instance. + The managed objects will be NFV-MANO functional + entities. An NFV-MANO functional entity can have + fault monitored sub-object types and identification + information is carried as defined in the respective + Alarm definition as defined in clause 7.8 of ETSI GS + NFV-IFA 04 $ref: "#/components/schemas/Identifier" associatedFaultyInstanceId: description: > @@ -503,6 +509,10 @@ components: perceivedSeverity: description: > Perceived severity of the managed object failure. + Valid values applicable to specific Alarms are + specified as "Perceived severity" values of the Alarm + applicable to NFV-MANO functional entities, as + defined in clause 7.8 of ETSI GS NFV-IFA 045 [17] $ref: "#/components/schemas/PerceivedSeverityType" eventTime: description: > @@ -511,14 +521,27 @@ components: eventType: description: > Type of event. + Valid values applicable to specific Alarms are + specified as "Event type " values of the Alarm + applicable to NFV-MANO functional entities, as + defined in clause 7.8 of ETSI GS NFV-IFA 045 [17]. $ref: "#/components/schemas/EventType" faultType: description: > Additional information to clarify the type of the fault. + Valid values applicable to specific Alarms are + specified as "Alarm definition identifier" values of the + Alarm applicable to NFV-MANO functional entities, + as defined in clause 7.8 of ETSI GS NFV-IFA 045 + [17]. type: string probableCause: description: > Information about the probable cause of the fault. + Valid values applicable to specific Alarms are + specified as "Probable cause" values of the Alarm + applicable to NFV-MANO functional entities, as + defined in clause 7.8 of ETSI GS NFV-IFA 045 [17]. type: string isRootCause: description: > @@ -535,6 +558,10 @@ components: faultDetails: description: > Provides additional information about the fault. + Valid values applicable to specific Alarms are + specified as "Fault details" values of the Alarm + applicable to NFV-MANO functional entities, as + defined in clause 7.8 of ETSI GS NFV-IFA 045 [17]. type: array items: type: string @@ -628,11 +655,17 @@ components: - 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. + - SUSPENDED The managed entity is administratively prohibited from use, including for current objects managed by the managed entity. + - SUSPENDING The managed entity is in the transition to be suspended. + - RESUMING The managed entity is in the transition to be resumed. type: string enum: - LOCKED - UNLOCKED - LOCKING + - SUSPENDED + - SUSPENDING + - RESUMING OperationalStateEnumType: description: > diff --git a/src/SOL009/definitions/SOL009_def.yaml b/src/SOL009/definitions/SOL009_def.yaml index 53aca3f..a961acd 100644 --- a/src/SOL009/definitions/SOL009_def.yaml +++ b/src/SOL009/definitions/SOL009_def.yaml @@ -470,6 +470,12 @@ definitions: managedObjectId: description: > Identifier of the affected NFV-MANO instance. + The managed objects will be NFV-MANO functional + entities. An NFV-MANO functional entity can have + fault monitored sub-object types and identification + information is carried as defined in the respective + Alarm definition as defined in clause 7.8 of ETSI GS + NFV-IFA 04 $ref: "#/definitions/schemas/Identifier" associatedFaultyInstanceId: description: > @@ -503,6 +509,10 @@ definitions: perceivedSeverity: description: > Perceived severity of the managed object failure. + Valid values applicable to specific Alarms are + specified as "Perceived severity" values of the Alarm + applicable to NFV-MANO functional entities, as + defined in clause 7.8 of ETSI GS NFV-IFA 045 [17] $ref: "#/definitions/schemas/PerceivedSeverityType" eventTime: description: > @@ -511,14 +521,27 @@ definitions: eventType: description: > Type of event. + Valid values applicable to specific Alarms are + specified as "Event type " values of the Alarm + applicable to NFV-MANO functional entities, as + defined in clause 7.8 of ETSI GS NFV-IFA 045 [17]. $ref: "#/definitions/schemas/EventType" faultType: description: > Additional information to clarify the type of the fault. + Valid values applicable to specific Alarms are + specified as "Alarm definition identifier" values of the + Alarm applicable to NFV-MANO functional entities, + as defined in clause 7.8 of ETSI GS NFV-IFA 045 + [17]. type: string probableCause: description: > Information about the probable cause of the fault. + Valid values applicable to specific Alarms are + specified as "Probable cause" values of the Alarm + applicable to NFV-MANO functional entities, as + defined in clause 7.8 of ETSI GS NFV-IFA 045 [17]. type: string isRootCause: description: > @@ -535,6 +558,10 @@ definitions: faultDetails: description: > Provides additional information about the fault. + Valid values applicable to specific Alarms are + specified as "Fault details" values of the Alarm + applicable to NFV-MANO functional entities, as + defined in clause 7.8 of ETSI GS NFV-IFA 045 [17]. type: array items: type: string @@ -628,11 +655,17 @@ definitions: - 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. + - SUSPENDED The managed entity is administratively prohibited from use, including for current objects managed by the managed entity. + - SUSPENDING The managed entity is in the transition to be suspended. + - RESUMING The managed entity is in the transition to be resumed. type: string enum: - LOCKED - UNLOCKED - LOCKING + - SUSPENDED + - SUSPENDING + - RESUMING OperationalStateEnumType: description: > -- GitLab From 8b9069d9b0d72b46b1727fb3a50f340790a15f4c Mon Sep 17 00:00:00 2001 From: Muhammad Umair Zafar Date: Mon, 9 Dec 2024 11:39:45 +0000 Subject: [PATCH 2/2] update the version of Readme file from 5.1.1 to 5.2.1 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4872e9c..4a83dd8 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 v5.1.1, RESTful protocols +This repository contains OpenAPIs for ETSI GS NFV-SOL 009 v5.2.1, RESTful protocols specification for the management of NFV-MANO functional entities. **IMPORTANT: In case of discrepancies the published ETSI Group Specification takes precedence.** -- GitLab