From ba37251b3fe08315ff3a91c3c1558c25f5f530c2 Mon Sep 17 00:00:00 2001 From: Giacomo Bernini Date: Fri, 30 Oct 2020 12:58:42 +0100 Subject: [PATCH 01/50] updated readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 96f827b..ead3abd 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # NFV SOL009 - OpenAPIs for the management of NFV-MANO -This repository contains OpenAPIs for ETSI GS NFV-SOL 009, RESTful protocols +This repository contains OpenAPIs for ETSI GS NFV-SOL 009 v3.5.1, RESTful protocols specification for the management of NFV-MANO. -**IMPORTANT: In case of discrepancies the published ETSI Group Specification takes precedence.** +**IMPORTANT: These [OpenAPI](https://www.openapis.org/) specifications are in development phase. In case of discrepancies the published ETSI Group Specification takes precedence.** More information at [NFV Solutions wiki](https://nfvwiki.etsi.org/index.php?title=NFV_Solutions). -- GitLab From d269ffbe2684ebf86d64bf1978822726563843f8 Mon Sep 17 00:00:00 2001 From: Sana Zulfiqar Date: Mon, 16 Nov 2020 10:36:52 +0100 Subject: [PATCH 02/50] SOL009_3: Attribute "clockSyncsDeleteIds" is deleted. --- .../NFVManoConfigurationAndInformationManagement.yaml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index c1a385c..2757eb6 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -1007,14 +1007,6 @@ components: type: array items: $ref: "#/components/schemas/ClockSyncInfo" - clockSyncsDeleteIds: - description: > - If present, this attribute signals modifications of certain entries in - "clockSyncs" attribute in "ManoEntityConfigurableParams", as defined - in clause 5.6.2.3. - type: array - items: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier" defaultLogCompileBySizeValue: description: > If present, this attribute signals modifications of the -- GitLab From c38b896b71a6dc4bdeee4ed36c5a2f37cdf6b61e Mon Sep 17 00:00:00 2001 From: Sana Zulfiqar Date: Mon, 16 Nov 2020 10:41:25 +0100 Subject: [PATCH 03/50] SOL009_6: Attribute "clockSyncsDeleteIds" is deleted --- .../NFVManoConfigurationAndInformationManagement.yaml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index 2757eb6..fbf1f50 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -934,14 +934,6 @@ components: type: array items: $ref: "#/components/schemas/ClockSyncInfo" - clockSyncsDeleteIds: - description: > - List of identifiers entries to be deleted from the "clockSyncs" - attribute array in the "ManoEntityConfigurableParams", as defined - below this table. - type: array - items: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier" defaultLogCompileBySizeValue: description: > New value of the "defaultLogCompileBySizeValue" attribute in the -- GitLab From 2715fffb875c46232809ef3d4567db3a39247afd Mon Sep 17 00:00:00 2001 From: Sana Zulfiqar Date: Mon, 16 Nov 2020 11:04:25 +0100 Subject: [PATCH 04/50] SOL009_10: Attribute "consumedManoInterfaceDeleteIds" is deleted. --- .../NFVManoConfigurationAndInformationManagement.yaml | 7 ------- 1 file changed, 7 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index fbf1f50..4fba5ac 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -1631,13 +1631,6 @@ components: type: array items: $ref: "#/components/schemas/ConsumedManoInterfaceInfo" - consumedManoInterfaceDeleteIds: - description: > - List of identifiers entries to be deleted from the "consumedManoInterfaces" - attribute array in the " PeerEntity ", as defined below this table. - type: array - items: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier" operationalState: description: > New content of the "operationalState" attribute in the "peerEntityState" -- GitLab From c6d58b1b8ba51b7dc86471f1082bd6892aa7491d Mon Sep 17 00:00:00 2001 From: Sana Zulfiqar Date: Mon, 16 Nov 2020 11:07:35 +0100 Subject: [PATCH 05/50] SOL009_13: Attribute "consumedManoInterfaceDeleteIds" is deleted. --- .../NFVManoConfigurationAndInformationManagement.yaml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index 4fba5ac..2c8c971 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -1678,14 +1678,6 @@ components: type: array items: $ref: "#/components/schemas/ConsumedManoInterfaceInfo" - consumedManoInterfaceDeleteIds: - description: > - If present, this attribute signals the deletions of certain entries in the - "consumedManoInterfaces" attribute in "PeerEntity", as defined in - clause 5.6.2.15. - type: array - items: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier" operationalState: description: > If present, this attribute signals modifications of the "operationalState" -- GitLab From 3154f9636de42fccfff62f3492fbe924047f7513 Mon Sep 17 00:00:00 2001 From: Sana Zulfiqar Date: Tue, 17 Nov 2020 10:56:51 +0100 Subject: [PATCH 06/50] Sol009_16: Attribute "id" is removed from ClockSyncInfo --- .../NFVManoConfigurationAndInformationManagement.yaml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index 2c8c971..6716f6c 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -2089,11 +2089,6 @@ components: This type represents parameters for connecting to an NTP server. type: object properties: - id: - description: > - The identifier of the clock synchronization information entry. - This identifier is managed by the API consumer. - $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier" type: description: > Type of clock synchronization. @@ -2131,7 +2126,6 @@ components: May be present if type = "OTHER". $ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" required: - - id - type ServerInterfaceSecurityInfo: -- GitLab From b53498600b5b02771088d01780dee908c01a4347 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Tue, 24 Nov 2020 13:59:58 +0100 Subject: [PATCH 07/50] SOL009_1: New response added --- ...ConfigurationAndInformationManagement.yaml | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index 6716f6c..c02cbbe 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -3180,6 +3180,42 @@ components: format: url minimum: 1 maximum: 1 + subscriptions.post.422: + description: > + 422 Unprocessable Entity + + Shall be returned upon the following error: The content type + of the payload body is supported and the payload body of a request + contains syntactically correct data but the data cannot be processed. + + The general cause for this error and its handling is specified in + clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence + of the response body. + + Specifically in case of this resource, the response code 422 shall also + be returned if the API producer has tested the Notification endpoint as + described in clause 5.5.6.3.2 and the test has failed. + + In this case, the "detail" attribute in the "ProblemDetails" structure + 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 + content: + application/json: + schema: + $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + subscriptions.get.200: description: > 200 OK -- GitLab From 9fa26caad63279e1494ea42c2d5f5b6c6fe5d786 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 05:51:51 +0100 Subject: [PATCH 08/50] SOL009_2: clocksyncs datatype updated --- .../NFVManoConfigurationAndInformationManagement.yaml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index c02cbbe..1995d96 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -929,10 +929,11 @@ components: type: string clockSyncs: description: > - New content of certain entries in the "clockSyncs" attribute array in - the "ManoEntityConfigurableParams", as defined below this table. - type: array - items: + Modifications of the "clockSyncs" attribute in the "ManoEntityConfigurableParams". + If present, these modifications shall be applied according to the rules of JSON Merge PATCH + (see IETF RFC 7396). + type: object + additionalProperties: $ref: "#/components/schemas/ClockSyncInfo" defaultLogCompileBySizeValue: description: > -- GitLab From ece8ef73c6a70c0271167738b2f49f80bb12951e Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 06:01:45 +0100 Subject: [PATCH 09/50] SOL009_5: clocksyncs datatype updated --- .../NFVManoConfigurationAndInformationManagement.yaml | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index 1995d96..dffdc32 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -992,13 +992,12 @@ components: If present, this attribute signals modifications of the "description" attribute in "ManoEntity", as defined in clause 5.6.2.3. type: string - clockSyncs: + clockSyncs: description: > - If present, this attribute signals modifications of the "clockSyncs" - attribute in "ManoEntityConfigurableParams", as defined in - clause 5.6.2.3. - type: array - items: + If present, this attribute signals modifications of the "clockSyncs" attribute in + "ManoEntityConfigurableParams", as defined in clause 5.6.2.3. + type: object + additionalProperties: $ref: "#/components/schemas/ClockSyncInfo" defaultLogCompileBySizeValue: description: > -- GitLab From fec03599f941afd04d81eb0dbe0ae1954bdf8a31 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 06:13:29 +0100 Subject: [PATCH 10/50] SOL009_7: consumedManoInterfaces datatype changed --- .../NFVManoConfigurationAndInformationManagement.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index dffdc32..11e0616 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -1506,10 +1506,10 @@ components: type: string consumedManoInterfaces: description: > - Information of the interface consumed by the NFV-MANO functional entity + Initial information of the interface consumed by the NFV-MANO functional entity from the peer functional entity. - type: array - items: + type: object + additionalProperties: $ref: "#/components/schemas/ConsumedManoInterfaceInfo" peerEntityState: description: > -- GitLab From 6102c2d6ea162742be6c96b88df1faf50fdaf83b Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 06:24:55 +0100 Subject: [PATCH 11/50] SOL009_8: consumedManoInterfaces datatype and description changed --- .../NFVManoConfigurationAndInformationManagement.yaml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index 11e0616..2525b87 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -1573,8 +1573,12 @@ components: from the peer functional entity. This attribute can be modified with the PATCH method. - type: array - items: + + The keys of the map, each of which identifies information about a particular + consumed NFV-MANO interface, are managed by the API consumer and referenced + from other data structures via the "consumedManoInterfaceIds" attribute. + type: object + additionalProperties: $ref: "#/components/schemas/ConsumedManoInterfaceInfo" peerEntityState: description: > -- GitLab From 0f5741ab4c363a3b8259037f015b2083361b0271 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 06:30:51 +0100 Subject: [PATCH 12/50] SOL009_9: consumedManoInterfaces datatype and description changed --- .../NFVManoConfigurationAndInformationManagement.yaml | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index 2525b87..e3e5c18 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -1621,8 +1621,11 @@ components: type: string consumedManoInterfaces: description: > - New content of certain entries in the "consumedManoInterfaces" attribute - array in the "PeerEntity", as defined below this table. + Modification of the "consumedManoInterfaces" attribute + in the "PeerEntity", as defined below this table. + + If present, these modifications shall be applied according to the rules of + JSON Merge PATCH (see IETF RFC 7396). NOTE: Due to the security sensitive information contained within the attribute (refer to "securityInfo" within the "ConsumedManoInterfaceInfo"), based on @@ -1632,8 +1635,8 @@ components: attribute, and the modification request includes new attribute values, the whole modification request shall be rejected, and proper error information returned. - type: array - items: + type: object + additionalProperties: $ref: "#/components/schemas/ConsumedManoInterfaceInfo" operationalState: description: > -- GitLab From 43f39757dfd7a348455acf65d409e914ac5968e6 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 06:34:22 +0100 Subject: [PATCH 13/50] SOL009_12: consumedManoInterfaces datatype and description changed --- .../NFVManoConfigurationAndInformationManagement.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index e3e5c18..c0ffdad 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -1671,7 +1671,7 @@ components: type: string consumedManoInterfaces: description: > - If present, this attribute signals modifications of certain entries in + If present, this attribute signals modifications of the "consumedManoInterfaces" attribute in "PeerEntity", as defined in clause 5.6.2.15. @@ -1682,8 +1682,8 @@ components: In case the API consumer is not allowed to read the value of the security sensitive attribute, the attribute shall be omitted when the information is to be provided in a response message. - type: array - items: + type: object + additionalProperties: $ref: "#/components/schemas/ConsumedManoInterfaceInfo" operationalState: description: > -- GitLab From 35359e6049b1100dd8d1f0b5a4ab557f2f2739a1 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 06:41:31 +0100 Subject: [PATCH 14/50] SOL009_14: attribute clockSyncs datatype and description changed --- .../NFVManoConfigurationAndInformationManagement.yaml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index c0ffdad..ac3ab79 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -1951,8 +1951,11 @@ components: description: Properties of the clock synchronization to be used by the NFV-MANO functional entity. - type: array - items: + + The keys of the map, each of which identifies a particular ClockSyncInfo + structure, are managed by the API consumer. + type: object + additionalProperties: $ref: "#/components/schemas/ClockSyncInfo" minItems: 1 defaultLogCompileBySizeValue: -- GitLab From 0109361d160082f32d41f579320581ce717992d0 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 06:52:07 +0100 Subject: [PATCH 15/50] SOL009_15: attribute id is removed from ConsumedManoInterfaceInfo --- .../NFVManoConfigurationAndInformationManagement.yaml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index ac3ab79..4b4d95e 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -1977,11 +1977,6 @@ components: functional entity from another peer functional entity. type: object properties: - id: - description: > - Identifier of the consumed NFV-MANO interface. This identifier is - managed by the API consumer. - $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier" name: description: > Human-readable name of the NFV-MANO interface. -- GitLab From f36ad3633b97ebe491a4b2c99212b8a82905c9ed Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 07:08:36 +0100 Subject: [PATCH 16/50] SOL009_25: In POST, new response added --- .../NFVManoPerformanceManagement.yaml | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index 777443a..79d8336 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -1028,6 +1028,42 @@ components: application/json: schema: $ref: "#/components/schemas/PmJob" + pm_jobs.post.422: + description: > + 422 Unprocessable Entity + + Shall be returned upon the following error: The content type + of the payload body is supported and the payload body of a request + contains syntactically correct data but the data cannot be processed. + + The general cause for this error and its handling is specified in + clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence + of the response body. + + Specifically in case of this resource, the response code 422 shall also + be returned if the API producer has tested the Notification endpoint as + described in clause 5.5.6.3.2 and the test has failed. + + In this case, the "detail" attribute in the "ProblemDetails" structure + 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 + content: + application/json: + schema: + $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + pm_jobs.get.200: description: > 200 OK -- GitLab From 80ae4b222ca62c5c8d1d9aaa7fa2bd43d8099988 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 07:14:54 +0100 Subject: [PATCH 17/50] SOL009_27: In POST, new response added --- .../NFVManoPerformanceManagement.yaml | 38 ++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index 79d8336..19c2517 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -1042,7 +1042,7 @@ components: Specifically in case of this resource, the response code 422 shall also be returned if the API producer has tested the Notification endpoint as - described in clause 5.5.6.3.2 and the test has failed. + described in clause 6.5.10.3.2 and the test has failed. In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information about the error. @@ -1258,6 +1258,42 @@ components: application/json: schema: $ref: "#/components/schemas/Threshold" + thresholds.post.422: + description: > + 422 Unprocessable Entity + + Shall be returned upon the following error: The content type + of the payload body is supported and the payload body of a request + contains syntactically correct data but the data cannot be processed. + + The general cause for this error and its handling is specified in + clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence + of the response body. + + Specifically in case of this resource, the response code 422 shall also + be returned if the API producer has tested the Notification endpoint as + described in clause 6.5.10.3.2 and the test has failed. + + In this case, the "detail" attribute in the "ProblemDetails" structure + 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 + content: + application/json: + schema: + $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + thresholds.get.200: description: > 200 OK -- GitLab From 1c7f81127a55ec942bbadc4ae3ce45c48b7c81c6 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 07:26:07 +0100 Subject: [PATCH 18/50] SOL009_29&_30: Sections removed --- .../NFVManoPerformanceManagement.yaml | 212 ------------------ 1 file changed, 212 deletions(-) diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index 19c2517..721ef1c 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -1409,192 +1409,6 @@ components: schema: type: string - subscriptions.post.201: - description: > - 201 CREATED - - Shall be returned when the subscription has been created successfully. - - A representation of the created subscription resource shall be returned - in the response body, as defined in clause 6.6.2.3. - - The HTTP response shall include a "Location" HTTP header that contains - the resource URI of the created "Individual subscription" resource. - 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 change state - operation occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - $ref: "#/components/schemas/PmSubscription" - subscriptions.post.303: - description: > - 303 SEE OTHER - - Shall be returned when a subscription with the same callbackURI and - the same filter already exists and the policy of the NFV-MANO functional - entity is to not create redundant subscriptions. - - The HTTP response shall include a "Location" HTTP header that contains - the resource URI of the existing "Individual subscription" resource. - - The response body shall be empty. - headers: - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - 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 change state - operation occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - subscriptions.get.200: - description: > - Shall be returned when the list of subscriptions has been queried - successfully. - - The response body shall contain in an array the representations - of all active subscriptions of the functional block that invokes - the method, i.e. zero or more representations of PM subscriptions - as defined in clause 6.6.2.3. - - If the "filter" URI parameter was supplied in the request, the data - in the response body shall have been transformed according to the - rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - - If the NFV-MANO functional entity supports alternative 2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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 - content: - application/json: - schema: - type: array - items: - $ref: "#/components/schemas/PmSubscription" - subscriptions.get.400: - description: > - 400 BAD REQUEST - - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - 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 - content: - application/json: - schema: - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - - subscription.get.200: - description: > - 200 OK - - Shall be returned when the subscription has been read successfully. - - The response body shall contain a representation of the - "Individual subscription" resource, as defined in clause 6.6.2.3. - 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 - content: - application/json: - schema: - $ref: "#/components/schemas/PmSubscription" - subscription.delete.204: - description: > - 204 NO CONTENT - - Shall be returned when the "Individual subscription" resource has - been deleted successfully. - - The response body shall be empty. - headers: - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - schema: - type: string - Version: - description: > - Version of the API used in the response. - schema: - type: string - parameters: filter.PmJob : @@ -1631,23 +1445,6 @@ components: required: false schema: type: string - filter.PmSubscription : - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the PmSubscription and in data - types referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string exclude_default.PmJob : name: exclude_default description: > @@ -1665,15 +1462,6 @@ components: schema: type: string - subscriptionId: - name: subscriptionId - in: path - description: >- - Identifier of the subscription - required: true - schema: - $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' - pmJobId: name: pmJobId in: path -- GitLab From f2dafb6170163662b4881a66646f3ffe846a2b12 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 07:39:28 +0100 Subject: [PATCH 19/50] SOL009_32&_33: Data structures removed --- .../NFVManoPerformanceManagement.yaml | 70 ------------------- 1 file changed, 70 deletions(-) diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index 721ef1c..51d64ac 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -471,67 +471,6 @@ paths: components: schemas: - PmSubscriptionRequest: - description: > - This type represents a subscription request. - type: object - properties: - 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/PmNotificationsFilter" - callbackUri: - description: > - The URI of the endpoint to send the notification to. - $ref: "../components/SOL009_schemas.yaml#/components/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" - required: - - callbackUri - - PmSubscription: - description: > - This type represents a subscription. - type: object - properties: - id: - description: > - Identifier that identifies the subscription - $ref: "../components/SOL009_schemas.yaml#/components/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/PmNotificationsFilter" - callbackUri: - description: > - The URI of the endpoint to send the notification to. - type: object - properties: - links: - description: > - Links to resources related to this resource. - $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri" - self: - description: > - URI of this resource. - $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link" - required: - - links - - self - required: - - id - - callbackUri - CreatePmJobRequest: description: > This type represents a request to create a PM job. @@ -1506,13 +1445,4 @@ components: application/json: schema: $ref: "#/components/schemas/CreateThresholdRequest" - required: true - - CreateSubscriptionRequest: - description: > - Details of the subscription to be created. - content: - application/json: - schema: - $ref: "#/components/schemas/PmSubscriptionRequest" required: true \ No newline at end of file -- GitLab From f8be105ec7aed7b4bf8f6e65523e3b8d47217376 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 07:46:33 +0100 Subject: [PATCH 20/50] SOL009_34: ThresholdCrossedNotification updated --- .../NFVManoPerformanceManagementNotification.yaml | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml index f86ad37..d812ab6 100644 --- a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml +++ b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml @@ -180,10 +180,6 @@ components: Discriminator for the different notification types. Shall be set to "ThresholdCrossedNotification" for this notification type. $ref: "../components/SOL009_schemas.yaml#/components/schemas/String" - subscriptionId: - description: > - Identifier of the subscription that this notification relates to. - $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier" timeStamp: description: > Date and time of the generation of the notification. @@ -234,10 +230,6 @@ components: Links to resources related to this notification. type: object properties: - subscription: - description: > - Link to the related subscription. - $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" objectInstance: description: > Link to the resource representing the measured object instance to which @@ -249,12 +241,10 @@ components: Link to the resource that represents the threshold that was crossed. $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" required: - - subscription - objectInstance required: - id - notificationType - - subscriptionId - timeStamp - thresholdId - crossingDirection -- GitLab From 83e2d7f009789f5e601ec3364c96bd0b23a4ba0f Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 07:54:31 +0100 Subject: [PATCH 21/50] SOL009_35: PerformanceInformationAvailableNotification updated --- .../NFVManoPerformanceManagementNotification.yaml | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml index d812ab6..eca3414 100644 --- a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml +++ b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml @@ -271,14 +271,14 @@ components: Shall be set to "PerformanceInformationAvailableNotification" for this notification type. $ref: "../components/SOL009_schemas.yaml#/components/schemas/String" - subscriptionId: - description: > - Identifier of the subscription that this notification relates to. - $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier" timeStamp: description: > Date and time of the generation of the notification. $ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime" + pmJobId: + description: > + Identifier of the PM job for which performance information is available. + $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier" objectType: description: > Type of measured object. @@ -304,10 +304,6 @@ components: Links to resources related to this notification. type: object properties: - subscription: - description: > - Link to the related subscription. - $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" objectInstance: description: > Link to the resource representing the measured object instance to which the @@ -326,13 +322,12 @@ components: This link should point to an "Individual performance report" resource. $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" required: - - subscription - pmJob - performanceReport required: - id - notificationType - - subscriptionId + - pmJobId - timeStamp - objectType - objectInstanceId -- GitLab From b9ce6080c96154fb908987fbf9a21c13f46174b5 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 08:11:57 +0100 Subject: [PATCH 22/50] SOL009_36: Attributes added in CreatePmJobRequest --- .../NFVManoPerformanceManagement.yaml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index 51d64ac..d20c79a 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -511,10 +511,24 @@ components: description: > Criteria of the collection of performance information. $ref: "#/components/schemas/PmJobCriteria" + callbackUri: + description: > + The URI of the endpoint to send the notification to. + $ref: "../components/SOL009_schemas.yaml#/components/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" required: - objectType - objectInstanceIds - criteria + - callbackUri PmJob: description: > -- GitLab From 3f1d35ea7947335aac646e80c72684fe8c1552cf Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 08:14:47 +0100 Subject: [PATCH 23/50] SOL009_37: Attributes added in PmJob --- .../NFVManoPerformanceManagement.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index d20c79a..ae7ac8f 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -572,6 +572,10 @@ components: description: > Criteria of the collection of performance information. $ref: "#/components/schemas/PmJobCriteria" + callbackUri: + description: > + The URI of the endpoint to send the notification to. + $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri" reports: description: > Information about available reports collected by this PM job. @@ -623,6 +627,7 @@ components: - objectInstanceIds - criteria - _links + - callbackUri CreateThresholdRequest : description: > -- GitLab From 959ffab5fe128a457f0a65f549e4ccc19446d0b1 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 08:16:51 +0100 Subject: [PATCH 24/50] SOL009_38: Attributes added in CreateThresholdRequest --- .../NFVManoPerformanceManagement.yaml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index ae7ac8f..54d36e1 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -662,10 +662,24 @@ components: description: > Criteria that define this threshold. $ref: "#/components/schemas/ThresholdCriteria" + callbackUri: + description: > + The URI of the endpoint to send the notification to. + $ref: "../components/SOL009_schemas.yaml#/components/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" required: - objectType - objectInstanceId - criteria + - callbackUri Threshold: description: > -- GitLab From df011b85516e4598fb9a2d2270bf495b54f9fbce Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 08:18:49 +0100 Subject: [PATCH 25/50] SOL009_39: Attributes added in Threshold --- .../NFVManoPerformanceManagement.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index 54d36e1..13eb143 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -718,6 +718,10 @@ components: description: > Criteria that define this threshold. $ref: "#/components/schemas/ThresholdCriteria" + callbackUri: + description: > + The URI of the endpoint to send the notification to. + $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri" _links: description: > Links for this resource. @@ -742,6 +746,7 @@ components: - subjObjectInstanceIds - criteria - _links + - callbackUri PerformanceReport: description: > -- GitLab From cd8af7fef175547740eef99f900e257cdc2c74ba Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 08:34:14 +0100 Subject: [PATCH 26/50] SOL009_40&_41: New DataTypes added --- .../NFVManoPerformanceManagement.yaml | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index 13eb143..d945ad3 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -820,6 +820,54 @@ components: required: - entries + PmJobModifications: + description: > + This type represents modifications to a PM job. + type: object + properties: + callbackUri: + description: > + New value of the "callbackUri" attribute.The value "null" is not permitted. + + NOTE: At least one of the attributes defined in this type + shall be present in request bodies. + $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri" + authentication: + description: > + New value of the "authentication" attribute, or "null" to remove the attribute. + If present in a request body, these modifications shall be applied according + to the rules of JSONMerge PATCH (see IETF RFC 7396). + + This attribute shall not be present in response bodies. + + NOTE: At least one of the attributes defined in this type + shall be present in request bodies.. + $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication" + + ThresholdModifications: + description: > + This type represents modifications to a threshold. + type: object + properties: + callbackUri: + description: > + New value of the "callbackUri" attribute.The value "null" is not permitted. + + NOTE: At least one of the attributes defined in this type + shall be present in request bodies. + $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri" + authentication: + description: > + New value of the "authentication" attribute, or "null" to remove the attribute. + If present in a request body, these modifications shall be applied according + to the rules of JSONMerge PATCH (see IETF RFC 7396). + + This attribute shall not be present in response bodies. + + NOTE: At least one of the attributes defined in this type + shall be present in request bodies.. + $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication" + #---------- PmNotificationsFilter: -- GitLab From a858caeefd6f3f736b3e2082e4215a30f19f87c0 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 08:38:02 +0100 Subject: [PATCH 27/50] SOL009_43: PmNotificationsFilter datatype removed --- .../NFVManoPerformanceManagement.yaml | 30 ------------------- 1 file changed, 30 deletions(-) diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index d945ad3..f24fcde 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -870,36 +870,6 @@ components: #---------- - PmNotificationsFilter: - description: > - This type represents a filter that can be used to subscribe for notifications - related to performance management events. - At a particular nesting level in the filter structure, the following applies: - All attributes shall match in order for the filter to match (logical "and" between - different filter attributes). If an attribute is an array, the attribute shall - match if at least one of the values in the array matches (logical "or" between the - values of one filter attribute). - type: object - properties: - pmSubscriptionFilter: - description: > - Filter criteria to select object instance about which to notify. - $ref: "../components/SOL009_schemas.yaml#/components/schemas/ManoEntitySubscriptionFilter" - notificationTypes: - description: > - Match particular notification types. - Permitted values: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - - The permitted values of the "notificationTypes" attribute are spelled exactly - as the names of the notification types to facilitate automated code generation - systems. - type: string - enum: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - PmJobCriteria: description: > This type represents collection criteria for PM jobs. -- GitLab From ce473aa03f65e7490f4916cdce8b644768eb6320 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 08:43:06 +0100 Subject: [PATCH 28/50] Paths removed for Subscriptions --- .../NFVManoPerformanceManagement.yaml | 134 ------------------ 1 file changed, 134 deletions(-) diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index f24fcde..8eca1a3 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -335,140 +335,6 @@ paths: "504": $ref: ../components/SOL009_resp.yaml#/components/responses/504 - /subscriptions: - post: - description: > - The POST method creates a new subscription. - 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/CreateSubscriptionRequest" - responses: - "201": - $ref: "#/components/responses/subscriptions.post.201" - "303": - $ref: "#/components/responses/subscriptions.post.303" - "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 - "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 - "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 - "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 - "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 - "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 - "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 - "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 - "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 - "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 - get: - description: > - The client can use this method to query the list of active subscriptions - to performance management notifications subscribed by the client. - parameters: - - $ref: "#/components/parameters/filter.PmSubscription" - - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker" - - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" - - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" - responses: - "200": - $ref: "#/components/responses/subscriptions.get.200" - "400": - $ref: "#/components/responses/subscriptions.get.400" - "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 - "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 - "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 - "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 - "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 - "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 - "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 - "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 - "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 - - /subscriptions/{subscriptionId}: - parameters: - - $ref: "#/components/parameters/subscriptionId" - get: - description: > - The client can use this method for reading an individual subscription - about performance management notifications subscribed by the client. - 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" - responses: - "200": - $ref: "#/components/responses/subscription.get.200" - "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 - "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 - "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 - "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 - "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 - "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 - "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 - "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 - "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 - "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 - delete: - description: > - This method terminates an individual subscription. - 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" - responses: - "204": - $ref: "#/components/responses/subscription.delete.204" - "400": - $ref: ../components/SOL009_resp.yaml#/components/responses/400 - "401": - $ref: ../components/SOL009_resp.yaml#/components/responses/401 - "403": - $ref: ../components/SOL009_resp.yaml#/components/responses/403 - "404": - $ref: ../components/SOL009_resp.yaml#/components/responses/404 - "405": - $ref: ../components/SOL009_resp.yaml#/components/responses/405 - "406": - $ref: ../components/SOL009_resp.yaml#/components/responses/406 - "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 - "500": - $ref: ../components/SOL009_resp.yaml#/components/responses/500 - "503": - $ref: ../components/SOL009_resp.yaml#/components/responses/503 - "504": - $ref: ../components/SOL009_resp.yaml#/components/responses/504 - components: schemas: CreatePmJobRequest: -- GitLab From 57fd3c5affc9a731599dd74e9c1bfb6d1344b2ef Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 08:52:33 +0100 Subject: [PATCH 29/50] SOL009_44: In POST, new response body added --- .../NFVManoFaultManagement.yaml | 70 +++++++++++++++++++ 1 file changed, 70 insertions(+) diff --git a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml index b53416a..5f1c6ed 100644 --- a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml +++ b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml @@ -606,6 +606,76 @@ components: application/json: schema: $ref: "#/components/schemas/FmSubscription" + subscriptions.post.303: + description: > + 303 SEE OTHER + + SShall be returned when a subscription with the same + callbackURI and the same filter already exists and the + policy of NFV-MANO functional entity is to not create + redundant subscriptions. + + The HTTP response shall include a "Location" HTTP header + that contains the resource URI of the existing "Individual + subscription" resource. + + The response body shall be empty. + headers: + WWW-Authenticate: + description: > + Challenge if the corresponding HTTP request has not provided + authorization, or error details if the corresponding HTTP + request has provided an invalid authorization token. + 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 + subscriptions.post.422: + description: > + 422 Unprocessable Entity + + Shall be returned upon the following error: The content type + of the payload body is supported and the payload body of a request + contains syntactically correct data but the data cannot be processed. + + The general cause for this error and its handling is specified in + clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence + of the response body. + + Specifically in case of this resource, the response code 422 shall also + be returned if the API producer has tested the Notification endpoint as + described in clause 7.5.7.3.2 and the test has failed. + + In this case, the "detail" attribute in the "ProblemDetails" structure + 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 + content: + application/json: + schema: + $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" subscriptions.get.200: description: > -- GitLab From 6dbdb4b7159f1e1479bf841b59f5dff061baee2f Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 08:58:47 +0100 Subject: [PATCH 30/50] SOL009_45: In POST, new response body added --- .../NFVManoLogManagement.yaml | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml index e1a4f35..ee22461 100644 --- a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml +++ b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml @@ -684,6 +684,42 @@ components: schema: $ref: "#/components/schemas/LogReport" + subscriptions.post.422: + description: > + 422 Unprocessable Entity + + Shall be returned upon the following error: The content type + of the payload body is supported and the payload body of a request + contains syntactically correct data but the data cannot be processed. + + The general cause for this error and its handling is specified in + clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence + of the response body. + + Specifically in case of this resource, the response code 422 shall also + be returned if the API producer has tested the Notification endpoint as + described in clause 8.5.9.3.2 and the test has failed. + + In this case, the "detail" attribute in the "ProblemDetails" structure + 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 + content: + application/json: + schema: + $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + LogReportCompiled.Post.202: description: >- Shall be returned when the request has been accepted for processing, and it is expected to take some -- GitLab From 11d634b6a92bc38487931b42b861de1b3be44250 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 30 Nov 2020 13:33:04 +0100 Subject: [PATCH 31/50] SOL009_47,_48,_49: Description updated --- .../NFVManoPerformanceManagementNotification.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml index eca3414..46dbdcb 100644 --- a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml +++ b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml @@ -32,13 +32,13 @@ paths: description: > This resource represents a notification endpoint for NFV-MANO performance management. The API producer can use this resource to send notifications related to performance - management events to a subscribed API consumer, which has provided the URI of this - resource during the subscription process. + management events to an API consumer, which has provided the URI of this + resource during the PM jobor threshold creation process. post: description: > The POST method delivers a notification regarding a performance management event from the API producer to an API consumer. The API consumer shall have previously - created an "Individual subscription" resource with a matching filter. + created an " Individual PM job resource" or "Individual threshold resource". parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -72,7 +72,7 @@ paths: get: description: > The GET method allows the server to test the notification endpoint that is - provided by the client, e.g. during subscription. + provided by the client, e.g. during creation of the PM job or threshold. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" -- GitLab From 18b6bc4ad94dbc924e2a1a2a1d894de1f033bd76 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Tue, 1 Dec 2020 08:32:24 +0100 Subject: [PATCH 32/50] SOL009_27: PATCH implemented --- .../NFVManoPerformanceManagement.yaml | 141 ++++++++++++++++++ 1 file changed, 141 insertions(+) diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index 8eca1a3..02fc1c6 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -304,6 +304,45 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/503 "504": $ref: ../components/SOL009_resp.yaml#/components/responses/504 + patch: + description: > + This method allows to modify an "Individual threshold" resource. + This method shall follow the provisions specified in the tables + 6.5.7.3.4-1 and 6.5.7.3.4-2 for URI query parameters, request and + response data structures, and response codes + 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/ThresholdModificationRequest" + responses: + "200": + $ref: "#/components/responses/threshold.patch.200" + "412": + $ref: "#/components/responses/threshold.patch.412" + "422": + $ref: "#/components/responses/threshold.patch.422" + "400": + $ref: ../components/SOL009_resp.yaml#/components/responses/400 + "401": + $ref: ../components/SOL009_resp.yaml#/components/responses/401 + "403": + $ref: ../components/SOL009_resp.yaml#/components/responses/403 + "404": + $ref: ../components/SOL009_resp.yaml#/components/responses/404 + "405": + $ref: ../components/SOL009_resp.yaml#/components/responses/405 + "406": + $ref: ../components/SOL009_resp.yaml#/components/responses/406 + "409": + $ref: ../components/SOL009_resp.yaml#/components/responses/409 + "500": + $ref: ../components/SOL009_resp.yaml#/components/responses/500 + "503": + $ref: ../components/SOL009_resp.yaml#/components/responses/503 + "504": + $ref: ../components/SOL009_resp.yaml#/components/responses/504 delete: description: > This method allows to delete a threshold. @@ -1249,6 +1288,96 @@ components: application/json: schema: $ref: "#/components/schemas/Threshold" + + threshold.patch.200: + description: > + 200 OK + + Shall be returned when the request has been processed successfully. + + The response body shall contain a data structure of type "ThresholdModifications" + 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 + content: + application/json: + schema: + $ref: "#/components/schemas/ThresholdModifications" + threshold.patch.412: + description: > + 412 PRECONDITION FAILED + + Shall be returned upon the following 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: + 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 + content: + application/json: + schema: + $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + threshold.patch.422: + description: > + 422 Unprocessable Entity + + Shall be returned upon the following error: The content type + of the payload body is supported and the payload body of a request + contains syntactically correct data but the data cannot be processed. + + The general cause for this error and its handling is specified in + clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence + of the response body. + + Specifically in case of this resource, the response code 422 shall also + be returned if the API producer has tested the Notification endpoint as + described in clause 6.5.10.3.2 and the test has failed. + + In this case, the "detail" attribute in the "ProblemDetails" structure + 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 + content: + application/json: + schema: + $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + threshold.delete.204: description: > 204 NO CONTENT @@ -1367,4 +1496,16 @@ components: application/json: schema: $ref: "#/components/schemas/CreateThresholdRequest" + required: true + + ThresholdModificationRequest: + description: > + Parameters for the threshold modification. + + The Content-Type header shall be set to "application/merge-patch+json" + according to IETF RFC 7396. + content: + application/merge-patch+json: + schema: + $ref: "#/components/schemas/ThresholdModifications" required: true \ No newline at end of file -- GitLab From 0fe04713252ec2041236b4c574d7f7e548727e8c Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Tue, 1 Dec 2020 08:58:43 +0100 Subject: [PATCH 33/50] SOL009_26: PATCH implemented --- .../NFVManoPerformanceManagement.yaml | 140 ++++++++++++++++++ 1 file changed, 140 insertions(+) diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index 02fc1c6..9c9bda7 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -138,6 +138,46 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/503 "504": $ref: ../components/SOL009_resp.yaml#/components/responses/504 + patch: + description: > + This method allows to modify an "individual PM job" resource. + + This method shall follow the provisions specified in the tables 6.5.4.3.4-1 + and 6.5.4.3.4-2 for URI query parameters, request and response data structures, + and response codes. + 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/PmJobModificationRequest" + responses: + "200": + $ref: "#/components/responses/threshold.patch.200" + "412": + $ref: "#/components/responses/threshold.patch.412" + "422": + $ref: "#/components/responses/threshold.patch.422" + "400": + $ref: ../components/SOL009_resp.yaml#/components/responses/400 + "401": + $ref: ../components/SOL009_resp.yaml#/components/responses/401 + "403": + $ref: ../components/SOL009_resp.yaml#/components/responses/403 + "404": + $ref: ../components/SOL009_resp.yaml#/components/responses/404 + "405": + $ref: ../components/SOL009_resp.yaml#/components/responses/405 + "406": + $ref: ../components/SOL009_resp.yaml#/components/responses/406 + "409": + $ref: ../components/SOL009_resp.yaml#/components/responses/409 + "500": + $ref: ../components/SOL009_resp.yaml#/components/responses/500 + "503": + $ref: ../components/SOL009_resp.yaml#/components/responses/503 + "504": + $ref: ../components/SOL009_resp.yaml#/components/responses/504 delete: description: > This method terminates an individual PM job. @@ -1071,6 +1111,94 @@ components: application/json: schema: $ref: "#/components/schemas/PmJob" + pm_job.patch.200: + description: > + 200 OK + + Shall be returned when the request has been processed successfully. + + The response body shall contain a data structure of type "PmJobModifications" + 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 + content: + application/json: + schema: + $ref: "#/components/schemas/PmJobModifications" + pm_job.patch.412: + description: > + 412 PRECONDITION FAILED + + Shall be returned upon the following 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: + 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 + content: + application/json: + schema: + $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" + pm_job.patch.422: + description: > + 422 Unprocessable Entity + + Shall be returned upon the following error: The content type + of the payload body is supported and the payload body of a request + contains syntactically correct data but the data cannot be processed. + + The general cause for this error and its handling is specified in + clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence + of the response body. + + Specifically in case of this resource, the response code 422 shall also + be returned if the API producer has tested the Notification endpoint as + described in clause 6.5.10.3.2 and the test has failed. + + In this case, the "detail" attribute in the "ProblemDetails" structure + 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 + content: + application/json: + schema: + $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" pm_job.delete.204: description: > 204 NO CONTENT @@ -1508,4 +1636,16 @@ components: application/merge-patch+json: schema: $ref: "#/components/schemas/ThresholdModifications" + required: true + + PmJobModificationRequest: + description: > + Parameters for the PM job modification. + + The Content-Type header shall be set to "application/merge-patch+json" + according to IETF RFC 7396. + content: + application/merge-patch+json: + schema: + $ref: "#/components/schemas/PmJobModifications" required: true \ No newline at end of file -- GitLab From 91303a57787f6d376b45d4d19a4cb09583ec8aed Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Mon, 26 Apr 2021 01:29:12 +0200 Subject: [PATCH 34/50] SOL009_50 -> SOL009_54: added new attributes and datatype --- ...ConfigurationAndInformationManagement.yaml | 82 ++++++++++++++++++- 1 file changed, 79 insertions(+), 3 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index 4b4d95e..c9fde3c 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -886,6 +886,16 @@ components: specific type of NFV-MANO functional entity is specified by the manoServices attribute. $ref: "#/components/schemas/VimSpecificInfo" + wimSpecificInfo: + description: > + The information specific to a WIM entity. See notes 4 and 6. + + NOTE 4: The information about the NFV-MANO services offered by a + specific type of NFV-MANO functional entity is specified by the + manoServices attribute. + NOTE 6: It shall be present when "type" attribute is "WIM", + and it shall be absent in any other case. + $ref: "#/components/schemas/wimSpecificInfo" _links: description: > Links to resources related to this resource. @@ -1156,7 +1166,7 @@ components: administrativeStateAction: description: > The desired administrative state to change the managed object to. - $ref: "#/components/schemas/ChangeAdministrativeStateEnumType" + type: required: - administrativeStateAction @@ -1940,7 +1950,69 @@ components: and that can be relevant to more than one NFV-MANO service offered by a VIM entity. type: object - + + WimSpecificInfo: + description: > + This type represents information attributes specific to a WIM entity, + and that can be relevant to more than one NFV MANO service offered by + a WIM entity. + type: object + properties: + maxMscsNums: + description: > + Maximum number of MSCS that the WIM can manage. + type: object + properties: + numMscs: + description: > + Maximum number of MSCS. + type: integer + criteriaNumMscs: + description: > + Reference criteria for derivation/computation of the referred + maximum number of MSCS in attribute "numMscs". + $ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" + required: + - numMscs + maxMsncNum: + description: > + Maximum number of MSNC that the WIM can manage + type: object + properties: + numMsnc: + description: > + Maximum number of MSNC.. + type: integer + criteriaNumMsnc: + description: > + Reference criteria for derivation/computation of the referred maximum + number of MSNC in attribute "numMsnc". + $ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" + required: + - numMsnc + mscsLayerProtocolSupport: + description: > + List of protocols of particular layers used to realize an MSCS + that are supported by the WIM. + + Permitted values: + - EVPN_BGP_MPLS: L2 MSCS realized by BGP MPLS-based Ethernet VPN (EVPN) as specified in IETF RFC 7432. + - EVPN_VPWS: L2 MSCS realized by EVPN Virtual Private Wire Service (VPWS) as specified in IETF RFC 8214. + - VPLS_BGP: L2 MSCS realized by Virtual Private LAN Service (VPLS) using BGP as specified + in IETF RFC 4761 and IETF RFC. + - VPLS_LDP_L2TP: L2 MSCS realized by VPLS using Label Distribution Protocol (LDP) Layer 2 + Tunnelling Protocol (L2TP) as specified in IETF RFC 4762 and IETF RFC 6074. + - VPWS_LDP_L2TP: L2 MSCS realized by VPWS using LDP L2TP as specified in IETF RFC 6074. + - BGP_IP_VPN: L3 MSCS realized by BGP/MPLS based IP VPN as specified in IETF RFC 4364. + type: string + enum: + - EVPN_BGP_MPLS + - EVPN_VPWS + - VPLS_BGP + - VPLS_LDP_L2TP + - VPWS_LDP_L2TP + - BGP_IP_VPN + ManoEntityConfigurableParams: description: > This type represents list of parameters that can be configured on the @@ -2405,12 +2477,14 @@ components: the provisions : - NFVO The NFV-MANO functional entity is an NFVO. - VNFM The NFV-MANO functional entity is a VNFM. - - VIM The NFV-MANO functional entity is a VIM. + - VIM The NFV-MANO functional entity is a VIM. + - WIM The NFV-MANO functional entity is a WIM. type: string enum: - NFVO - VNFM - VIM + - WIM PeerEntityEnumType: description: > @@ -2423,6 +2497,7 @@ components: - WIM The peer functional entity is a WIM. - EM The peer functional entity is an EM. - OSS The peer functional entity is an OSS/BSS. + - WIM The peer functional is a WIM. type: string enum: - NFVO @@ -2431,6 +2506,7 @@ components: - WIM - EM - OSS + - WIM parameters: -- GitLab From fcb77db5b5d0fc008f2b863b50896e8bb3a03fa3 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Thu, 6 May 2021 10:27:39 +0200 Subject: [PATCH 35/50] added note and data type references for NFVManoCIM --- ...ConfigurationAndInformationManagement.yaml | 644 +++++++----------- ...nAndInformationManagementNotification.yaml | 12 +- 2 files changed, 239 insertions(+), 417 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index c9fde3c..adfc968 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -16,8 +16,8 @@ info: contact: name: NFV-SOL WG externalDocs: - description: ETSI GS NFV-SOL 009 V3.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf + description: ETSI GS NFV-SOL 009 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf servers: - url: http://0.0.0.0/nfvmanocim/v1 @@ -34,11 +34,8 @@ paths: /mano_entity: get: description: > - Retrives information about an NFV-MANO functional entity - by reading the NFV-MANO entity resource. - This method shall follow the provisions specified in the - tables 5.5.3.3.2-1 and 5.5.3.3.2-2 for URI query parameters, - request and response data structures, and response codes. + The GET method retrieves information about an NFV-MANO functional entity by reading the NFV-MANO entity resource. + See clause 5.5.3.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -68,13 +65,7 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 patch: description: > - Modifies the NFV-MANO entity resource. - Changes to the various configuration and information - attributes are applied to the NFV-MANO functional entity, - and are reflected in the representation of this resource. - This method shall follow the provisions specified in the - tables 5.5.3.3.4-1 and 5.5.3.3.4-2 for URI query parameters, - request and response data structures, and response codes. + The PATCH method modifies the NFV-MANO entity resource. See clause 5.5.3.3.4. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -112,12 +103,8 @@ paths: /mano_entity/change_state: post: description: > - Requests to change the state of the NFV-MANO functional - entity application. - - This method shall follow the provisions specified in the tables - 5.5.7.3.1-1 and 5.5.7.3.1-2 for URI query parameters, request and - response data structures, and response codes. + The POST method requests to change the state of the NFV-MANO functional entity application. + See clause 5.5.7.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -153,11 +140,8 @@ paths: /mano_entity/mano_interfaces: get: description: > - Queries information about multiple NFV-MANO service interfaces of - the NFV-MANO functional entity. - This method shall follow the provisions specified in the tables - 5.5.10.3.2-1 and 5.5.10.3.2-2 for URI query parameters, request - and response data structures, and response codes. + The GET method queries information about multiple NFV-MANO service interfaces + of the NFV-MANO functional entity. See clause 5.5.10.3.2. parameters: - $ref: "#/components/parameters/filter.ManoServiceInterface" - $ref: "../components/SOL009_params.yaml#/components/parameters/all_fields" @@ -191,18 +175,15 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/503 "504": $ref: ../components/SOL009_resp.yaml#/components/responses/504 + /mano_entity/mano_interfaces/{manoServiceInterfaceId}: parameters: - $ref: "#/components/parameters/manoServiceInterfaceId" get: description: > - retrieves information about an NFV-MANO service interface of the - producer NFV-MANO functional entity by reading an "Individual - NFV-MANO service interface" resource. - - This method shall follow the provisions specified in the tables - 5.5.11.3.2-1 and 5.5.11.3.2-2 for URI query parameters, request - and response data structures, and response codes. + The GET method retrieves information about an NFV-MANO service interface of the producer + NFV-MANO functional entity by reading an "Individual NFV-MANO service interface" resource. + See clause 5.5.11.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -230,16 +211,7 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 patch: description: > - Modifies an "Individual NFV-MANO service interface" resource. - - Changes to the configurable parameters of the corresponding - NFV-MANO service interface are applied to the information managed - by the producer NFV-MANO functional entity and reflected in the - representation of this resource. - - This method shall follow the provisions specified in the tables - 5.5.11.3.4-1 and 5.5.11.3.4-2 for URI query parameters, request - and response data structures, and response codes. + This method is used to modify an "Individual NFV-MANO service interface" resource. See clause 5.5.11.3.4. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -279,12 +251,8 @@ paths: - $ref: "#/components/parameters/manoServiceInterfaceId" post: description: > - Requests to change the state of the NFV-MANO service interface - produced by the NFV-MANO functional entity. - - This method shall follow the provisions specified in the tables - 5.5.12.3.1-1 and 5.5.12.3.1-2 for URI query parameters, request - and response data structures, and response codes. + The POST method requests to change the state of the NFV-MANO service interface + produced by the NFV-MANO functional entity. See clause 5.5.12.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -320,11 +288,7 @@ paths: /subscriptions: post: description: > - Creates a new subscription. - - This method shall follow the provisions specified in the tables - 5.5.4.3.1-1 and 5.5.4.3.1-2 for URI query parameters, request and - response data structures, and response codes. + The POST method creates a new subscription. See clause 5.5.4.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -358,13 +322,9 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 get: description: > - queries the list of active subscriptions of the API consumer that - invokes the method. It can be used, e.g., for resynchronization - after error situations. - - This method shall follow the provisions specified in the tables - 5.5.4.3.2-1 and 5.5.4.3.2-2 for URI query parameters, request - and response data structures, and response codes. + The GET method queries the list of active subscriptions of the API consumer that + invokes the method. It can be used, e.g. for resynchronization after error situations. + See clause 5.5.4.3.2. parameters: - $ref: "#/components/parameters/filter.CimSubscription" - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker" @@ -400,12 +360,8 @@ paths: - $ref: "#/components/parameters/subscriptionId" get: description: > - Retrieves information about a subscription by reading an "Individual - subscription" resource. - - This method shall follow the provisions specified in the tables - 5.5.5.3.2-1 and 5.5.5.3.2-2 for URI query parameters, request and - response data structures, and response codes. + The GET method retrieves information about a subscription by reading an "Individual subscription" resource. + See clause 5.5.5.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -435,11 +391,7 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 delete: description: > - Terminates an individual subscription. - - This method shall follow the provisions specified in the tables - 5.5.5.3.5-1 and 5.5.5.3.5-2 for URI query parameters, request - and response data structures, and response codes. + The DELETE method terminates an individual subscription. See clause 5.5.5.3.5. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -472,11 +424,7 @@ paths: get: description: > The API consumer can use the GET method to query status information - about multiple change state operation occurrences. - - This method shall follow the provisions specified in the tables - 5.5.8.3.2-1 and 5.5.8.3.2-2 for URI query parameters, request and - response data structures, and response codes. + about multiple change state operation occurrences. See clause 5.5.8.3.2. parameters: - $ref: "#/components/parameters/filter.ChangeStateOpOcc" - $ref: "../components/SOL009_params.yaml#/components/parameters/all_fields" @@ -518,11 +466,7 @@ paths: description: > The API consumer can use the GET method to retrieve status information about a change state operation occurrence by reading - an "Individual change state operation occurrence" resource. - - This method shall follow the provisions specified in the tables - 5.5.9.3.2-1 and 5.5.9.3.2-2 for URI query parameters, request - and response data structures, and response codes. + an "Individual change state operation occurrence" resource. See clause 5.5.9.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -554,13 +498,9 @@ paths: /peer_entities: post: description: > - Creates in the producer NFV-MANO functional entity a new peer - entity resource which contains configuration and information - with regards to the peer functional entity. - - This method shall follow the provisions specified in the tables - 5.5.13.3.1-1 and 5.5.13.3.1-2 for URI query parameters, request - and response data structures, and response codes. + The POST method creates in the producer NFV-MANO functional entity a new peer + entity resource which contains configuration and information with regards to the + peer functional entity. See clause 5.5.13.3.1 parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -592,12 +532,8 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 get: description: > - Queries information and configuration in the producer NFV-MANO - functional entity with regards to multiple peer entities. - - This method shall follow the provisions specified in the tables - 5.5.13.3.2-1 and 5.5.13.3.2-2 for URI query parameters, request - and response data structures, and response codes. + The GET method queries information and configuration in the producer NFV-MANO functional + entity with regards to multiple peer entities. See clause 5.5.13.3.2. parameters: - $ref: "#/components/parameters/filter.PeerEntity" - $ref: "../components/SOL009_params.yaml#/components/parameters/all_fields" @@ -637,13 +573,8 @@ paths: - $ref: "#/components/parameters/peerEntityId" get: description: > - Retrieves information and configuration hold in the producer NFV-MANO - functional entity with regards to a peer entity by reading an individual - peer entity resource. - - This method shall follow the provisions specified in the tables - 5.5.14.3.2-1 and 5.5.14.3.2-2 for URI query parameters, request - and response data structures, and response codes. + The GET method retrieves information and configuration hold in the producer NFV-MANO functional entity + with regards to a peer entity by reading an individual peer entity resource. See clause 5.5.14.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -673,18 +604,9 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 patch: description: > - Modifies configuration and information of the producer NFV-MANO - functional entity with regards to a peer functional entity by - updating the corresponding "Individual peer entity" resource. - - Changes to the configurable parameters of the corresponding peer - entity are applied to the information managed by the producer - NFV-MANO functional entity and reflected in the representation - of this resource. - - This method shall follow the provisions specified in the tables - 5.5.14.3.4-1 and 5.5.14.3.4-2 for URI query parameters, request - and response data structures, and response codes. + This method modifies configuration and information of the producer NFV-MANO functional + entity with regards to a peer functional entity by updating the corresponding + "Individual peer entity" resource. See clause 5.5.14.3.4. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -718,18 +640,12 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 delete: description: > - Ddeletes an individual peer entity resource. By deleting such - a resource in the producer NFV-MANO functional entity representing - a peer NFV-MANO entity, the configuration and information with - regards to such peer entity is deleted. Consequently, the peering - relationship between the producer NFV-MANO functional entity and - the peer entity is terminated, i.e., the producer NFV-MANO functional - entity does not have the necessary information to communicate/interact - with the peer entity. - - This method shall follow the provisions specified in the tables - 5.5.14.3.5-1 and 5.5.14.3.5-2 for URI query parameters, request - and response data structures, and response codes. + This method deletes an individual peer entity resource. By deleting such a resource in the + producer NFV-MANO functional entity representing a peer NFV-MANO entity, the configuration + and information with regards to such peer entity is deleted. Consequently, the peering relationship + between the producer NFV-MANO functional entity and the peer entity is terminated, i.e. + the producer NFV-MANO functional entity does not have the necessary information to + communicate/interact with the peer entity. See clause 5.5.14.3.5. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -765,6 +681,13 @@ components: ManoEntity: description: > This type represents an NFV-MANO functional entity. + * 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. + * NOTE 4: The information about the NFV-MANO services offered by a specific type of NFV-MANO functional + 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. type: object required: - id @@ -812,10 +735,7 @@ components: manoEntityComponents: description: > The deployed NFV-MANO functional entity components which realize the - NFV-MANO functional entity. - - NOTE: It is optional for the API producer to support the "manoEntityComponents" - attribute. + NFV-MANO functional entity. See note 5. type: array items: $ref: "#/components/schemas/ManoEntityComponent" @@ -857,44 +777,19 @@ components: $ref: "#/components/schemas/UsageStateEnumType" nfvoSpecificInfo: description: > - The information specific to an NFVO entity. - - NOTE: It shall be present when "type" attribute is "NFVO", and it - shall be absent in any other case. - - NOTE: The information about the NFV-MANO services offered by a - specific type of NFV-MANO functional entity is specified by the - manoServices attribute. + The information specific to an NFVO entity. See note 1 and not 4. $ref: "#/components/schemas/NfvoSpecificInfo" vnfmSpecificInfo: description: > - The information specific to a VNFM entity. - - NOTE: It shall be present when "type" attribute is "VNFM", and - it shall be absent in any other case. - NOTE: The information about the NFV-MANO services offered by a - specific type of NFV-MANO functional entity is specified by the - manoServices attribute. + The information specific to a VNFM entity. See note 2 and not 4. $ref: "#/components/schemas/VnfmSpecificInfo" vimSpecificInfo: description: > - The information specific to an VIM entity. - - NOTE: It shall be present when "type" attribute is "VIM", and - it shall be absent in any other case. - NOTE: The information about the NFV-MANO services offered by a - specific type of NFV-MANO functional entity is specified by the - manoServices attribute. + The information specific to an VIM entity. See note 3 and not 4. $ref: "#/components/schemas/VimSpecificInfo" wimSpecificInfo: description: > The information specific to a WIM entity. See notes 4 and 6. - - NOTE 4: The information about the NFV-MANO services offered by a - specific type of NFV-MANO functional entity is specified by the - manoServices attribute. - NOTE 6: It shall be present when "type" attribute is "WIM", - and it shall be absent in any other case. $ref: "#/components/schemas/wimSpecificInfo" _links: description: > @@ -926,7 +821,9 @@ components: ManoConfigModificationRequest: description: > This type represents attribute modifications for configuration parameters - of an NFV-MANO functional entity. + of an NFV-MANO functional entity. + * NOTE: At least one of these attributes shall be provided if requesting a modification + of the NFV-MANO service identified by "id". type: object properties: name: @@ -959,9 +856,25 @@ components: description: > New content of certain entries in the "manoServices" attribute array in the "ManoEntity", as defined below this table. + The following provisions shall apply when modifying an attribute that is an array of structured + "manoServiceModifications". + Assumptions: + A) "oldList" is the array to be modified, "newList" is the array that contains the changes. + B) "oldEntry" is an entry in "oldList" and "newEntry" is an entry in "newList". + C) A "newEntry" has a "corresponding entry" if there exists an "oldEntry" that has the same + content of "id" attribute as the "newEntry". + D) In any array of objects, the content of "id" is unique (i.e. there are no two entries + with the same content of "id"). + Provisions: + 1) For each "newEntry" in "newList" that has a corresponding "oldEntry" in "oldList", the values of + the sub-attributes of "oldEntry" shall be replaced by the value of the sub-attributes in the "newEntry". + 2) If the "newEntry" in "newList" has no corresponding "oldEntry" in "oldList" (i.e. the "id" is + not found), the modification operation will fail as a whole and an error message shall be raised. type: array items: type: object + required: + - id properties: id: description: > @@ -969,20 +882,12 @@ components: $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" name: description: > - New value for the "name" attribute in the "ManoService". - - NOTE: At least one of these attributes shall be provided if requesting - a modification of the NFV-MANO service identified by "id". + New value for the "name" attribute in the "ManoService". See note. type: string description: description: > - New value for the "description" attribute in the "ManoService". - - NOTE: At least one of these attributes shall be provided if requesting - a modification of the NFV-MANO service identified by "id". + New value for the "description" attribute in the "ManoService". See note. type: string - required: - - id ManoConfigModifications: description: > @@ -1112,16 +1017,19 @@ components: 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. + * 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. type: object properties: operationalStateChange: description: > A change of operational state. Shall be present if the state change request - refers to the operational state. - NOTE: In the present document version, a request shall only include an - operational state change (attribute "operationalStateChange") or an - administrative state change request (attribute "administrativeStateChange"), + refers to the operational state. See note 1. but not both. type: object properties: @@ -1133,33 +1041,19 @@ components: $ref: "#/components/schemas/ChangeOperationalStateEnumType" stopType: description: > - It signals the type of stop. - - NOTE: 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. + It signals the type of stop. See note 2. $ref: "#/components/schemas/StopEnumType" gracefulStopTimeout: description: > The time internal (in seconds) to wait for the entity to be taken out - of service during graceful stop. - - NOTE: 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. + of service during graceful stop. See note 2. type: integer required: - operationalStateAction administrativeStateChange: description: > A change of administrative state. Shall be present if the state change request - refers to the administrative state. - - NOTE: In the present document version, a request shall only include an - operational state change (attribute "operationalStateChange") or an - administrative state change request (attribute "administrativeStateChange"), + refers to the administrative state. See note 1. but not both. type: object properties: @@ -1233,8 +1127,30 @@ components: ManoServiceInterface: description: > This type represents an individual NFV-MANO service interface produced by - an NFV-MANO functional entity. + an NFV-MANO functional entity. + * NOTE 1: The information to be provided in this attribute shall relate to the specification and + version of the specification. For instance, "ETSI GS NFV-SOL 003 (V2.4.1)". + * NOTE 2: If this attribute is not present, the value of this parameter is undefined. Overload is + handled by the error handling schemes defined by the applicable API specification. + * NOTE 3: 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 sensitive attribute, the attribute shall be omitted when the information is to be + provided in a response message, and shall be provided otherwise. In case the API consumer is + not allowed to modify the value of the security sensitive attribute, and the modification request + includes new attribute values, the whole modification request shall be rejected, and proper + error information returned. type: object + required: + - id + - name + - type + - standardVersion + - providerSpecificApiVersion + - apiVersion + - apiEndpoint + - supportedOperations + - interfaceState properties: id: description: > @@ -1253,11 +1169,7 @@ components: type: string standardVersion: description: > - Version of the standard the interface is compliant to. - - NOTE 1: The information to be provided in this attribute shall relate to - the specification and version of the specification. For instance, - "ETSI GS NFV-SOL 003 (V2.4.1)". + Version of the standard the interface is compliant to. See note 1. $ref: "../components/SOL009_schemas.yaml#/components/schemas/Version" providerSpecificApiVersion: description: > @@ -1311,11 +1223,7 @@ components: - apiUri maxConcurrentIntOpNumber: description: > - Maximum number of concurrent operation requests supported on this interface. - - NOTE: If this attribute is not present, the value of this parameter - is undefined. Overload is handled by the error handling schemes defined - by the applicable API specification. + Maximum number of concurrent operation requests supported on this interface. See note 2. type: integer supportedOperations: description: > @@ -1330,11 +1238,7 @@ components: type: string maxConcurrentOpNumber: description: > - Maximum number of concurrent requests supported by the interface operation. - - NOTE: If this attribute is not present, the value of this parameter - is undefined. Overload is handled by the error handling schemes defined - by the applicable API specification. + Maximum number of concurrent requests supported by the interface operation. See note 2. type: integer required: - operationName @@ -1363,18 +1267,7 @@ components: description: > Security related information. - This attribute can be modified with the PATCH method. - - NOTE: 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 - sensitive attribute, the attribute shall be omitted when the information - is to be provided in a response message, and shall be provided otherwise. - In case the API consumer is not allowed to modify the value of the security - sensitive attribute, and the modification request includes new attribute - values, the whole modification request shall be rejected, and proper error - information returned. + This attribute can be modified with the PATCH method. See note 3. $ref: "#/components/schemas/ServerInterfaceSecurityInfo" metadata: description: > @@ -1383,60 +1276,39 @@ components: These attributes can be created, modified or removed with the PATCH method. $ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState ManoServiceInterfaceModificationRequest: description: > This type represents attribute modifications for configuration parameters of - an NFV-MANO service interface of the producer NFV-MANO functional entity. + an NFV-MANO service interface of the producer NFV-MANO functional entity. + * NOTE 1: Changing the name does not change the corresponding standardized API name in the resource URI + (refer to "{apiName}" defined in clause 4.1 of ETSI GS NFV-SOL 013). + * NOTE 2: The change of apiRoot or apiUri on an enabled and in use API may be service disruptive. Also, + that change invalidates any related URI that might have been cached at API consumers. + * NOTE 3: 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 modify the value of the + security sensitive attribute, and the modification request includes new attribute values, + the whole modification request shall be rejected, and proper error information returned. type: object properties: name: description: > - New value of the "name" attribute in "ManoServiceInterface". - - NOTE: Changing the name does not change the corresponding standardized - API name in the resource URI (refer to "{apiName}" defined in clause 4.1 - of ETSI GS NFV-SOL 013). + New value of the "name" attribute in "ManoServiceInterface". See note 1. type: string apiRoot: description: > - New value of the "apiRoot" attribute in "ManoServiceInterface". - - NOTE: The change of apiRoot or apiUri on an enabled and in use API may - be service disruptive. Also, that change invalidates any related URI that - might have been cached at API consumers. + New value of the "apiRoot" attribute in "ManoServiceInterface". See note 2. $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri" apiUri: description: > - New value of the "apiUri" attribute in "ManoServiceInterface". - - NOTE: The change of apiRoot or apiUri on an enabled and in use API may - be service disruptive. Also, that change invalidates any related URI that - might have been cached at API consumers. + 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" securityInfo: description: > - New value of the "securityInfo" attribute in "ManoServiceInterface". - - NOTE: 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 modify the value of the security - sensitive attribute, and the modification request includes new attribute - values, the whole modification request shall be rejected, and proper error - information returned. + New value of the "securityInfo" attribute in "ManoServiceInterface". See note 3. $ref: "#/components/schemas/ServerInterfaceSecurityInfo" metadata: description: > @@ -1452,7 +1324,12 @@ components: be included consist of those requested to be modified explicitly in the "ManoServiceInterfaceModificationRequest" data structure. If applicable, additional attributes of the "ManoServiceInterface" data structure that - were modified implicitly shall also be provided. + were modified implicitly shall also be provided. + * NOTE: 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 + sensitive attribute, the attribute shall be omitted when the information is to be provided + in a response message. type: object properties: name: @@ -1473,14 +1350,7 @@ components: securityInfo: description: > If present, this attribute signals modifications of the "securityInfo" - attribute in "ManoServiceInterface", as defined in clause 5.6.2.11. - - NOTE: 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 - sensitive attribute, the attribute shall be omitted when the information - is to be provided in a response message. + attribute in "ManoServiceInterface", as defined in clause 5.6.2.11. See note. $ref: "#/components/schemas/ServerInterfaceSecurityInfo" metadata: description: > @@ -1490,17 +1360,19 @@ components: CreatePeerEntityRequest: description: > - This type represents request parameters for the creation of a new peer entity resource. + This type represents request parameters for the creation of a new peer entity resource. + * NOTE: The value of the "peerEntityId" attribute is the same as the value of the "id" attribute + in the "ManoEntity" of the corresponding NFV-MANO functional entity that acts as peer entity, + and shall follow the uniqueness requirements set out in clause 5.6.2.2 for the "id" attribute. type: object + required: + - peerEntityId + - name + - type properties: peerEntityId: description: > - Identifier of the peer functional entity. - - NOTE: The value of the "peerEntityId" attribute is the same as the value of - the "id" attribute in the "ManoEntity" of the corresponding NFV-MANO functional - entity that acts as peer entity, and shall follow the uniqueness requirements - set out in clause 5.6.2.2 for the "id" attribute. + Identifier of the peer functional entity. See note. $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier" name: description: > @@ -1537,15 +1409,22 @@ components: required: - operationalState - administrativeState - required: - - peerEntityId - - name - - type PeerEntity: description: > - This type represents an individual peer entity. + This type represents an individual peer entity. + * NOTE 1: The value of the "peerEntityId" attribute is the same as the value of the "id" attribute in the + "ManoEntity" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall + follow the uniqueness requirements set out in clause 5.6.2.2 for the "id" attribute. + * NOTE 2: ETSI GS NFV-IFA 031 [1] defines an additional attribute named "apiDiscoveryEndpoint" in the + PeerManoEntity. The modelling of this attribute is not specified in the present document version. type: object + required: + - id + - peerEntityId + - name + - type + - peerEntityState properties: id: description: > @@ -1554,12 +1433,7 @@ components: $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier" peerEntityId: description: > - Identifier of the peer functional entity. - - NOTE : The value of the "peerEntityId" attribute is the same as the value - of the "id" attribute in the "ManoEntity" of the corresponding NFV-MANO - functional entity that acts as peer entity, and shall follow the uniqueness - requirements set out in clause 5.6.2.2 for the "id" attribute. + Identifier of the peer functional entity. See note 1. $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier" name: description: > @@ -1607,17 +1481,16 @@ components: required: - operationalState - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState PeerEntityConfigModificationRequest: description: > - This type represents attribute modifications for configuration parameters - of a peer entity. + This type represents attribute modifications for configuration parameters of a peer entity. + * NOTE: Due to the security sensitive information contained within the attribute (refer to "securityInfo" + within the "ConsumedManoInterfaceInfo"), 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 modify the value of the security sensitive attribute, and the + modification request includes new attribute values, the whole modification request shall be rejected, + and proper error information returned. type: object properties: name: @@ -1635,16 +1508,7 @@ components: in the "PeerEntity", as defined below this table. If present, these modifications shall be applied according to the rules of - JSON Merge PATCH (see IETF RFC 7396). - - NOTE: Due to the security sensitive information contained within the attribute - (refer to "securityInfo" within the "ConsumedManoInterfaceInfo"), 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 modify the value of the security sensitive - attribute, and the modification request includes new attribute values, - the whole modification request shall be rejected, and proper error information - returned. + JSON Merge PATCH (see IETF RFC 7396). See note. type: object additionalProperties: $ref: "#/components/schemas/ConsumedManoInterfaceInfo" @@ -1667,6 +1531,11 @@ components: "PeerEntityConfigModificationRequest" data structure. If applicable, additional attributes of the "PeerEntity" data structure that were modified implicitly shall also be provided. + * NOTE: Due to the security sensitive information contained within the attribute (refer to "securityInfo" + within the "ConsumedManoInterfaceInfo"), 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 sensitive attribute, the attribute shall + be omitted when the information is to be provided in a response message. type: object properties: name: @@ -1683,15 +1552,7 @@ components: description: > If present, this attribute signals modifications of the "consumedManoInterfaces" attribute in "PeerEntity", as defined in - clause 5.6.2.15. - - NOTE: Due to the security sensitive information contained within the - attribute (refer to "securityInfo" within the "ConsumedManoInterfaceInfo"), - 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 - sensitive attribute, the attribute shall be omitted when the information - is to be provided in a response message. + clause 5.6.2.15. See note. type: object additionalProperties: $ref: "#/components/schemas/ConsumedManoInterfaceInfo" @@ -1720,6 +1581,8 @@ components: NFV-MANO functional entity. It is optional for the API producer to support this type. type: object + required: + - id properties: id: description: > @@ -1734,13 +1597,13 @@ components: type: array items: $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" - required: - - id ManoService: description: > This type represents information about an NFV-MANO service provided by the NFV-MANO functional entity. + * NOTE: A cardinality greater than one supports having different interface versions or api Endpoints + to be used for accessing the same instance of an NFV-MANO service. type: object properties: id: @@ -1764,11 +1627,7 @@ components: Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the - ManoServiceInterface is referred. - - NOTE: A cardinality greater than one supports having different interface - versions or apiEndpoints to be used for accessing the same instance of a - NFV-MANO service. + ManoServiceInterface is referred. See note type: array items: $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity" @@ -1798,23 +1657,19 @@ components: NfvoSpecificInfo: description: > This type represents information attributes specific to an NFVO entity, - and that can be relevant to more than one NFV-MANO service offered by an - NFVO entity. + and that can be relevant to more than one NFV-MANO service offered by an NFVO entity. + * NOTE 1: The information to be provided in this attribute shall relate to the specification and version + of the specification. For instance, "ETSI GS NFV-SOL 001 (V2.5.1)". + NOTE 2: If this attribute is not present, the value of this parameter is undefined. type: object properties: maxOnboardedNsdNum: description: > - Maximum number of NSDs that can be on-boarded on the NFVO. - - NOTE: If this attribute is not present, the value of this parameter - is undefined. + Maximum number of NSDs that can be on-boarded on the NFVO. See note 2. type: integer maxOnboardedVnfPkgNum: description: > - Maximum number of VNF Packages that can be on-boarded on the NFVO. - - NOTE: If this attribute is not present, the value of this parameter - is undefined. + Maximum number of VNF Packages that can be on-boarded on the NFVO. See note 2. type: integer supportedVnfdFormats: description: > @@ -1836,11 +1691,7 @@ components: - YANG standardVersion: description: > - Name and version of the standard the VNFD is compliant to. - - NOTE: The information to be provided in this attribute shall relate - to the specification and version of the specification. For instance, - "ETSI GS NFV-SOL 001 (V2.5.1)". + Name and version of the standard the VNFD is compliant to. See note 1. $ref: "../components/SOL009_schemas.yaml#/components/schemas/Version" required: - vnfdFormat @@ -1865,11 +1716,7 @@ components: - YANG standardVersion: description: > - Name and version of the standard the NSD is compliant to. - - NOTE: The information to be provided in this attribute shall relate - to the specification and version of the specification. For instance, - "ETSI GS NFV-SOL 001 (V2.5.1)". + Name and version of the standard the NSD is compliant to. See note 1. $ref: "../components/SOL009_schemas.yaml#/components/schemas/Version" required: - nsdFormat @@ -1881,8 +1728,9 @@ components: VnfmSpecificInfo: description: > This type represents information attributes specific to a VNFM entity, - and that can be relevant to more than one NFV-MANO service offered by - a VNFM entity. + and that can be relevant to more than one NFV-MANO service offered by a VNFM entity. + * NOTE: The information to be provided in this attribute shall relate to the specification and version + of the specification. For instance, "ETSI GS NFV-SOL 001 (V2.5.1)". type: object properties: resoruceMgmtModeSupport: @@ -1929,11 +1777,7 @@ components: - YANG standardVersion: description: > - Name and version of the standard the VNFD is compliant to. - - NOTE: The information to be provided in this attribute shall relate - to the specification and version of the specification. For instance, - "ETSI GS NFV-SOL 001 (V2.5.1)". + Name and version of the standard the VNFD is compliant to. See note $ref: "../components/SOL009_schemas.yaml#/components/schemas/Version" required: - vnfdFormat @@ -2020,7 +1864,7 @@ components: type: object properties: clockSyncs: - description: + description: > Properties of the clock synchronization to be used by the NFV-MANO functional entity. @@ -2046,7 +1890,16 @@ components: ConsumedManoInterfaceInfo: description: > This type represents an interface consumed by the producer NFV MANO - functional entity from another peer functional entity. + 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)". + * 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 + sensitive attribute, the attribute shall be omitted when the information is to be provided in a + response message, and shall be provided otherwise. In case the API consumer is not allowed to + modify the value of the security sensitive attribute, and the modification request includes new + attribute values, the whole modification request shall be rejected, and proper error information returned. type: object properties: name: @@ -2060,11 +1913,7 @@ components: type: string standardVersion: description: > - Version of the standard the interface is compliant to. - - NOTE: 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)". + Version of the standard the interface is compliant to. See note 1. $ref: "../components/SOL009_schemas.yaml#/components/schemas/Version" apiVersion: description: > @@ -2111,18 +1960,7 @@ components: securityInfo: description: > Security related information including credentials information if needed - for consuming the API. - - NOTE: 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 - sensitive attribute, the attribute shall be omitted when the information - is to be provided in a response message, and shall be provided otherwise. - In case the API consumer is not allowed to modify the value of the security - sensitive attribute, and the modification request includes new attribute values, - the whole modification request shall be rejected, and proper error information - returned. + for consuming the API. See note 2. $ref: "#/components/schemas/ClientInterfaceSecurityInfo" required: - id @@ -2135,7 +1973,9 @@ components: CimNotificationsFilter: description: > This type represents a subscription filter related to notifications - about NFV-MANO configuration and information management. + about NFV-MANO configuration and information management. + * NOTE: The permitted values of the "notificationTypes" attribute are spelled exactly as the names + of the notification types to facilitate automated code generation systems. type: object properties: manoEntitySubscriptionFilter: @@ -2151,9 +1991,7 @@ components: - InformationChangedNotification - ChangeStateNotification - NOTE: The permitted values of the "notificationTypes" attribute are - spelled exactly as the names of the notification types to facilitate - automated code generation systems. + See note. type: array items: type: string @@ -2163,7 +2001,8 @@ components: ClockSyncInfo: description: > - This type represents parameters for connecting to an NTP server. + This type represents parameters for connecting to an NTP server. + * NOTE: Either ipAddress or hostname shall be set, but not both at the same time. type: object properties: type: @@ -2179,23 +2018,16 @@ components: - OTHER ntpServerInfo: description: > - Information for the NTP based clock synchronization. - Shall be present if type = "NTP". + Information for the NTP based clock synchronization. Shall be present if type = "NTP". type: object properties: ipAddress: description: > - 0..1 IP address of the NTP server. - - NOTE: Either ipAddress or hostname shall be set, but not both - at the same time. + IP address of the NTP server. See note $ref: "../components/SOL009_schemas.yaml#/components/schemas/IpAddress" hostname: description: > - Indicates the hostname of the NTP server. - - NOTE: Either ipAddress or hostname shall be set, but not both - at the same time. + Indicates the hostname of the NTP server. See note. type: string otherClockSyncParams: description: > @@ -2208,8 +2040,13 @@ components: ServerInterfaceSecurityInfo: description: > This type represents security related information of an NFV-MANO - service interface produced by an NFV-MANO functional entity. + service interface produced by an NFV-MANO functional entity. + * NOTE: Provided configuration of the OAuth 2.0 authorization server information and configuration + shall be supported, and dynamic configuration may be supported. type: object + required: + - authType + - oauthServerInfo properties: authType: description: > @@ -2233,16 +2070,17 @@ components: description: > OAuth 2.0 authorization server information and configuration. type: object + required: + - providedConfiguration + - tlsCipherSuites properties: dynamicDiscovery: description: > Configuration data used when performing dynamic discovery of - the authorization server identifier. - - NOTE: Provided configuration of the OAuth 2.0 authorization - server information and configuration shall be supported, and - dynamic configuration may be supported. + the authorization server identifier. See note. type: object + required: + - webFingerHost properties: webFingerHost: description: > @@ -2250,36 +2088,27 @@ components: 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" - required: - - webFingerHost providedConfiguration: description: > - Configuration data used to setup the authorization server identifier. - - NOTE: Provided configuration of the OAuth 2.0 authorization - server information and configuration shall be supported, and - dynamic configuration may be supported. + Configuration data used to setup the authorization server identifier. See note. type: object + required: + - authServerId properties: authServerId: description: > Authorization server identifier as defined in ETSI GS NFV-SEC 022. $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri" - required: - - authServerId tlsCipherSuites: description: > - List of cipher suites that shall be declared as supported by the - API producer when performing the SSL or TLS negotiation with the - authorization server. Valid values of cipher suites are defined + List of cipher suites that shall be declared as supported by the + API producer when performing the SSL or TLS negotiation with the + authorization server. Valid values of cipher suites are defined in IETF RFC 8447. type: array items: type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites + minItems: 1 tlsTunnelInfo: description: > Information and configuration related to the use of TLS tunnel. @@ -2287,7 +2116,7 @@ components: type: object properties: tlsTunnelCipherSuites: - description: + description: > List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447. @@ -2297,14 +2126,13 @@ components: minItems: 1 required: - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo ClientInterfaceSecurityInfo: description: > This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. + * NOTE: Provided configuration of the OAuth 2.0 authorization server information and configuration + shall be supported, and dynamic configuration may be supported. type: object required: - authType @@ -2337,10 +2165,7 @@ components: dynamicDiscovery: description: > Configuration data used when performing dynamic discovery of the authorization - server identifier. - - NOTE: Provided configuration of the OAuth 2.0 authorization server information - and configuration shall be supported, and dynamic configuration may be supported. + server identifier. See note. type: object required: - webFingerHost @@ -2354,10 +2179,7 @@ components: format: uri providedConfiguration: description: > - Configuration data used to setup the authorization server identifier. - - NOTE: Provided configuration of the OAuth 2.0 authorization server information - and configuration shall be supported, and dynamic configuration may be supported. + Configuration data used to setup the authorization server identifier. See note. type: object required: - authServerId @@ -2665,7 +2487,7 @@ components: changeStateOpOccId: name: changeStateOpOccId in: path - description: >- + description: > Identifier of the change state operation occurrence required: true schema: @@ -2674,7 +2496,7 @@ components: peerEntityId: name: peerEntityId in: path - description: >- + description: > Identifier of the peer entity required: true schema: diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml index ff16f92..a51bee4 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml @@ -16,8 +16,8 @@ info: contact: name: NFV-SOL WG externalDocs: - description: ETSI GS NFV-SOL 009 V3.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf + description: ETSI GS NFV-SOL 009 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf servers: - url: http://0.0.0.0/callback/v1 @@ -36,9 +36,9 @@ paths: resource during the subscription process. post: description: > - The POST method delivers a notification from the API producer to an API consumer. - The API consumer shall have previously created an "Individual subscription" - resource with a matching filter. + The POST method delivers a notification from the API producer to an API consumer. + The API consumer shall have previously created an "Individual subscription" resource + with a matching filter. See clause 5.5.6.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -72,7 +72,7 @@ paths: get: description: > TThe GET method allows the API producer to test the notification endpoint that - is provided by the API consumer, e.g., during the subscription process. + is provided by the API consumer, e.g., during the subscription process. See clause 5.5.6.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" -- GitLab From 8ee37475cc9435226a850c6608faed2437203416 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Thu, 6 May 2021 19:16:39 +0200 Subject: [PATCH 36/50] Added Notes in descriptions & data type references --- .../NFVManoFaultManagement.yaml | 71 +++------- .../NFVManoFaultManagementNotification.yaml | 36 ++--- .../NFVManoLogManagement.yaml | 124 ++++++++---------- .../NFVManoLogManagementNotification.yaml | 12 +- .../NFVManoPerformanceManagement.yaml | 101 +++++--------- ...ManoPerformanceManagementNotification.yaml | 8 +- 6 files changed, 121 insertions(+), 231 deletions(-) diff --git a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml index 5f1c6ed..1e5102b 100644 --- a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml +++ b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml @@ -12,8 +12,8 @@ info: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt externalDocs: - description: ETSI GS NFV-SOL 009 V3.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf + description: ETSI GS NFV-SOL 009 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf servers: - url: http://127.0.0.1/nfvmanofm/v1 @@ -26,10 +26,7 @@ paths: /alarms: get: description: > - Get Alarm List. The client can use this method to retrieve information - about the alarm list. This method shall follow the provisions specified - in the tables 7.5.3.3.2-1 and 7.5.3.3.2-2 for URI query parameters, - request and response data structures, and response codes. + The client can use this method to retrieve information about the alarm list. See clause 7.5.3.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -64,10 +61,7 @@ paths: - $ref: "#/components/parameters/alarmId" get: description: > - The client can use this method to read an individual alarm. This method - shall follow the provisions specified in the tables 7.5.4.3.2-1 and - 7.5.4.3.2-2 for URI query parameters, request and response data - structures, and response codes. + The client can use this method to read an individual alarm. See clause 7.5.4.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -97,10 +91,7 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 patch: description: > - This method modifies an "Individual alarm" resource. This method shall - follow the provisions specified in the tables 7.5.4.3.4-1 and - 7.5.4.3.4-2 for URI query parameters, request and response data - structures, and response codes. + This method modifies an "Individual alarm" resource. See clause 7.5.4.3.4. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -138,24 +129,7 @@ paths: /subscriptions: post: description: > - Subscribe. The POST method creates a new subscription. This method shall - follow the provisions specified in the tables 7.5.5.3.1-1 and - 7.5.5.3.1-2 for URI query parameters, request and response data - structures, and response codes. As the result of successfully executing - this method, a new "Individual subscription" resource as defined in - clause 7.5.6 shall have been created. This method shall not trigger any - notification. Creation of two "Individual subscription" resources with - the same callbackURI and the same filter can result in performance - degradation and will provide duplicates of notifications to the API - consumer, and might make sense only in very rare use cases. - Consequently, the NFV-MANO functional entity may either allow creating a - new "Individual subscription" resource if another "Individual - subscription" resource with the same filter and callbackUri already - exists (in which case it shall return the "201 Created" response code), - or may decide to not create a duplicate "Individual subscription" - resource (in which case it shall return a "303 See Other" response code - referencing the existing "Individual subscription" resource with the - same filter and callbackUri). + The POST method creates a new subscription. See clause 7.5.5.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -190,12 +164,9 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 get: description: > - Query Subscription Information - The client can use this method to retrieve the list of active subscriptions for NFV-MANO functional entity - alarms subscribed by the client. It can be used e.g. for resynchronization after error situations. This method - shall follow the provisions specified in the tables 7.5.5.3.2-1 and 7.5.5.3.2-2 for URI query parameters, - request and response data structures, and response codes. + alarms subscribed by the client. It can be used e.g. for resynchronization after error situations. + See clause 7.5.5.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -230,11 +201,8 @@ paths: - $ref: "#/components/parameters/subscriptionId" get: description: > - Query Subscription Information. The client can use this method for - reading an individual subscription for NFV-MANO functional entity alarms - subscribed by the client. This method shall follow the provisions - specified in the tables 7.5.6.3.2-1 and 7.5.6.3.2-2 for URI query - parameters, request and response data structures, and response codes. + The client can use this method for reading an individual subscription for NFV-MANO functional entity alarms + subscribed by the client. See clause 7.5.6.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -264,16 +232,7 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 delete: description: > - Terminate Subscription. This method terminates an individual - subscription. This method shall follow the provisions specified in the - tables 7.5.6.3.5-1 and 7.5.6.3.5-2 for URI query parameters, request and - response data structures, and response codes. As the result of - successfully executing this method, the "Individual subscription" - resource shall not exist any longer. This means that no notifications - for that subscription shall be sent to the formerly-subscribed API - consumer. NOTE: Due to race conditions, some notifications might still - be received by the formerly-subscribed API consumer for a certain time - period after the deletion. + This method terminates an individual subscription. See clause 7.5.6.3.5. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" @@ -417,7 +376,8 @@ components: structure, the following applies: All attributes shall match in order for the filter to match (logical "and" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical "or" between the values of one filter attribute). - + * NOTE: The permitted values of the "notificationTypes" attribute are spelled exactly as the names + of the notification types to facilitate automated code generation systems. type: object properties: notificationTypes: @@ -427,9 +387,8 @@ components: * AlarmNotification * AlarmClearedNotification * AlarmListRebuiltNotification - The permitted values of the "notificationTypes" attribute are - spelled exactly as the names of the notification types to - facilitate automated code generation systems. + + See note. type: array items: type: string diff --git a/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml b/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml index b7fe8ce..dc732eb 100644 --- a/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml +++ b/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml @@ -1,6 +1,6 @@ openapi: 3.0.2 info: - version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Fault Management Notification Operation description: > SOL009 - NFV-MANO Fault Management Notification Operation @@ -12,8 +12,8 @@ info: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt externalDocs: - description: ETSI GS NFV-SOL 009 V3.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf + description: ETSI GS NFV-SOL 009 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf security: - OauthSecurity: @@ -29,10 +29,7 @@ paths: description: > The POST method notifies an NFV-MANO functional entity alarm or that the alarm list has been rebuilt. The API consumer shall have previously - created an "Individual subscription" resource with a matching filter. - This method shall follow the provisions specified in the tables - 7.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and - response data structures, and response codes. + created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType" @@ -59,10 +56,7 @@ paths: get: description: > The GET method allows the server to test the notification endpoint that - is provided by the client, e.g. during subscription. This method shall - follow the provisions specified in the tables 7.5.7.3.2-1 and - 7.5.7.3.2-2 for URI query parameters, request and response data - structures, and response codes. + is provided by the client, e.g. during subscription. See clause 7.5.7.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" @@ -88,10 +82,7 @@ paths: description: > The POST method notifies an NFV-MANO functional entity alarm or that the alarm list has been rebuilt. The API consumer shall have previously - created an "Individual subscription" resource with a matching filter. - This method shall follow the provisions specified in the tables - 7.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and - response data structures, and response codes. + created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType" @@ -118,10 +109,7 @@ paths: get: description: > The GET method allows the server to test the notification endpoint that - is provided by the client, e.g. during subscription. This method shall - follow the provisions specified in the tables 7.5.7.3.2-1 and - 7.5.7.3.2-2 for URI query parameters, request and response data - structures, and response codes. + is provided by the client, e.g. during subscription. See clause 7.5.7.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" @@ -147,10 +135,7 @@ paths: description: > The POST method notifies an NFV-MANO functional entity alarm or that the alarm list has been rebuilt. The API consumer shall have previously - created an "Individual subscription" resource with a matching filter. - This method shall follow the provisions specified in the tables - 7.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and - response data structures, and response codes. + created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType" @@ -177,10 +162,7 @@ paths: get: description: > The GET method allows the server to test the notification endpoint that - is provided by the client, e.g. during subscription. This method shall - follow the provisions specified in the tables 7.5.7.3.2-1 and - 7.5.7.3.2-2 for URI query parameters, request and response data - structures, and response codes. + is provided by the client, e.g. during subscription. See clause 7.5.7.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" diff --git a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml index ee22461..d5d18a8 100644 --- a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml +++ b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml @@ -1,6 +1,6 @@ openapi: 3.0.2 info: - version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Log Management interface description: > SOL009 - NFV-MANO Log Management interface @@ -13,8 +13,8 @@ info: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt externalDocs: - description: ETSI GS NFV-SOL 009 V3.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf + description: ETSI GS NFV-SOL 009 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf security: - OauthSecurity: @@ -32,11 +32,7 @@ paths: This resource represents logging jobs. The API consumer can use this resource to create and query logging jobs. post: description: >- - The POST method creates a logging job. - This method shall follow the provisions specified in the tables 8.5.3.3.1-1 and 8.5.3.3.1-2 for URI query - parameters, request and response data structures, and response codes. - As the result of successfully executing this method, a new "Individual logging job" resource as defined in - clause 9.5.4 shall have been created. + The POST method creates a logging job. See clause 8.5.3.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -69,9 +65,7 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 get: description: >- - The API consumer can use this method to retrieve information about logging jobs. - This method shall follow the provisions specified in the tables 8.5.3.3.2-1 and 8.5.3.3.2-2 for - URI query parameters, request and response data structures, and response codes. + The API consumer can use this method to retrieve information about logging jobs. See clause 8.5.3.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/filter" - $ref: "../components/SOL009_params.yaml#/components/parameters/all_fields" @@ -114,9 +108,7 @@ paths: - $ref: "#/components/parameters/logJobId" get: description: >- - The API consumer can use this method for reading an individual logging job. - This method shall follow the provisions specified in the tables 8.5.4.3.2-1 and 8.5.4.3.2-2 for - URI query parameters, request and response data structures, and response codes. + The API consumer can use this method for reading an individual logging job. See clause 8.5.4.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -148,11 +140,7 @@ paths: delete: description: >- - This method terminates an individual logging job. - This method shall follow the provisions specified in the tables 8.5.4.3.5-1 and 8.5.4.3.5-2 for URI - query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, the "Individual logging job" resource shall not - exist any longer + This method terminates an individual logging job. See clause 8.5.4.3.5. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" @@ -192,9 +180,7 @@ paths: - $ref: "#/components/parameters/logReportId" get: description: >- - The API consumer can use this method for reading an individual log report. - This method shall follow the provisions specified in the tables 8.5.5.3.2-1 and - 8.5.5.3.2-2 for URI query parameters, request and response data structures, and response codes. + The API consumer can use this method for reading an individual log report. See clause 8.5.5.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -240,8 +226,7 @@ paths: post: description: >- The POST method requests to compile the logged data into a file and create an associated log report. - This method shall follow the provisions specified in the tables 8.5.6.3.1-1 and 8.5.6.3.1-2 for URI - query parameters, request and response data structures, and response codes. + See clause 8.5.6.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -283,18 +268,7 @@ paths: related to NFV-MANO performance management and to query its subscriptions. post: description: >- - The POST method creates a new subscription. - This method shall follow the provisions specified in the tables 8.5.7.3.1-1 and 8.5.7.3.1-2 for URI query - parameters, request and response data structures, and response codes. - As the result of successfully executing this method, a new "Individual subscription" resource as defined in - clause 8.5.8 shall have been created. This method shall not trigger any notification. - Creation of two "Individual subscription" resources with the same callbackURI and the same filter can result - in performance degradation and will provide duplicates of notifications to the API consumer, and might make - sense only in very rare use cases. Consequently, the NFV-MANO functional entity may either allow creating a - new "Individual subscription" resource if another "Individual subscription" resource with the same filter - and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide - to not create a duplicate "Individual subscription" resource (in which case it shall return a "303 See Other" - response code referencing the existing "Individual subscription" resource with the same filter and callbackUri). + The POST method creates a new subscription. See clause 8.5.7.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -333,9 +307,7 @@ paths: get: description: >- The API consumer can use this method to query the list of active subscriptions to log management - notifications subscribed by the API consumer. - This method shall follow the provisions specified in the tables 8.5.7.3.2-1 and 8.5.7.3.2-2 for URI - query parameters, request and response data structures, and response codes. + notifications subscribed by the API consumer. See clause 8.5.7.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/filter" @@ -375,9 +347,7 @@ paths: get: description: >- The API consumer can use this method for reading an individual subscription about log management - notifications subscribed by the API consumer. - This method shall follow the provisions specified in the tables 8.5.8.3.2-1 and 8.5.8.3.2-2 for - URI query parameters, request and response data structures, and response codes. + notifications subscribed by the API consumer. See clause 8.5.8.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -406,14 +376,7 @@ paths: delete: description: >- - This method terminates an individual subscription. - This method shall follow the provisions specified in the tables 8.5.8.3.5-1 and 8.5.8.3.5-2 for - URI query parameters, request and response data structures, and response codes. - As the result of successfully executing this method, the "Individual subscription" resource shall not exist any - longer. This means that no notifications for that subscription shall be sent to the - formerly-subscribed API consumer. - NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed - API consumer for a certain time period after the deletion. + This method terminates an individual subscription. See clause 8.5.8.3.5. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" @@ -1054,11 +1017,9 @@ components: LogmNotificationsFilter: description: >- This type represents a filter that can be used to subscribe for notifications related to log - management events. It shall comply with the provisions defined in table 8.6.3.7-1. - At a particular nesting level in the filter structure, the following applies: All attributes - shall match in order for the filter to match (logical "and" between different filter attributes). - If an attribute is an array, the attribute shall match if at least one of the values in the array matches - (logical "or" between the values of one filter attribute). + management events. + * NOTE: The permitted values of the "notificationTypes" attribute are spelled exactly as the names + of the notification types to facilitate automated code generation systems. type: object properties: objectInstanceFilter: @@ -1070,6 +1031,7 @@ components: Match particular notification types. Permitted values: - LogReportAvailableNotification + See note. type: string enum: [LogReportAvailableNotification] @@ -1156,7 +1118,8 @@ components: LogReport: description: > This type represents a log report, which provides information about a compiled log and how to obtain it. - It shall comply with the provisions defined in table 8.6.2.7-1. + * NOTE: It is not specified in the present document how the NFV-MANO functional entity's private + key is provided to the NFV-MANO functional entity. type: object required: - id @@ -1221,8 +1184,8 @@ components: - HTTPS: transmission over HTTP Secure (HTTPS). - SFTP: transmission over SSH file transfer protocol (SFTP). - SCP: transmission over secure copy protocol (SCP). - - FTPS: transmission over file transfer protocol secure (FTPS), as specified in IETF RFC 2228 [i.11], - using explicit mode as specified in IETF RFC 4217 [i.12]. If FTPS is supported, "private" protection level shall be used. + - FTPS: transmission over file transfer protocol secure (FTPS), as specified in IETF RFC 2228, + using explicit mode as specified in IETF RFC 4217. If FTPS is supported, "private" protection level shall be used. HTTPS shall be supported, and other protocols may be supported. type: string @@ -1262,13 +1225,13 @@ components: description: >- The cryptographic algorithm used for the encryption. Shall be present if the compiled log file is encrypted. Valid values are: "AES-CBC-128", "AES-GCM-128", "AES-CBC-256", and "AES-GCM-256", - as specified in clause 6.5 of ETSI GS NFV-SEC 012 [14]. + as specified in clause 6.5 of ETSI GS NFV-SEC 012. type: string logFileSignature: description: >- Signature to the compiled log file generated with the NFV-MANO functional entity’s private key, which is used to ensure the authenticity of the compiled log file. The signature shall be applied - according to the "encryptAndSignOrder" of the "LoggingJobConfig". + according to the "encryptAndSignOrder" of the "LoggingJobConfig". See note. type: string signingCertificate: description: >- @@ -1416,8 +1379,10 @@ components: LoggingJobCriteria: description: >- - This type represents collection criteria for logging jobs. It shall comply with the provisions - defined in table 8.6.3.2-1. + This type represents collection criteria for logging jobs. + * NOTE: The value of the loggingType has dependency on the object that is requested to be logged + (refer to the CreateLoggingJobRequest): a) the logging of messages is only applicable to + ManoServiceInterface and ConsumedManoInterface objects. type: object required: - loggingType @@ -1430,6 +1395,8 @@ components: - MESSAGES: logged NFV-MANO service interface messages. - SERVICES: logged messages about processes pertaining to NFV-MANO services. - SYSTEM: logged messages about the NFV-MANO functional entity’s system enabled by the provider. + + See note. type: string enum: [MESSAGES, SERVICES, SYSTEM] messagesLogDetail: @@ -1453,7 +1420,8 @@ components: LoggingJobMessagesCriteria: description: >- This type represents criteria for logging jobs to collect logged messages on NFV-MANO service interfaces. - It shall comply with the provisions defined in table 8.6.3.3-1. + * NOTE: If a matching pattern is present, at least one of the "srcIpAddress", "dstIpAddress", "requestMethod", + "requestUriPattern" or "responseCodes" shall be provided. type: object required: - direction @@ -1474,6 +1442,7 @@ components: values provided in the sub-attributes shall be logged. An API consumer can provide more than one "matchingPattern" if combinations of patterns are to be considered to match diverse sets of interface messages. + See note. type: array items: type: object @@ -1554,18 +1523,23 @@ components: LoggingJobServicesCriteria: description: >- This type represents criteria for logging jobs to collect logged messages about processes pertaining - to NFV-MANO services. It shall comply with the provisions defined in table 8.6.3.4-1. + to NFV-MANO services. + * NOTE: In the present version of the present document, only one attribute, i.e. + "logGarbageCollection", is available. type: object properties: logGarbageCollection: description: >- Indicates to collect logged information about garbage collection processes associated to NFV-MANO services. + See note. type: boolean LoggingJobSystemCriteria: description: >- This type represents criteria for logging jobs to collect logged system events of the NFV-MANO functional - entity. It shall comply with the provisions defined in table 8.6.3.5-1. + entity. + * NOTE: The set of properties and values for this attribute are assumed to be known to the consumer + by means defined outside of the present document. type: object required: - systemLogs @@ -1573,7 +1547,7 @@ components: properties: systemLogs: description: >- - Values for the provider enabled system logs. + Values for the provider enabled system logs. See note. $ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" severityLevelScheme: description: >- @@ -1594,6 +1568,17 @@ components: defined in table 8.6.3.6-1. NOTE: The present document version does not specify the support for "log compilation and reporting based on events" as specified in clause 6.6.2.2 of ETSI GS NFV-IFA 031. + + * NOTE 1: The minimumReportingPeriod is used to throttle possible flooding of reports by providing a lower + limit on the gap between two log availability notification to be emitted by the same logging job. + NOTE 2: More than one logCompilingCondition is possible to provide a combination of different conditions + for the compilation. This covers use cases when the compilation of the log can be based on, e.g. + a timer value and a size value, whichever first condition is met first. For instance, compile a + log every 3 600 seconds, or whenever during the 3 600 seconds period the log grows in + size to 1 000 000 bytes. + NOTE 3: The value is indicative, as the actual size of the compiled log files might not match the provided + compileBySizeValue due to possible deviations in the tracking of the size of the log data by the + API producer, and the size of individual logged data entries when these are collected. type: object required: - reportingCondition @@ -1629,7 +1614,7 @@ components: minimumReportingPeriod: description: >- Specifies the minimum periodicity at which the producer will report to the consumer about the - collected log information, in seconds. + collected log information, in seconds. See note 1. type: integer format: int32 compileBySizeValue: @@ -1637,14 +1622,15 @@ components: An indicative size threshold for compiling the collected log data, in bytes. It is used when the compilation is based on the size of the collected log data. If not present, a default value as specified with the "defaultLogCompileBySizeValue" configuration in the "ManoEntityConfigurableParams" - shall be used + shall be used. See note 2 and note 3. type: integer format: int32 compileByTimerValue: description: >- The periodicity threshold for compiling the filtered log, in seconds. It is used when the compilation is based on a timer (e.g., every 24 hours). If not present, a default value as specified with the - "defaultLogCompileByTimerValue" configuration in the "ManoEntityConfigurableParams" shall be used + "defaultLogCompileByTimerValue" configuration in the "ManoEntityConfigurableParams" shall be used. + See note 2. type: integer format: int32 securityConf: diff --git a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml index 94afb7c..ae33f11 100644 --- a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml +++ b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml @@ -1,6 +1,6 @@ openapi: 3.0.2 info: - version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Log Management Notification Operation description: > SOL009 - NFV-MANO Log Management Notification Operation @@ -14,7 +14,7 @@ info: url: https://forge.etsi.org/etsi-forge-copyright-notice.txt externalDocs: description: ETSI GS NFV-SOL 009 V3.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf security: - OauthSecurity: @@ -35,9 +35,7 @@ paths: description: >- The POST method delivers a notification regarding a log management event from the API producer to the API consumer. The API consumer shall have previously created an "Individual subscription" resource with a - matching filter. - This method shall follow the provisions specified in the tables 8.5.9.3.1-1 and 8.5.9.3.1-2 for URI query - parameters, request and response data structures, and response codes. + matching filter. See clause 8.5.9.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" @@ -70,9 +68,7 @@ paths: get: description: >- The GET method allows the API producer to test the notification endpoint that is provided by the API - consumer, e.g. during subscription. - This method shall follow the provisions specified in the tables 8.5.9.3.2-1 and 8.5.9.3.2-2 for URI - query parameters, request and response data structures, and response codes. + consumer, e.g. during subscription. See clause 8.5.9.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index 9c9bda7..e91bcf8 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -1,6 +1,6 @@ openapi: 3.0.2 info: - version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Performance Management Interface description: > SOL009 - NFV-MANO Performance Management Interface @@ -16,8 +16,8 @@ info: contact: name: NFV-SOL WG externalDocs: - description: ETSI GS NFV-SOL 009 V3.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf + description: ETSI GS NFV-SOL 009 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf servers: - url: http://0.0.0.0/nfvmanopm/v1 @@ -34,11 +34,7 @@ paths: /pm_jobs: post: description: > - Creates a PM job. - - This method shall follow the provisions specified in the tables - 6.5.3.3.1-1 and 6.5.3.3.1-2 for URI query parameters, request and - response data structures, and response codes. + The POST method creates a PM job. See clause 6.5.3.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -70,7 +66,7 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 get: description: > - The client can use this method to retrieve information about PM jobs. + The client can use this method to retrieve information about PM jobs. See clause 6.5.3.3.2. parameters: - $ref: "#/components/parameters/filter.PmJob" - $ref: "../components/SOL009_params.yaml#/components/parameters/all_fields" @@ -110,7 +106,7 @@ paths: - $ref: "#/components/parameters/pmJobId" get: description: > - The client can use this method for reading an individual PM job. + The client can use this method for reading an individual PM job. See clause 6.5.4.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -140,11 +136,7 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 patch: description: > - This method allows to modify an "individual PM job" resource. - - This method shall follow the provisions specified in the tables 6.5.4.3.4-1 - and 6.5.4.3.4-2 for URI query parameters, request and response data structures, - and response codes. + This method allows to modify an "individual PM job" resource. See clause 6.5.4.3.4. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -180,7 +172,7 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 delete: description: > - This method terminates an individual PM job. + This method terminates an individual PM job. See clause 6.5.4.3.5. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -215,8 +207,7 @@ paths: - $ref: "#/components/parameters/reportId" get: description: > - The client can use this method for reading an individual - performance report. + The client can use this method for reading an individual performance report. See clause 6.5.5.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -248,7 +239,7 @@ paths: /thresholds: post: description: > - The POST method can be used by the client to create a threshold. + The POST method can be used by the client to create a threshold. See clause 6.5.6.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -280,7 +271,7 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 get: description: > - The client can use this method to query information about thresholds. + The client can use this method to query information about thresholds. See clause 6.5.6.3.2. parameters: - $ref: "#/components/parameters/filter.Threshold" - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker" @@ -316,7 +307,7 @@ paths: - $ref: "#/components/parameters/thresholdId" get: description: > - The client can use this method for reading an individual threshold + The client can use this method for reading an individual threshold. See clause 6.5.7.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -346,10 +337,7 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 patch: description: > - This method allows to modify an "Individual threshold" resource. - This method shall follow the provisions specified in the tables - 6.5.7.3.4-1 and 6.5.7.3.4-2 for URI query parameters, request and - response data structures, and response codes + This method allows to modify an "Individual threshold" resource. See clause 6.5.7.3.4. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -385,7 +373,7 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/504 delete: description: > - This method allows to delete a threshold. + This method allows to delete a threshold. See clause 6.5.7.3.5. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -636,7 +624,7 @@ components: Identifier of this threshold resource. $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier" objectType: - description: + 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. type: string @@ -768,14 +756,12 @@ components: PmJobModifications: description: > This type represents modifications to a PM job. + * NOTE: At least one of the attributes defined in this type shall be present in request bodies. type: object properties: callbackUri: description: > - New value of the "callbackUri" attribute.The value "null" is not permitted. - - NOTE: At least one of the attributes defined in this type - shall be present in request bodies. + New value of the "callbackUri" attribute.The value "null" is not permitted. See note. $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri" authentication: description: > @@ -783,23 +769,18 @@ components: If present in a request body, these modifications shall be applied according to the rules of JSONMerge PATCH (see IETF RFC 7396). - This attribute shall not be present in response bodies. - - NOTE: At least one of the attributes defined in this type - shall be present in request bodies.. + This attribute shall not be present in response bodies. See note. $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication" ThresholdModifications: description: > This type represents modifications to a threshold. + * NOTE: At least one of the attributes defined in this type shall be present in request bodies. type: object properties: callbackUri: description: > - New value of the "callbackUri" attribute.The value "null" is not permitted. - - NOTE: At least one of the attributes defined in this type - shall be present in request bodies. + New value of the "callbackUri" attribute.The value "null" is not permitted. See note. $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri" authentication: description: > @@ -807,10 +788,7 @@ components: If present in a request body, these modifications shall be applied according to the rules of JSONMerge PATCH (see IETF RFC 7396). - This attribute shall not be present in response bodies. - - NOTE: At least one of the attributes defined in this type - shall be present in request bodies.. + This attribute shall not be present in response bodies. See note. $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication" #---------- @@ -818,6 +796,12 @@ components: PmJobCriteria: description: > This type represents collection criteria for PM jobs. + * NOTE 1: At the end of each reportingPeriod, the producer will inform the API consumer about availability + of the performance data collected for each completed collection period during this reportingPeriod. + The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case, + the performance data for the collection periods within one reporting period are reported together. + * NOTE 2: In particular when choosing short collection and reporting periods, the number of PM jobs that can + be supported depends on the capability of the producing entity. type: object properties: performanceMetric: @@ -843,34 +827,12 @@ components: collectionPeriod: description: > Specifies the periodicity at which the producer will collect performance - information. The unit shall be seconds. - - At the end of each reportingPeriod, the producer will inform the API consumer - about availability of the performance data collected for each completed - collection period during this reportingPeriod. The reportingPeriod should - be equal to or a multiple of the collectionPeriod. In the latter case, the - performance data for the collection periods within one reporting period - are reported together. - - In particular when choosing short collection and reporting periods, the - number of PM jobs that can be supported depends on the capability of the - producing entity. + information. The unit shall be seconds. See note 1 and note 2. type: integer reportingPeriod: description: > Specifies the periodicity at which the producer will report to the API consumer - about performance information. The unit shall be seconds. - - At the end of each reportingPeriod, the producer will inform the API consumer - about availability of the performance data collected for each completed - collection period during this reportingPeriod. The reportingPeriod should - be equal to or a multiple of the collectionPeriod. In the latter case, the - performance data for the collection periods within one reporting period - are reported together. - - In particular when choosing short collection and reporting periods, the - number of PM jobs that can be supported depends on the capability of the - producing entity. + about performance information. The unit shall be seconds. See note 1 and note 2. type: integer reportingBoundary: description: > @@ -885,6 +847,11 @@ components: ThresholdCriteria: description: > This type represents criteria that define a threshold. + * NOTE 1: In the present document, simple thresholds are defined. The definition of additional threshold + types is left for future specification. + * NOTE 2: The hysteresis is defined to prevent storms of threshold crossing notifications. + 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). type: object properties: performanceMetric: diff --git a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml index 46dbdcb..8f9ef1d 100644 --- a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml +++ b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml @@ -16,8 +16,8 @@ info: contact: name: NFV-SOL WG externalDocs: - description: ETSI GS NFV-SOL 009 V3.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf + description: ETSI GS NFV-SOL 009 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf servers: - url: http://0.0.0.0/callback/v1 @@ -38,7 +38,7 @@ paths: description: > The POST method delivers a notification regarding a performance management event from the API producer to an API consumer. The API consumer shall have previously - created an " Individual PM job resource" or "Individual threshold resource". + created an " Individual PM job resource" or "Individual threshold resource". See clause 6.5.10.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" @@ -72,7 +72,7 @@ paths: get: description: > The GET method allows the server to test the notification endpoint that is - provided by the client, e.g. during creation of the PM job or threshold. + provided by the client, e.g. during creation of the PM job or threshold. See clause 6.5.10.3.2. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" -- GitLab From 906dbfe262373cf004598278328d260133c438c3 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Fri, 7 May 2021 09:07:19 +0200 Subject: [PATCH 37/50] fix API version --- src/SOL009/APIVersion/APIVersion.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/SOL009/APIVersion/APIVersion.yaml b/src/SOL009/APIVersion/APIVersion.yaml index 9d5b106..e5113b0 100644 --- a/src/SOL009/APIVersion/APIVersion.yaml +++ b/src/SOL009/APIVersion/APIVersion.yaml @@ -23,8 +23,8 @@ info: name: NFV-SOL WG externalDocs: - description: ETSI GS NFV-SOL 009 V3.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf + description: ETSI GS NFV-SOL 009 V3.5.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf paths: /nfvmanocim/api_versions: -- GitLab From f966d3ee40f97361137f71954cb477d596b72058 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Fri, 7 May 2021 09:33:30 +0200 Subject: [PATCH 38/50] minor fix --- ...ConfigurationAndInformationManagement.yaml | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index adfc968..4d7bc20 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -789,7 +789,7 @@ components: $ref: "#/components/schemas/VimSpecificInfo" wimSpecificInfo: description: > - The information specific to a WIM entity. See notes 4 and 6. + The information specific to a WIM entity. See notes 4 and note 6. $ref: "#/components/schemas/wimSpecificInfo" _links: description: > @@ -1801,11 +1801,17 @@ components: and that can be relevant to more than one NFV MANO service offered by a WIM entity. type: object + required: + - maxMscsNums + - maxMsncNum + - mscsLayerProtocolSupport properties: maxMscsNums: description: > Maximum number of MSCS that the WIM can manage. type: object + required: + - numMscs properties: numMscs: description: > @@ -1813,15 +1819,16 @@ components: type: integer criteriaNumMscs: description: > - Reference criteria for derivation/computation of the referred - maximum number of MSCS in attribute "numMscs". + 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" - required: - - numMscs maxMsncNum: description: > Maximum number of MSNC that the WIM can manage type: object + required: + - numMsnc properties: numMsnc: description: > @@ -1832,8 +1839,6 @@ components: Reference criteria for derivation/computation of the referred maximum number of MSNC in attribute "numMsnc". $ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" - required: - - numMsnc mscsLayerProtocolSupport: description: > List of protocols of particular layers used to realize an MSCS -- GitLab From cf7b89ece743abd5a5f93d666f3e868467dd2a71 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Fri, 7 May 2021 09:46:48 +0200 Subject: [PATCH 39/50] Update referance --- .../NFVManoConfigurationAndInformationManagement.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index 4d7bc20..4675f1b 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -790,7 +790,7 @@ components: wimSpecificInfo: description: > The information specific to a WIM entity. See notes 4 and note 6. - $ref: "#/components/schemas/wimSpecificInfo" + $ref: "#/components/schemas/WimSpecificInfo" _links: description: > Links to resources related to this resource. -- GitLab From 930f6d8cd8fbc125fead769c78ed437fe67b4ebe Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Fri, 7 May 2021 10:16:57 +0200 Subject: [PATCH 40/50] Fix in ChangeStateRequest --- .../NFVManoConfigurationAndInformationManagement.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index 4675f1b..88a2749 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -731,7 +731,7 @@ components: softwareVersion: description: > The version of the software of the NFV-MANO functional entity. - $ref: "../components/SOL009_schemas.yaml#/components/schemas/Version" + $ref: "../components/SOL009_schemas.yaml#/components/schemas/Version" manoEntityComponents: description: > The deployed NFV-MANO functional entity components which realize the @@ -1056,13 +1056,13 @@ components: refers to the administrative state. See note 1. but not both. type: object + required: + - administrativeStateAction properties: administrativeStateAction: description: > The desired administrative state to change the managed object to. - type: - required: - - administrativeStateAction + $ref: "#/components/schemas/ChangeAdministrativeStateEnumType" ChangeStateOpOcc: description: > -- GitLab From 52747d0092aa6d9a00f3c29cf9a96ede3b1d7e26 Mon Sep 17 00:00:00 2001 From: Giacomo Bernini Date: Fri, 7 May 2021 11:38:58 +0200 Subject: [PATCH 41/50] fixed API version endpoint and notification ednpoints --- ...nAndInformationManagementNotification.yaml | 2 +- .../NFVManoFaultManagementNotification.yaml | 6 ++-- .../NFVManoLogManagementNotification.yaml | 4 +-- ...ManoPerformanceManagementNotification.yaml | 2 +- src/SOL009/endpoints/SOL009_endpoints.yaml | 33 ++++++++++++++++--- 5 files changed, 36 insertions(+), 11 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml index a51bee4..5cd7ca9 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml @@ -28,7 +28,7 @@ servers: API HTTPS Server paths: - /URI-is-provided-by-the-client-when-creating-the-subscription-ConfigurationAndInformationNotification: + /URI_is_provided_by_the_client_when_creating_the_subscription-ConfigurationAndInformationNotification: description: > This resource represents a notification endpoint. The API producer can use this resource to send notifications related to NFV-MANO configuration and information diff --git a/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml b/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml index dc732eb..9ca70cc 100644 --- a/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml +++ b/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml @@ -24,7 +24,7 @@ servers: - url: https://127.0.0.1/callback/v1 paths: - /URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification: + /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification: post: description: > The POST method notifies an NFV-MANO functional entity alarm or that the @@ -77,7 +77,7 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/500 "503": $ref: ../components/SOL009_resp.yaml#/components/responses/503 - /URI-is-provided-by-the-client-when-creating-the-subscription-AlarmClearedNotification: + /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification: post: description: > The POST method notifies an NFV-MANO functional entity alarm or that the @@ -130,7 +130,7 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/500 "503": $ref: ../components/SOL009_resp.yaml#/components/responses/503 - /URI-is-provided-by-the-client-when-creating-the-subscription-AlarmListRebuiltNotification: + /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification: post: description: > The POST method notifies an NFV-MANO functional entity alarm or that the diff --git a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml index ae33f11..a47078a 100644 --- a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml +++ b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml @@ -13,7 +13,7 @@ info: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt externalDocs: - description: ETSI GS NFV-SOL 009 V3.3.1 + description: ETSI GS NFV-SOL 009 V3.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf security: @@ -25,7 +25,7 @@ servers: - url: https://127.0.0.1/callback/v1 paths: - /URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification: + /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification: description: >- This resource represents a notification endpoint for NFV-MANO log management. The API producer can use this resource to send notifications related to log management events to a diff --git a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml index 8f9ef1d..e35bdf2 100644 --- a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml +++ b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml @@ -28,7 +28,7 @@ servers: API HTTPS Server paths: - /URI-is-provided-by-the-client-when-creating-the-subscription-PerformanceInformationNotification: + /URI_is_provided_by_the_client_when_creating_the_subscription-PerformanceInformationNotification: description: > This resource represents a notification endpoint for NFV-MANO performance management. The API producer can use this resource to send notifications related to performance diff --git a/src/SOL009/endpoints/SOL009_endpoints.yaml b/src/SOL009/endpoints/SOL009_endpoints.yaml index a8fb098..275d818 100644 --- a/src/SOL009/endpoints/SOL009_endpoints.yaml +++ b/src/SOL009/endpoints/SOL009_endpoints.yaml @@ -18,7 +18,6 @@ endpoints: schema: type: string get: - summary: Retrieve API version information description: > The GET method reads API version information. This method shall follow the provisions specified in table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not @@ -65,8 +64,6 @@ endpoints: $ref: '../components/SOL009_resp.yaml#/components/responses/403' 404: $ref: '../components/SOL009_resp.yaml#/components/responses/404' - 405: - $ref: '../components/SOL009_resp.yaml#/components/responses/405' 406: $ref: '../components/SOL009_resp.yaml#/components/responses/406' 413: @@ -84,4 +81,32 @@ endpoints: 503: $ref: '../components/SOL009_resp.yaml#/components/responses/503' 504: - $ref: '../components/SOL009_resp.yaml#/components/responses/504' \ No newline at end of file + $ref: '../components/SOL009_resp.yaml#/components/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: ../responses/SOL002SOL003_resp.yaml#/components/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: ../responses/SOL002SOL003_resp.yaml#/components/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: ../responses/SOL002SOL003_resp.yaml#/components/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: ../responses/SOL002SOL003_resp.yaml#/components/responses/405 \ No newline at end of file -- GitLab From ade6ce0409be0dba336c22563fae5f899ac12534 Mon Sep 17 00:00:00 2001 From: Giacomo Bernini Date: Fri, 7 May 2021 11:47:20 +0200 Subject: [PATCH 42/50] fix --- src/SOL009/endpoints/SOL009_endpoints.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/SOL009/endpoints/SOL009_endpoints.yaml b/src/SOL009/endpoints/SOL009_endpoints.yaml index 275d818..b71fe1e 100644 --- a/src/SOL009/endpoints/SOL009_endpoints.yaml +++ b/src/SOL009/endpoints/SOL009_endpoints.yaml @@ -88,25 +88,25 @@ endpoints: Method Not Allowed" response as defined in SOL013 clause 6.4. responses: 405: - $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/405 + $ref: '../components/SOL009_resp.yaml#/components/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: ../responses/SOL002SOL003_resp.yaml#/components/responses/405 + $ref: '../components/SOL009_resp.yaml#/components/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: ../responses/SOL002SOL003_resp.yaml#/components/responses/405 + $ref: '../components/SOL009_resp.yaml#/components/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: ../responses/SOL002SOL003_resp.yaml#/components/responses/405 \ No newline at end of file + $ref: '../components/SOL009_resp.yaml#/components/responses/405' \ No newline at end of file -- GitLab From a9d4b4d7e44e0c64da1c76700415ddc38e07dffd Mon Sep 17 00:00:00 2001 From: Giacomo Bernini Date: Fri, 7 May 2021 14:56:09 +0200 Subject: [PATCH 43/50] fixed version --- .../NFVManoConfigurationAndInformationManagement.yaml | 6 +++--- ...noConfigurationAndInformationManagementNotification.yaml | 6 +++--- .../NFVManoFaultManagement/NFVManoFaultManagement.yaml | 2 +- .../NFVManoFaultManagementNotification.yaml | 2 +- src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml | 2 +- .../NFVManoLogManagementNotification.yaml | 2 +- .../NFVManoPerformanceManagement.yaml | 6 +++--- .../NFVManoPerformanceManagementNotification.yaml | 6 +++--- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index 88a2749..d7d7cff 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -1,6 +1,6 @@ openapi: 3.0.2 info: - version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Configuration and Information Management Interface description: > SOL009 - NFV-MANO Configuration and Information Management Interface @@ -20,10 +20,10 @@ externalDocs: url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf servers: - - url: http://0.0.0.0/nfvmanocim/v1 + - url: http://0.0.0.0/nfvmanocim/v2 description: > API HTTP Server - - url: https://0.0.0.0/nfvmanocim/v1 + - url: https://0.0.0.0/nfvmanocim/v2 description: > API HTTPS Server diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml index 5cd7ca9..907d2ce 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml @@ -1,6 +1,6 @@ openapi: 3.0.2 info: - version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Configuration and Information Management Notification Operation description: > SOL009 - NFV-MANO Configuration and Information Management Notification Operation @@ -20,10 +20,10 @@ externalDocs: url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf servers: - - url: http://0.0.0.0/callback/v1 + - url: http://0.0.0.0/callback/v2 description: > API HTTP Server - - url: https://0.0.0.0/callback/v1 + - url: https://0.0.0.0/callback/v2 description: > API HTTPS Server diff --git a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml index 1e5102b..3f1057c 100644 --- a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml +++ b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml @@ -1,6 +1,6 @@ openapi: 3.0.2 info: - version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Fault Management interface description: > SOL009 - NFV-MANO Fault Management interface diff --git a/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml b/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml index 9ca70cc..1829e9d 100644 --- a/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml +++ b/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml @@ -1,6 +1,6 @@ openapi: 3.0.2 info: - version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Fault Management Notification Operation description: > SOL009 - NFV-MANO Fault Management Notification Operation diff --git a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml index d5d18a8..9a78b09 100644 --- a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml +++ b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml @@ -1,6 +1,6 @@ openapi: 3.0.2 info: - version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Log Management interface description: > SOL009 - NFV-MANO Log Management interface diff --git a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml index a47078a..3e9743f 100644 --- a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml +++ b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml @@ -1,6 +1,6 @@ openapi: 3.0.2 info: - version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Log Management Notification Operation description: > SOL009 - NFV-MANO Log Management Notification Operation diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index e91bcf8..f5732f5 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -1,6 +1,6 @@ openapi: 3.0.2 info: - version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Performance Management Interface description: > SOL009 - NFV-MANO Performance Management Interface @@ -20,10 +20,10 @@ externalDocs: url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf servers: - - url: http://0.0.0.0/nfvmanopm/v1 + - url: http://0.0.0.0/nfvmanopm/v2 description: > API HTTP Server - - url: https://0.0.0.0/nfvmanopm/v1 + - url: https://0.0.0.0/nfvmanopm/v2 description: > API HTTPS Server diff --git a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml index e35bdf2..84de336 100644 --- a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml +++ b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml @@ -1,6 +1,6 @@ openapi: 3.0.2 info: - version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Performance Management Notification Operation description: > SOL009 - NFV-MANO Performance Management Notification Operation @@ -20,10 +20,10 @@ externalDocs: url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf servers: - - url: http://0.0.0.0/callback/v1 + - url: http://0.0.0.0/callback/v2 description: > API HTTP Server - - url: https://0.0.0.0/callback/v1 + - url: https://0.0.0.0/callback/v2 description: > API HTTPS Server -- GitLab From 7bc6bba43d1fa7e65352f339f37ebf541a54ef0f Mon Sep 17 00:00:00 2001 From: Giacomo Bernini Date: Fri, 14 May 2021 17:28:56 +0200 Subject: [PATCH 44/50] fixed comments from SOL WG (SOL009) --- src/SOL009/APIVersion/APIVersion.yaml | 20 +++++------- ...ConfigurationAndInformationManagement.yaml | 27 ++++++++-------- ...nAndInformationManagementNotification.yaml | 31 +++++++++---------- .../NFVManoFaultManagement.yaml | 15 ++++++--- .../NFVManoFaultManagementNotification.yaml | 23 ++++++++------ .../NFVManoLogManagement.yaml | 19 +++++++----- .../NFVManoLogManagementNotification.yaml | 24 +++++++------- .../NFVManoPerformanceManagement.yaml | 28 ++++++++--------- ...ManoPerformanceManagementNotification.yaml | 29 +++++++++-------- 9 files changed, 112 insertions(+), 104 deletions(-) diff --git a/src/SOL009/APIVersion/APIVersion.yaml b/src/SOL009/APIVersion/APIVersion.yaml index e5113b0..be4b099 100644 --- a/src/SOL009/APIVersion/APIVersion.yaml +++ b/src/SOL009/APIVersion/APIVersion.yaml @@ -1,26 +1,22 @@ openapi: 3.0.2 info: - version: 1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 - title: SOL009 - API version interface - - description: > + description: | SOL009 - API version Interface - IMPORTANT: Please note that this file might - be not aligned to the current version of the ETSI Group Specification it - refers to and has not been approved by the ETSI NFV ISG. In case of + IMPORTANT: Please note that this file might be not aligned to the current + version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - Please report bugs to - https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis - license: - name: ETSI Forge copyright notice - url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues contact: name: NFV-SOL WG + license: + name: ETSI Forge copyright notice + url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: 1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 009 V3.5.1 diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index d7d7cff..28dc45c 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -1,31 +1,30 @@ openapi: 3.0.2 + info: - version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Configuration and Information Management Interface - description: > + description: | SOL009 - NFV-MANO Configuration and Information Management Interface IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + version of the ETSI Group Specification it refers to. In case of + discrepancies the published ETSI Group Specification takes precedence. + + Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues + + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + externalDocs: description: ETSI GS NFV-SOL 009 V3.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf servers: - - url: http://0.0.0.0/nfvmanocim/v2 - description: > - API HTTP Server - - url: https://0.0.0.0/nfvmanocim/v2 - description: > - API HTTPS Server + - url: http://127.0.0.1/nfvmanocim/v2 + - url: https://127.0.0.1/nfvmanocim/v2 paths: /api_versions: diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml index 907d2ce..a65e7ba 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml @@ -1,31 +1,30 @@ openapi: 3.0.2 + info: - version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 - title: SOL009 - NFV-MANO Configuration and Information Management Notification Operation - description: > - SOL009 - NFV-MANO Configuration and Information Management Notification Operation + title: SOL009 - NFV-MANO Configuration and Information Management Notification Interface + description: | + SOL009 - NFV-MANO Configuration and Information Management Notification Interface IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + version of the ETSI Group Specification it refers to. In case of + discrepancies the published ETSI Group Specification takes precedence. + + Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues + + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + externalDocs: description: ETSI GS NFV-SOL 009 V3.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf servers: - - url: http://0.0.0.0/callback/v2 - description: > - API HTTP Server - - url: https://0.0.0.0/callback/v2 - description: > - API HTTPS Server + - url: http://127.0.0.1/callback/v2 + - url: https://127.0.0.1/callback/v2 paths: /URI_is_provided_by_the_client_when_creating_the_subscription-ConfigurationAndInformationNotification: diff --git a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml index 3f1057c..f598c75 100644 --- a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml +++ b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml @@ -1,16 +1,23 @@ openapi: 3.0.2 + info: - version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Fault Management interface - description: > + description: | SOL009 - NFV-MANO Fault Management interface - IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. + IMPORTANT: Please note that this file might be not aligned to the current + version of the ETSI Group Specification it refers to. In case of + discrepancies the published ETSI Group Specification takes precedence. + + Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 + externalDocs: description: ETSI GS NFV-SOL 009 V3.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf diff --git a/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml b/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml index 1829e9d..94656bd 100644 --- a/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml +++ b/src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml @@ -1,24 +1,27 @@ openapi: 3.0.2 + info: - version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 - title: SOL009 - NFV-MANO Fault Management Notification Operation - description: > - SOL009 - NFV-MANO Fault Management Notification Operation + title: SOL009 - NFV-MANO Fault Management Notification Interface + description: | + SOL009 - NFV-MANO Fault Management Notification Interface + + IMPORTANT: Please note that this file might be not aligned to the current + version of the ETSI Group Specification it refers to. In case of + discrepancies the published ETSI Group Specification takes precedence. - IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. + Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 + externalDocs: description: ETSI GS NFV-SOL 009 V3.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf -security: - - OauthSecurity: - - all - servers: - url: http://127.0.0.1/callback/v1 - url: https://127.0.0.1/callback/v1 diff --git a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml index 9a78b09..a912b5d 100644 --- a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml +++ b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml @@ -1,24 +1,27 @@ openapi: 3.0.2 + info: - version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 title: SOL009 - NFV-MANO Log Management interface - description: > + description: | SOL009 - NFV-MANO Log Management interface - IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification - it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. + IMPORTANT: Please note that this file might be not aligned to the current + version of the ETSI Group Specification it refers to. In case of + discrepancies the published ETSI Group Specification takes precedence. + + Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 + externalDocs: description: ETSI GS NFV-SOL 009 V3.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf -security: - - OauthSecurity: - - all servers: - url: http://127.0.0.1/nfvmanologm/v1 - url: https://127.0.0.1/nfvmanologm/v1 diff --git a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml index 3e9743f..2e7eef4 100644 --- a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml +++ b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml @@ -1,25 +1,27 @@ openapi: 3.0.2 info: - version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 - title: SOL009 - NFV-MANO Log Management Notification Operation - description: > - SOL009 - NFV-MANO Log Management Notification Operation - IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification - it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. + title: SOL009 - NFV-MANO Log Management Notification Interface + description: | + SOL009 - NFV-MANO Log Management Notification Interface + + IMPORTANT: Please note that this file might be not aligned to the current + version of the ETSI Group Specification it refers to. In case of + discrepancies the published ETSI Group Specification takes precedence. + + Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 + externalDocs: description: ETSI GS NFV-SOL 009 V3.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf -security: - - OauthSecurity: - - all - servers: - url: http://127.0.0.1/callback/v1 - url: https://127.0.0.1/callback/v1 diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index f5732f5..58a8408 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -1,31 +1,31 @@ openapi: 3.0.2 + info: - version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + title: SOL009 - NFV-MANO Performance Management Interface - description: > + description: | SOL009 - NFV-MANO Performance Management Interface IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + version of the ETSI Group Specification it refers to. In case of + discrepancies the published ETSI Group Specification takes precedence. + + Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues + + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + externalDocs: description: ETSI GS NFV-SOL 009 V3.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf servers: - - url: http://0.0.0.0/nfvmanopm/v2 - description: > - API HTTP Server - - url: https://0.0.0.0/nfvmanopm/v2 - description: > - API HTTPS Server + - url: http://127.0.0.1/nfvmanopm/v2 + - url: https://127.0.0.1/nfvmanopm/v2 paths: /api_versions: diff --git a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml index 84de336..f3ac682 100644 --- a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml +++ b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml @@ -1,31 +1,30 @@ openapi: 3.0.2 + info: - version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 - title: SOL009 - NFV-MANO Performance Management Notification Operation + title: SOL009 - NFV-MANO Performance Management Notification Interface description: > - SOL009 - NFV-MANO Performance Management Notification Operation + SOL009 - NFV-MANO Performance Management Notification Interface IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + version of the ETSI Group Specification it refers to. In case of + discrepancies the published ETSI Group Specification takes precedence. + + Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues + + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + externalDocs: description: ETSI GS NFV-SOL 009 V3.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf servers: - - url: http://0.0.0.0/callback/v2 - description: > - API HTTP Server - - url: https://0.0.0.0/callback/v2 - description: > - API HTTPS Server + - url: http://127.0.0.1/callback/v2 + - url: https://127.0.0.1/callback/v2 paths: /URI_is_provided_by_the_client_when_creating_the_subscription-PerformanceInformationNotification: -- GitLab From ec18eebdc5ff850d72b38485971d76ad9a9316aa Mon Sep 17 00:00:00 2001 From: Giacomo Bernini Date: Fri, 14 May 2021 17:52:06 +0200 Subject: [PATCH 45/50] upd --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ead3abd..957c50b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # NFV SOL009 - OpenAPIs for the management of NFV-MANO This repository contains OpenAPIs for ETSI GS NFV-SOL 009 v3.5.1, RESTful protocols -specification for the management of NFV-MANO. +specification for the management of NFV-MANO functional entities. **IMPORTANT: These [OpenAPI](https://www.openapis.org/) specifications are in development phase. In case of discrepancies the published ETSI Group Specification takes precedence.** -- GitLab From 9151038ad9820a18b39c1998431e260a83ba5f43 Mon Sep 17 00:00:00 2001 From: muhammadh Date: Thu, 8 Jul 2021 14:36:28 +0500 Subject: [PATCH 46/50] Updated Responses and Refs --- ...ConfigurationAndInformationManagement.yaml | 140 +++++++++--------- ...nAndInformationManagementNotification.yaml | 8 +- .../NFVManoFaultManagement.yaml | 32 ++-- .../NFVManoLogManagement.yaml | 40 ++--- .../NFVManoLogManagementNotification.yaml | 8 +- .../NFVManoPerformanceManagement.yaml | 76 +++++----- ...ManoPerformanceManagementNotification.yaml | 8 +- 7 files changed, 156 insertions(+), 156 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index 28dc45c..51a8bed 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -41,7 +41,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: "#/components/responses/mano_entity.get.200" + $ref: "#/components/responses/ManoEntity.Get.200" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -73,11 +73,11 @@ paths: $ref: "#/components/requestBodies/ModifyManoEntityRequest" responses: "200": - $ref: "#/components/responses/mano_entity.patch.200" + $ref: "#/components/responses/ManoEntity.Patch.200" "409": - $ref: "#/components/responses/mano_entity.patch.409" + $ref: "#/components/responses/ManoEntity.Patch.409" "412": - $ref: "#/components/responses/mano_entity.patch.412" + $ref: "#/components/responses/ManoEntity.Patch.412" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -112,9 +112,9 @@ paths: $ref: "#/components/requestBodies/ChangeManoEntityStateRequest" responses: "202": - $ref: "#/components/responses/mano_entity-change_state.post.202" + $ref: "#/components/responses/ChangeState.Post.202" "409": - $ref: "#/components/responses/mano_entity-change_state.post.409" + $ref: "#/components/responses/ChangeState.Post.409" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -153,9 +153,9 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: "#/components/responses/mano_entity-mano_interfaces.get.200" + $ref: "#/components/responses/ManoInterfaces.Get.200" "400": - $ref: "#/components/responses/mano_entity-mano_interfaces.get.400" + $ref: "#/components/responses/ManoInterfaces.Get.400" "401": $ref: ../components/SOL009_resp.yaml#/components/responses/401 "403": @@ -189,7 +189,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: "#/components/responses/mano_entity-mano_interface.get.200" + $ref: "#/components/responses/IndividualManoInterface.Get.200" "401": $ref: ../components/SOL009_resp.yaml#/components/responses/401 "403": @@ -219,11 +219,11 @@ paths: $ref: "#/components/requestBodies/ModifyManoEnityInterfaceRequest" responses: "200": - $ref: "#/components/responses/mano_entity-mano_interface.patch.200" + $ref: "#/components/responses/IndividualManoInterface.Patch.200" "409": - $ref: "#/components/responses/mano_entity-mano_interface.patch.409" + $ref: "#/components/responses/IndividualManoInterface.Patch.409" "412": - $ref: "#/components/responses/mano_entity-mano_interface.patch.412" + $ref: "#/components/responses/IndividualManoInterface.Patch.412" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -260,9 +260,9 @@ paths: $ref: "#/components/requestBodies/ChangeManoEntityInterfaceStateRequest" responses: "202": - $ref: "#/components/responses/mano_entity-mano_interface-change_state.post.202" + $ref: "#/components/responses/ManoInterfaceChangeState.Post.202" "409": - $ref: "#/components/responses/mano_entity-mano_interface-change_state.post.409" + $ref: "#/components/responses/ManoInterfaceChangeState.Post.409" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -296,9 +296,11 @@ paths: $ref: "#/components/requestBodies/CimSubscriptionRequest" responses: "201": - $ref: "#/components/responses/subscriptions.post.201" + $ref: "#/components/responses/Subscriptions.Post.201" "303": - $ref: "#/components/responses/subscriptions.post.303" + $ref: "#/components/responses/Subscriptions.Post.303" + "422": + $ref: "#/components/responses/Subscriptions.Post.422" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -311,8 +313,6 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/405 "406": $ref: ../components/SOL009_resp.yaml#/components/responses/406 - "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 "500": $ref: ../components/SOL009_resp.yaml#/components/responses/500 "503": @@ -332,9 +332,9 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: "#/components/responses/subscriptions.get.200" + $ref: "#/components/responses/Subscriptions.Get.200" "400": - $ref: "#/components/responses/subscriptions.get.400" + $ref: "#/components/responses/Subscriptions.Get.400" "401": $ref: ../components/SOL009_resp.yaml#/components/responses/401 "403": @@ -367,7 +367,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: "#/components/responses/subscription.get.200" + $ref: "#/components/responses/Subscription.Get.200" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -397,7 +397,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "204": - $ref: "#/components/responses/subscription.delete.204" + $ref: "#/components/responses/Subscription.Delete.204" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -436,9 +436,9 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: "#/components/responses/change_state_ops.get.200" + $ref: "#/components/responses/ChangeStateOpOcc.Get.200" "400": - $ref: "#/components/responses/change_state_ops.get.400" + $ref: "#/components/responses/ChangeStateOpOcc.Get.400" "401": $ref: ../components/SOL009_resp.yaml#/components/responses/401 "403": @@ -472,7 +472,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: "#/components/responses/change_state_op.get.200" + $ref: "#/components/responses/IndividualChangeStateOpOcc.Get.200" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -508,7 +508,7 @@ paths: $ref: "#/components/requestBodies/CreatePeerEntityRequest" responses: "201": - $ref: "#/components/responses/peer_entities.post.201" + $ref: "#/components/responses/PeerEntities.Post.201" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -545,9 +545,9 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: "#/components/responses/peer_entities.get.200" + $ref: "#/components/responses/PeerEntities.Get.200" "400": - $ref: "#/components/responses/peer_entities.get.400" + $ref: "#/components/responses/PeerEntities.Get.400" "401": $ref: ../components/SOL009_resp.yaml#/components/responses/401 "403": @@ -580,7 +580,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: "#/components/responses/peer_entitie.get.200" + $ref: "#/components/responses/IndividualPeerEntity.Get.200" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -614,11 +614,11 @@ paths: $ref: "#/components/requestBodies/ModifyPeerEntityRequest" responses: "200": - $ref: "#/components/responses/peer_entitie.patch.200" + $ref: "#/components/responses/IndividualPeerEntity.Patch.200" "409": - $ref: "#/components/responses/peer_entitie.patch.409" + $ref: "#/components/responses/IndividualPeerEntity.Patch.409" "412": - $ref: "#/components/responses/peer_entitie.patch.412" + $ref: "#/components/responses/IndividualPeerEntity.Patch.412" "401": $ref: ../components/SOL009_resp.yaml#/components/responses/401 "403": @@ -651,11 +651,9 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "204": - $ref: "#/components/responses/peer_entitie.delete.204" + $ref: "#/components/responses/IndividualPeerEntity.Delete.204" "409": - $ref: "#/components/responses/peer_entitie.delete.409" - "412": - $ref: "#/components/responses/peer_entitie.delete.412" + $ref: "#/components/responses/IndividualPeerEntity.Delete.409" "401": $ref: ../components/SOL009_resp.yaml#/components/responses/401 "403": @@ -666,6 +664,8 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/405 "406": $ref: ../components/SOL009_resp.yaml#/components/responses/406 + "412": + $ref: ../components/SOL009_resp.yaml#/components/responses/412 "422": $ref: ../components/SOL009_resp.yaml#/components/responses/422 "500": @@ -2584,7 +2584,7 @@ components: required: true responses: - mano_entity.get.200: + ManoEntity.Get.200: description: > 200 OK @@ -2610,7 +2610,7 @@ components: schema: $ref: "#/components/schemas/ManoEntity" - mano_entity.patch.200: + ManoEntity.Patch.200: description: > 200 OK @@ -2633,7 +2633,7 @@ components: application/json: schema: $ref: "#/components/schemas/ManoConfigModifications" - mano_entity.patch.409: + ManoEntity.Patch.409: description: > 409 CONFLICT @@ -2663,7 +2663,7 @@ components: application/json: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - mano_entity.patch.412: + ManoEntity.Patch.412: description: > 412 PRECONDITION FAILED @@ -2693,7 +2693,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - mano_entity-change_state.post.202: + ChangeState.Post.202: description: > 202 ACCEPTED @@ -2725,7 +2725,7 @@ components: format: url minimum: 1 maximum: 1 - mano_entity-change_state.post.409: + ChangeState.Post.409: description: > 409 CONFLICT @@ -2755,7 +2755,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - mano_entity-mano_interfaces.get.200: + ManoInterfaces.Get.200: description: > 200 OK @@ -2803,7 +2803,7 @@ components: type: array items: $ref: "#/components/schemas/ManoServiceInterface" - mano_entity-mano_interfaces.get.400: + ManoInterfaces.Get.400: description: > 400 BAD REQUEST @@ -2837,7 +2837,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - mano_entity-mano_interface.get.200: + IndividualManoInterface.Get.200: description: > 200 OK @@ -2863,7 +2863,7 @@ components: application/json: schema: $ref: "#/components/schemas/ManoServiceInterface" - mano_entity-mano_interface.patch.200: + IndividualManoInterface.Patch.200: description: > 200 OK @@ -2889,7 +2889,7 @@ components: application/json: schema: $ref: "#/components/schemas/ManoServiceInterfaceModifications" - mano_entity-mano_interface.patch.409: + IndividualManoInterface.Patch.409: description: > 409 CONFLICT @@ -2920,7 +2920,7 @@ components: application/json: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - mano_entity-mano_interface.patch.412: + IndividualManoInterface.Patch.412: description: > 412 PRECONDITION FAILED @@ -2951,7 +2951,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - mano_entity-mano_interface-change_state.post.202: + ManoInterfaceChangeState.Post.202: description: > 202 ACCEPTED @@ -2985,7 +2985,7 @@ components: format: url minimum: 1 maximum: 1 - mano_entity-mano_interface-change_state.post.409: + ManoInterfaceChangeState.Post.409: description: > 409 CONFLICT @@ -3015,7 +3015,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - subscriptions.post.201: + Subscriptions.Post.201: description: > 201 CREATED @@ -3052,7 +3052,7 @@ components: application/json: schema: $ref: "#/components/schemas/CimSubscription" - subscriptions.post.303: + Subscriptions.Post.303: description: > 303 SEE OTHER @@ -3087,7 +3087,7 @@ components: format: url minimum: 1 maximum: 1 - subscriptions.post.422: + Subscriptions.Post.422: description: > 422 Unprocessable Entity @@ -3123,7 +3123,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - subscriptions.get.200: + Subscriptions.Get.200: description: > 200 OK @@ -3170,7 +3170,7 @@ components: type: array items: $ref: "#/components/schemas/CimSubscription" - subscriptions.get.400: + Subscriptions.Get.400: description: > 400 BAD REQUEST @@ -3201,7 +3201,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - subscription.get.200: + Subscription.Get.200: description: > 200 OK @@ -3227,7 +3227,7 @@ components: application/json: schema: $ref: "#/components/schemas/CimSubscription" - subscription.delete.204: + Subscription.Delete.204: description: > 204 NO CONTENT @@ -3249,7 +3249,7 @@ components: schema: type: string - change_state_ops.get.200: + ChangeStateOpOcc.Get.200: description: > 200 OK @@ -3297,7 +3297,7 @@ components: type: array items: $ref: "#/components/schemas/ChangeStateOpOcc" - change_state_ops.get.400: + ChangeStateOpOcc.Get.400: description: > 400 BAD REQUEST @@ -3331,7 +3331,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - change_state_op.get.200: + IndividualChangeStateOpOcc.Get.200: description: > 200 OK @@ -3358,7 +3358,7 @@ components: schema: $ref: "#/components/schemas/ChangeStateOpOcc" - peer_entities.post.201: + PeerEntities.Post.201: description: > 201 CREATED @@ -3396,7 +3396,7 @@ components: application/json: schema: $ref: "#/components/schemas/PeerEntity" - peer_entities.get.200: + PeerEntities.Get.200: description: > 200 OK @@ -3444,7 +3444,7 @@ components: type: array items: $ref: "#/components/schemas/PeerEntity" - peer_entities.get.400: + PeerEntities.Get.400: description: > 400 BAD REQUEST @@ -3478,7 +3478,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - peer_entitie.get.200: + IndividualPeerEntity.Get.200: description: > 200 OK @@ -3504,7 +3504,7 @@ components: application/json: schema: $ref: "#/components/schemas/PeerEntity" - peer_entitie.patch.200: + IndividualPeerEntity.Patch.200: description: > 200 OK @@ -3530,7 +3530,7 @@ components: application/json: schema: $ref: "#/components/schemas/PeerEntityConfigModifications" - peer_entitie.patch.409: + IndividualPeerEntity.Patch.409: description: > 409 CONFLICT. @@ -3559,7 +3559,7 @@ components: application/json: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - peer_entitie.patch.412: + IndividualPeerEntity.Patch.412: description: > 412 PRECONDITION FAILED @@ -3588,7 +3588,7 @@ components: application/json: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - peer_entitie.delete.204: + IndividualPeerEntity.Delete.204: description: > 204 NO CONTENT @@ -3609,7 +3609,7 @@ components: Version of the API used in the response. schema: type: string - peer_entitie.delete.409: + IndividualPeerEntity.Delete.409: description: > 409 CONFLICT. @@ -3638,7 +3638,7 @@ components: application/json: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - peer_entitie.delete.412: + IndividualPeerEntity.Delete.412: description: > 412 PRECONDITION FAILED diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml index a65e7ba..8fcec91 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml @@ -46,7 +46,7 @@ paths: $ref: "#/components/requestBodies/ConfigurationAnfInformationNotification" responses: "204": - $ref: "#/components/responses/notification.post.204" + $ref: "#/components/responses/Notification.Post.204" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -78,7 +78,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "204": - $ref: "#/components/responses/notification.get.204" + $ref: "#/components/responses/Notification.Get.204" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -102,7 +102,7 @@ paths: components: responses: - notification.post.204: + Notification.Post.204: description: > 204 NO CONTENT @@ -121,7 +121,7 @@ components: schema: type: string - notification.get.204: + Notification.Get.204: description: > 204 NO CONTENT diff --git a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml index f598c75..845d14d 100644 --- a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml +++ b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml @@ -42,7 +42,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker" responses: "200": - $ref: '#/components/responses/Alarms.Get' + $ref: '#/components/responses/Alarms.Get.200' "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -75,7 +75,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: '#/components/responses/Alarm.Get' + $ref: '#/components/responses/Alarm.Get.200' "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -108,7 +108,7 @@ paths: $ref: "#/components/requestBodies/AlarmModifications" responses: "200": - $ref: '#/components/responses/Alarm.Patch' + $ref: '#/components/responses/Alarm.Patch.200' "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -146,7 +146,7 @@ paths: $ref: "#/components/requestBodies/FmSubscriptionRequest" responses: "201": - $ref: '#/components/responses/subscriptions.post.201' + $ref: '#/components/responses/Subscriptions.Post.201' "303": $ref: ../components/SOL009_resp.yaml#/components/responses/303 "400": @@ -182,7 +182,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker" responses: "200": - $ref: '#/components/responses/subscriptions.get.200' + $ref: '#/components/responses/Subscriptions.Get.200' "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -216,7 +216,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: '#/components/responses/subscription.get.200' + $ref: '#/components/responses/Subscription.Get.200' "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -245,7 +245,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "204": - $ref: '#/components/responses/subscription.delete.204' + $ref: '#/components/responses/Subscription.Delete.204' "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -444,7 +444,7 @@ components: required: true responses: - Alarms.Get: + Alarms.Get.200: description: > 200 OK @@ -486,7 +486,7 @@ components: items: $ref: "../components/SOL009_schemas.yaml#/components/schemas/Alarm" - Alarm.Get: + Alarm.Get.200: description: > 200 OK @@ -506,7 +506,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/Alarm" - Alarm.Patch: + Alarm.Patch.200: description: > 200 OK @@ -535,7 +535,7 @@ components: schema: $ref: "#/components/schemas/AlarmModifications" - subscriptions.post.201: + Subscriptions.Post.201: description: > 201 CREATED @@ -572,7 +572,7 @@ components: application/json: schema: $ref: "#/components/schemas/FmSubscription" - subscriptions.post.303: + Subscriptions.Post.303: description: > 303 SEE OTHER @@ -607,7 +607,7 @@ components: format: url minimum: 1 maximum: 1 - subscriptions.post.422: + Subscriptions.Post.422: description: > 422 Unprocessable Entity @@ -643,7 +643,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - subscriptions.get.200: + Subscriptions.Get.200: description: > 200 OK @@ -695,7 +695,7 @@ components: items: $ref: "#/components/schemas/FmSubscription" - subscription.get.200: + Subscription.Get.200: description: > 200 OK @@ -731,7 +731,7 @@ components: schema: $ref: "#/components/schemas/FmSubscription" - subscription.delete.204: + Subscription.Delete.204: description: > 204 NO CONTENT diff --git a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml index a912b5d..6f0699e 100644 --- a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml +++ b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml @@ -45,7 +45,7 @@ paths: $ref: "#/components/requestBodies/CreateLoggingJobRequest" responses: "201": - $ref: '#/components/responses/LoggingJob.Post' + $ref: '#/components/responses/LoggingJobs.Post.201' "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -81,7 +81,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: '#/components/responses/LoggingJobs.Get' + $ref: '#/components/responses/LoggingJobs.Get.200' "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -119,7 +119,7 @@ paths: responses: "200": - $ref: '#/components/responses/LoggingJob.Get' + $ref: '#/components/responses/IndividualLoggingJob.Get.200' "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -149,7 +149,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "204": - $ref: '#/components/responses/LoggingJob.Delete' + $ref: '#/components/responses/IndividualLoggingJob.Delete.204' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": @@ -281,9 +281,9 @@ paths: $ref: '#/components/requestBodies/LogmSubscriptionRequest' responses: "201": - $ref: '#/components/responses/subscriptions.post.201' + $ref: '#/components/responses/Subscriptions.Post.201' "303": - $ref: '#/components/responses/subscriptions.post.303' + $ref: '#/components/responses/Subscriptions.Post.303' "422": $ref: '../components/SOL009_resp.yaml#/components/responses/422' "400": @@ -320,7 +320,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: '#/components/responses/subscriptions.get.200' + $ref: '#/components/responses/Subscriptions.Get.200' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": @@ -357,7 +357,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: '#/components/responses/subscription.get.200' + $ref: '#/components/responses/Subscription.Get.200' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": @@ -385,7 +385,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "204": - $ref: '#/components/responses/subscription.delete.204' + $ref: '#/components/responses/Subscription.Delete.204' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": @@ -468,7 +468,7 @@ components: $ref: "#/components/schemas/LogReportAvailableNotification" responses: - subscription.delete.204: + Subscription.Delete.204: description: >- Shall be returned when the "Individual subscription" resource has been deleted successfully. The response body shall be empty. @@ -490,7 +490,7 @@ components: schema: type: string - subscription.get.200: + Subscription.Get.200: description: >- Shall be returned when the subscription has been read successfully. The response body shall contain a representation of the "Individual subscription" resource, @@ -517,7 +517,7 @@ components: schema: $ref: "#/components/schemas/LogmSubscription" - subscriptions.get.200: + Subscriptions.Get.200: description: >- Shall be returned when the list of subscriptions has been queried successfully. The response body shall contain in an array the representations of all active subscriptions of @@ -552,7 +552,7 @@ components: items: $ref: "#/components/schemas/LogmSubscription" - subscriptions.post.201: + Subscriptions.Post.201: description: >- Shall be returned when the subscription has been created successfully. A representation of the created "Individual subscription" resource shall be returned in the response body, @@ -586,7 +586,7 @@ components: schema: $ref: "#/components/schemas/LogmSubscription" - subscriptions.post.303: + Subscriptions.Post.303: description: >- Shall be returned when a subscription with the same callbackURI and the same filter already exists and the policy of the NFV-MANO functional entity is to not create redundant subscriptions. @@ -829,7 +829,7 @@ components: schema: type: string - LoggingJob.Get: + IndividualLoggingJob.Get.200: description: >- Shall be returned when information about an individual logging job has been read successfully. The response body shall contain a representation of the "Individual logging job" resource, @@ -856,7 +856,7 @@ components: schema: $ref: "#/components/schemas/LoggingJob" - LoggingJob.Delete: + IndividualLoggingJob.Delete.204: description: >- Shall be returned when the logging job has been deleted successfully. The response body shall be empty. @@ -874,7 +874,7 @@ components: schema: type: string - LoggingJob.Post: + LoggingJobs.Post.201: description: >- The response body contains the Application Context as it was created by the MEC system @@ -900,7 +900,7 @@ components: schema: $ref: "#/components/schemas/LoggingJob" - LoggingJobs.Get: + LoggingJobs.Get.200: description: >- Shall be returned when information about zero or more logging jobs has been queried successfully. @@ -939,7 +939,7 @@ components: items: $ref: "#/components/schemas/LoggingJob" - LogReportAvailableNotification.Post: + LogReportAvailableNotification.Post.201: description: >- Shall be returned when the notification has been delivered successfully. headers: @@ -960,7 +960,7 @@ components: schema: type: string - LogReportNotification.Get: + LogReportNotification.Get.200: description: >- Shall be returned to indicate that the notification endpoint has been tested successfully. The response body shall be empty. diff --git a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml index 2e7eef4..ed139b1 100644 --- a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml +++ b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml @@ -45,7 +45,7 @@ paths: $ref: "#/components/requestBodies/LogReportAvailableNotification" responses: "204": - $ref: '#/components/responses/notification.post.204' + $ref: '#/components/responses/Notification.Post.204' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": @@ -77,7 +77,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "204": - $ref: '#/components/responses/notification.get.204' + $ref: '#/components/responses/Notification.Get.204' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": @@ -110,7 +110,7 @@ components: $ref: "#/components/schemas/LogReportAvailableNotification" responses: - notification.post.204: + Notification.Post.204: description: >- Shall be returned when the notification has been delivered successfully. headers: @@ -131,7 +131,7 @@ components: schema: type: string - notification.get.204: + Notification.Get.204: description: >- Shall be returned to indicate that the notification endpoint has been tested successfully. The response body shall be empty. diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index 58a8408..156f94b 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -43,7 +43,7 @@ paths: $ref: "#/components/requestBodies/CreatePMJobRequest" responses: "201": - $ref: "#/components/responses/pm_jobs.post.201" + $ref: "#/components/responses/pm_jobs.Post.201" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -79,9 +79,9 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: "#/components/responses/pm_jobs.get.200" + $ref: "#/components/responses/pm_jobs.Get.200" "400": - $ref: "#/components/responses/pm_jobs.get.400" + $ref: "#/components/responses/pm_jobs.Get.400" "401": $ref: ../components/SOL009_resp.yaml#/components/responses/401 "403": @@ -113,7 +113,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: "#/components/responses/pm_job.get.200" + $ref: "#/components/responses/IndividualPmJob.Get.200" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -145,11 +145,11 @@ paths: $ref: "#/components/requestBodies/PmJobModificationRequest" responses: "200": - $ref: "#/components/responses/threshold.patch.200" + $ref: "#/components/responses/IndividualPmJob.Patch.200" "412": - $ref: "#/components/responses/threshold.patch.412" + $ref: "#/components/responses/IndividualPmJob.Patch.412" "422": - $ref: "#/components/responses/threshold.patch.422" + $ref: "#/components/responses/IndividualPmJob.Patch.422" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -179,7 +179,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "204": - $ref: "#/components/responses/pm_job.delete.204" + $ref: "#/components/responses/IndividualPmJob.Delete.204" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -214,7 +214,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: "#/components/responses/pm_job.report.get.200" + $ref: "#/components/responses/IndividualPerformanceReport.Get.200" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -248,7 +248,9 @@ paths: $ref: "#/components/requestBodies/CreateThesholdRequest" responses: "201": - $ref: "#/components/responses/thresholds.post.201" + $ref: "#/components/responses/Thresholds.Post.201" + "422": + $ref: "#/components/responses/Thresholds.Post.422" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -261,8 +263,6 @@ paths: $ref: ../components/SOL009_resp.yaml#/components/responses/405 "406": $ref: ../components/SOL009_resp.yaml#/components/responses/406 - "422": - $ref: ../components/SOL009_resp.yaml#/components/responses/422 "500": $ref: ../components/SOL009_resp.yaml#/components/responses/500 "503": @@ -280,9 +280,9 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: "#/components/responses/thresholds.get.200" + $ref: "#/components/responses/Thresholds.Get.200" "400": - $ref: "#/components/responses/thresholds.get.400" + $ref: "#/components/responses/Thresholds.Get.400" "401": $ref: ../components/SOL009_resp.yaml#/components/responses/401 "403": @@ -314,7 +314,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "200": - $ref: "#/components/responses/threshold.get.200" + $ref: "#/components/responses/Threshold.Get.200" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -346,11 +346,11 @@ paths: $ref: "#/components/requestBodies/ThresholdModificationRequest" responses: "200": - $ref: "#/components/responses/threshold.patch.200" + $ref: "#/components/responses/Threshold.Patch.200" "412": - $ref: "#/components/responses/threshold.patch.412" + $ref: "#/components/responses/Threshold.Patch.412" "422": - $ref: "#/components/responses/threshold.patch.422" + $ref: "#/components/responses/Threshold.Patch.422" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -380,7 +380,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "204": - $ref: "#/components/responses/threshold.delete.204" + $ref: "#/components/responses/Threshold.Delete.204" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -907,7 +907,7 @@ components: #---------------- responses: - pm_jobs.post.201: + pm_jobs.Post.201: description: > 201 CREATED @@ -935,7 +935,7 @@ components: application/json: schema: $ref: "#/components/schemas/PmJob" - pm_jobs.post.422: + pm_jobs.Post.422: description: > 422 Unprocessable Entity @@ -971,7 +971,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - pm_jobs.get.200: + pm_jobs.Get.200: description: > 200 OK @@ -1018,7 +1018,7 @@ components: type: array items: $ref: "#/components/schemas/PmJob" - pm_jobs.get.400: + pm_jobs.Get.400: description: > 400 BAD REQUEST @@ -1052,7 +1052,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - pm_job.get.200: + IndividualPmJob.Get.200: description: > 200 OK @@ -1078,7 +1078,7 @@ components: application/json: schema: $ref: "#/components/schemas/PmJob" - pm_job.patch.200: + IndividualPmJob.Patch.200: description: > 200 OK @@ -1102,7 +1102,7 @@ components: application/json: schema: $ref: "#/components/schemas/PmJobModifications" - pm_job.patch.412: + IndividualPmJob.Patch.412: description: > 412 PRECONDITION FAILED @@ -1131,7 +1131,7 @@ components: application/json: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - pm_job.patch.422: + IndividualPmJob.Patch.422: description: > 422 Unprocessable Entity @@ -1166,7 +1166,7 @@ components: application/json: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - pm_job.delete.204: + IndividualPmJob.Delete.204: description: > 204 NO CONTENT @@ -1187,7 +1187,7 @@ components: schema: type: string - pm_job.report.get.200: + IndividualPerformanceReport.Get.200: description: > 200 OK @@ -1215,7 +1215,7 @@ components: schema: $ref: "#/components/schemas/PerformanceReport" - thresholds.post.201: + Thresholds.Post.201: description: > 201 CREATED @@ -1253,7 +1253,7 @@ components: application/json: schema: $ref: "#/components/schemas/Threshold" - thresholds.post.422: + Thresholds.Post.422: description: > 422 Unprocessable Entity @@ -1289,7 +1289,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - thresholds.get.200: + Thresholds.Get.200: description: > 200 OK @@ -1326,7 +1326,7 @@ components: type: array items: $ref: "#/components/schemas/Threshold" - thresholds.get.400: + Thresholds.Get.400: description: > 400 BAD REQUEST @@ -1357,7 +1357,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - threshold.get.200: + Threshold.Get.200: description: > 200 OK @@ -1384,7 +1384,7 @@ components: schema: $ref: "#/components/schemas/Threshold" - threshold.patch.200: + Threshold.Patch.200: description: > 200 OK @@ -1408,7 +1408,7 @@ components: application/json: schema: $ref: "#/components/schemas/ThresholdModifications" - threshold.patch.412: + Threshold.Patch.412: description: > 412 PRECONDITION FAILED @@ -1437,7 +1437,7 @@ components: application/json: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - threshold.patch.422: + Threshold.Patch.422: description: > 422 Unprocessable Entity @@ -1473,7 +1473,7 @@ components: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" - threshold.delete.204: + Threshold.Delete.204: description: > 204 NO CONTENT diff --git a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml index f3ac682..f4e6537 100644 --- a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml +++ b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml @@ -46,7 +46,7 @@ paths: $ref: "#/components/requestBodies/PerfomanceInfoNotification" responses: "204": - $ref: "#/components/responses/notification.post.204" + $ref: "#/components/responses/Notification.Post.204" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -78,7 +78,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "204": - $ref: "#/components/responses/notification.get.204" + $ref: "#/components/responses/Notification.Get.204" "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": @@ -102,7 +102,7 @@ paths: components: responses: - notification.post.204: + Notification.Post.204: description: > 204 NO CONTENT @@ -121,7 +121,7 @@ components: schema: type: string - notification.get.204: + Notification.Get.204: description: > 204 NO CONTENT -- GitLab From 642442f70d4b22728a6a19fdc188bb203a490ed8 Mon Sep 17 00:00:00 2001 From: muhammadh Date: Thu, 8 Jul 2021 17:54:56 +0500 Subject: [PATCH 47/50] Minor Bug Fixed --- src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml index 6f0699e..a583529 100644 --- a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml +++ b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml @@ -1771,7 +1771,7 @@ components: $ref: "#/components/requestBodies/LogReportAvailableNotification" responses: "204": - $ref: '#/components/responses/LogReportAvailableNotification.Post' + $ref: '#/components/responses/LogReportAvailableNotification.Post.204' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": @@ -1804,7 +1804,7 @@ components: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "204": - $ref: '#/components/responses/LogReportNotification.Get' + $ref: '#/components/responses/LogReportNotification.Get.204' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": -- GitLab From f4b880c79e3fde8ef8c935e1023420278da8b744 Mon Sep 17 00:00:00 2001 From: muhammadh Date: Thu, 8 Jul 2021 18:33:28 +0500 Subject: [PATCH 48/50] Minor Bug Fixed (2) --- src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml | 6 +++--- .../NFVManoLogManagementNotification.yaml | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml index a583529..dd75371 100644 --- a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml +++ b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml @@ -939,7 +939,7 @@ components: items: $ref: "#/components/schemas/LoggingJob" - LogReportAvailableNotification.Post.201: + LogReportAvailableNotification.Post.204: description: >- Shall be returned when the notification has been delivered successfully. headers: @@ -960,7 +960,7 @@ components: schema: type: string - LogReportNotification.Get.200: + LogReportAvailableNotification.Get.204: description: >- Shall be returned to indicate that the notification endpoint has been tested successfully. The response body shall be empty. @@ -1804,7 +1804,7 @@ components: - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "204": - $ref: '#/components/responses/LogReportNotification.Get.204' + $ref: '#/components/responses/LogReportAvailableNotification.Get.204' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": diff --git a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml index ed139b1..13911b9 100644 --- a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml +++ b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml @@ -27,7 +27,7 @@ servers: - url: https://127.0.0.1/callback/v1 paths: - /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification: + /URI_is_provided_by_the_client_when_creating_the_subscription-LogNotification: description: >- This resource represents a notification endpoint for NFV-MANO log management. The API producer can use this resource to send notifications related to log management events to a -- GitLab From 7a7c7ce0c5df517b4074620b6c3ed5551f96a1a2 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Fri, 9 Jul 2021 12:45:06 +0200 Subject: [PATCH 49/50] added missing value --- src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml | 3 +++ .../NFVManoLogManagementNotification.yaml | 1 + 2 files changed, 4 insertions(+) diff --git a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml index dd75371..b0cfcfc 100644 --- a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml +++ b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml @@ -442,6 +442,8 @@ components: application/json: schema: $ref: "#/components/schemas/LogmSubscriptionRequest" + required: true + CreateLoggingJobRequest: description: >- This type represents a request to create a logging job. It shall comply with the provisions @@ -466,6 +468,7 @@ components: application/json: schema: $ref: "#/components/schemas/LogReportAvailableNotification" + required: true responses: Subscription.Delete.204: diff --git a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml index 13911b9..e09ff8b 100644 --- a/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml +++ b/src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml @@ -108,6 +108,7 @@ components: application/json: schema: $ref: "#/components/schemas/LogReportAvailableNotification" + required: true responses: Notification.Post.204: -- GitLab From b55095596493f85a1930bd1b8f85b9949b50c25c Mon Sep 17 00:00:00 2001 From: muhammadh Date: Wed, 14 Jul 2021 13:55:16 +0500 Subject: [PATCH 50/50] Minor fixes --- ...ConfigurationAndInformationManagement.yaml | 78 +++++++++---------- ...nAndInformationManagementNotification.yaml | 40 +++++----- .../NFVManoFaultManagement.yaml | 2 +- .../NFVManoLogManagement.yaml | 76 +++++++++++++----- .../NFVManoPerformanceManagement.yaml | 70 ++++++++--------- ...ManoPerformanceManagementNotification.yaml | 34 ++++---- 6 files changed, 167 insertions(+), 133 deletions(-) diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml index 51a8bed..f3032bd 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml @@ -955,6 +955,8 @@ components: This type represents a subscription request related to notifications about NFV-MANO configuration and information management changes. type: object + required: + - callbackUri properties: filter: description: > @@ -975,14 +977,16 @@ components: This attribute shall only be present if the subscriber requires authorization of notifications. $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication" - required: - - callbackUri CimSubscription: description: > This type represents a subscription related to notifications about NFV-MANO configuration and information management changes type: object + required: + - id + - callbackUri + - _links properties: id: description: > @@ -1009,10 +1013,6 @@ components: $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link" required: - self - required: - - id - - callbackUri - - _links ChangeStateRequest: description: > @@ -1067,6 +1067,12 @@ components: description: > This type represents a Change state operation occurrence. type: object + required: + - id + - operationState + - stateEnteredTime + - startTime + - managedObjectRef properties: id: description: > @@ -1116,12 +1122,6 @@ components: to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef ManoServiceInterface: description: > @@ -1604,6 +1604,12 @@ components: * NOTE: A cardinality greater than one supports having different interface versions or api Endpoints to be used for accessing the same instance of an NFV-MANO service. type: object + required: + - id + - name + - description + - manoServiceInterfaceIds + - _links properties: id: description: > @@ -1646,12 +1652,6 @@ components: minItems: 1 required: - manoServiceInterfaces - required: - - id - - name - - description - - manoServiceInterfaceIds - - _links NfvoSpecificInfo: description: > @@ -1661,6 +1661,9 @@ components: of the specification. For instance, "ETSI GS NFV-SOL 001 (V2.5.1)". NOTE 2: If this attribute is not present, the value of this parameter is undefined. type: object + required: + - supportedVnfdFormats + - supportedNsdFormats properties: maxOnboardedNsdNum: description: > @@ -1720,9 +1723,6 @@ components: required: - nsdFormat - standardVersion - required: - - supportedVnfdFormats - - supportedNsdFormats VnfmSpecificInfo: description: > @@ -1731,6 +1731,10 @@ components: * NOTE: The information to be provided in this attribute shall relate to the specification and version of the specification. For instance, "ETSI GS NFV-SOL 001 (V2.5.1)". type: object + required: + - resoruceMgmtModeSupport + - managedVnfInstanceInfos + - supportedVnfdFormats properties: resoruceMgmtModeSupport: description: > @@ -1782,10 +1786,6 @@ components: - vnfdFormat - standardVersion minItems: 1 - required: - - resoruceMgmtModeSupport - - managedVnfInstanceInfos - - supportedVnfdFormats VimSpecificInfo: description: > @@ -1866,6 +1866,10 @@ components: This type represents list of parameters that can be configured on the NFV MANO functional entity. type: object + required: + - clockSyncs + - defaultLogCompileBySizeValue + - defaultLogCompileByTimerValue properties: clockSyncs: description: > @@ -1886,10 +1890,6 @@ components: description: Default value for the log compilation by timer to be used. $ref: "../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt" - required: - - clockSyncs - - defaultLogCompileBySizeValue - - defaultLogCompileByTimerValue ConsumedManoInterfaceInfo: description: > @@ -1905,6 +1905,13 @@ components: modify the value of the security sensitive attribute, and the modification request includes new attribute values, the whole modification request shall be rejected, and proper error information returned. type: object + required: + - id + - name + - type + - standardVersion + - apiVersion + - apiEndpoint properties: name: description: > @@ -1966,13 +1973,6 @@ components: Security related information including credentials information if needed for consuming the API. See note 2. $ref: "#/components/schemas/ClientInterfaceSecurityInfo" - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint CimNotificationsFilter: description: > @@ -2008,6 +2008,8 @@ components: This type represents parameters for connecting to an NTP server. * NOTE: Either ipAddress or hostname shall be set, but not both at the same time. type: object + required: + - type properties: type: description: > @@ -2038,8 +2040,6 @@ components: Information for the other types of clock synchronization. May be present if type = "OTHER". $ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs" - required: - - type ServerInterfaceSecurityInfo: description: > @@ -3056,7 +3056,7 @@ components: description: > 303 SEE OTHER - SShall be returned when a subscription with the same + Shall be returned when a subscription with the same callbackURI and the same filter already exists and the policy of NFV-MANO functional entity is to not create redundant subscriptions. diff --git a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml index 8fcec91..492c0a6 100644 --- a/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml +++ b/src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml @@ -164,6 +164,15 @@ components: configuration and information of the NFV-MANO functional entity have been changed. type: object + required: + - id + - notificationType + - subscriptionId + - timeStamp + - informationChangedTime + - manoEntityId + - changedInfo + - _links properties: id: description: > @@ -212,20 +221,21 @@ components: $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" required: - self - required: - - id - - notificationType - - subscriptionId - - timeStamp - - informationChangedTime - - manoEntityId - - changedInfo - - _links ChangeStateNotification: description: > This type represents a Change state operation occurrence. type: object + required: + - id + - notificationType + - subscriptionId + - timestamp + - changeStateOpOccId + - stateChangedTime + - changeStateOperationState + - managedObjectRef + - _links properties: id: description: > @@ -297,14 +307,4 @@ components: required: - subscription - objectInstance - - changeStateOpOcc - required: - - id - - notificationType - - subscriptionId - - timestamp - - changeStateOpOccId - - stateChangedTime - - changeStateOperationState - - managedObjectRef - - _links \ No newline at end of file + - changeStateOpOcc \ No newline at end of file diff --git a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml index 845d14d..bed4c73 100644 --- a/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml +++ b/src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml @@ -576,7 +576,7 @@ components: description: > 303 SEE OTHER - SShall be returned when a subscription with the same + Shall be returned when a subscription with the same callbackURI and the same filter already exists and the policy of NFV-MANO functional entity is to not create redundant subscriptions. diff --git a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml index b0cfcfc..1f62c8c 100644 --- a/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml +++ b/src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml @@ -238,8 +238,8 @@ paths: requestBody: $ref: "#/components/requestBodies/CompileLogRequest" responses: - "200": - $ref: '#/components/responses/LogReportCompiled.Post.200' + "201": + $ref: '#/components/responses/LogReportCompiled.Post.201' "202": $ref: '#/components/responses/LogReportCompiled.Post.202' "303": @@ -472,7 +472,9 @@ components: responses: Subscription.Delete.204: - description: >- + description: > + 204 NO CONTENT + Shall be returned when the "Individual subscription" resource has been deleted successfully. The response body shall be empty. headers: @@ -494,7 +496,9 @@ components: type: string Subscription.Get.200: - description: >- + description: > + 200 OK + Shall be returned when the subscription has been read successfully. The response body shall contain a representation of the "Individual subscription" resource, as defined in clause 8.6.2.3. @@ -521,7 +525,9 @@ components: $ref: "#/components/schemas/LogmSubscription" Subscriptions.Get.200: - description: >- + description: > + 200 OK + Shall be returned when the list of subscriptions has been queried successfully. The response body shall contain in an array the representations of all active subscriptions of the functional block that invokes the method, i.e. zero or more representations of log management @@ -556,7 +562,9 @@ components: $ref: "#/components/schemas/LogmSubscription" Subscriptions.Post.201: - description: >- + description: > + 201 CREATED + Shall be returned when the subscription has been created successfully. A representation of the created "Individual subscription" resource shall be returned in the response body, as defined in clause 8.6.2.3. @@ -590,7 +598,9 @@ components: $ref: "#/components/schemas/LogmSubscription" Subscriptions.Post.303: - description: >- + description: > + 303 SEE OTHER + Shall be returned when a subscription with the same callbackURI and the same filter already exists and the policy of the NFV-MANO functional entity is to not create redundant subscriptions. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing @@ -619,8 +629,10 @@ components: schema: type: string - LogReportCompiled.Post.200: - description: >- + LogReportCompiled.Post.201: + description: > + 201 CREATED + Shall be returned for a successful compilation of the log data and creation of the associated log report (synchronous mode). The response body shall contain a representation of the log report resource, as defined in clause 8.6.2.7. @@ -655,7 +667,7 @@ components: subscriptions.post.422: description: > - 422 Unprocessable Entity + 422 UNPROCESSABLE ENTITY Shall be returned upon the following error: The content type of the payload body is supported and the payload body of a request @@ -690,7 +702,9 @@ components: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" LogReportCompiled.Post.202: - description: >- + description: > + 202 ACCEPTED + Shall be returned when the request has been accepted for processing, and it is expected to take some time to compile the log file and create the associated log report (asynchronous mode). The response body shall be empty. @@ -721,7 +735,9 @@ components: type: string LogReportCompiled.Post.303: - description: >- + description: > + 303 SEE OTHER + Shall be returned when a log data compilation and report creation is already ongoing, or a log report has just been created, for the specified logging job at the time of processing the request. The response body shall be empty. @@ -752,7 +768,9 @@ components: type: string LogReportCompiled.Post.422: - description: >- + description: > + 422 UNPROCESSABLE ENTITY + The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence of the response body. Specifically, in case of this task resource, the response code 422 shall also be returned if the @@ -783,7 +801,9 @@ components: $ref: '../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails' LogReport.Get.200: - description: >- + description: > + 200 OK + Shall be returned when information of an individual log report has been read successfully. The response body shall contain a representation of the "Individual log report" resource, as defined in clause 8.6.2.7. @@ -810,7 +830,9 @@ components: $ref: "#/components/schemas/LogReport" LogReport.Get.202: - description: >- + description: > + 202 ACCEPTED + Shall be returned if the creation of the log report is ongoing and no log report is available yet (applicable in asynchronous mode of the "Compile log task" resource). The response body shall be empty. @@ -833,7 +855,9 @@ components: type: string IndividualLoggingJob.Get.200: - description: >- + description: > + 200 OK + Shall be returned when information about an individual logging job has been read successfully. The response body shall contain a representation of the "Individual logging job" resource, as defined in clause 8.6.2.6. @@ -860,7 +884,9 @@ components: $ref: "#/components/schemas/LoggingJob" IndividualLoggingJob.Delete.204: - description: >- + description: > + 204 NO CONTENT + Shall be returned when the logging job has been deleted successfully. The response body shall be empty. headers: @@ -878,7 +904,9 @@ components: type: string LoggingJobs.Post.201: - description: >- + description: > + 201 CREATED + The response body contains the Application Context as it was created by the MEC system headers: @@ -904,7 +932,9 @@ components: $ref: "#/components/schemas/LoggingJob" LoggingJobs.Get.200: - description: >- + description: > + 200 OK + Shall be returned when information about zero or more logging jobs has been queried successfully. The response body shall contain in an array the representations of zero or more logging jobs, as @@ -943,7 +973,9 @@ components: $ref: "#/components/schemas/LoggingJob" LogReportAvailableNotification.Post.204: - description: >- + description: > + 204 NO CONTENT + Shall be returned when the notification has been delivered successfully. headers: Content-Type: @@ -964,7 +996,9 @@ components: type: string LogReportAvailableNotification.Get.204: - description: >- + description: > + 204 NO CONTENT + Shall be returned to indicate that the notification endpoint has been tested successfully. The response body shall be empty. headers: diff --git a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml index 156f94b..aafde55 100644 --- a/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml +++ b/src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml @@ -245,7 +245,7 @@ paths: - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" requestBody: - $ref: "#/components/requestBodies/CreateThesholdRequest" + $ref: "#/components/requestBodies/CreateThresholdRequest" responses: "201": $ref: "#/components/responses/Thresholds.Post.201" @@ -408,6 +408,11 @@ components: description: > This type represents a request to create a PM job. type: object + required: + - objectType + - objectInstanceIds + - criteria + - callbackUri properties: objectType: description: > @@ -457,16 +462,18 @@ components: This attribute shall only be present if the subscriber requires authorization of notifications. $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication" - required: - - objectType - - objectInstanceIds - - criteria - - callbackUri PmJob: description: > This type represents a PM job. type: object + required: + - id + - objectType + - objectInstanceIds + - criteria + - _links + - callbackUri properties: id: description: > @@ -554,18 +561,16 @@ components: $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link" required: - self - required: - - id - - objectType - - objectInstanceIds - - criteria - - _links - - callbackUri CreateThresholdRequest : description: > This type represents a request to create a threshold. type: object + required: + - objectType + - objectInstanceId + - criteria + - callbackUri properties: objectType: description: > @@ -608,16 +613,19 @@ components: This attribute shall only be present if the subscriber requires authorization of notifications. $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication" + + Threshold: + description: > + This type represents a threshold. + type: object required: + - id - objectType - objectInstanceId + - subjObjectInstanceIds - criteria + - _links - callbackUri - - Threshold: - description: > - - type: object properties: id: description: > @@ -672,14 +680,6 @@ components: $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link" required: - self - required: - - id - - objectType - - objectInstanceId - - subjObjectInstanceIds - - criteria - - _links - - callbackUri PerformanceReport: description: > @@ -687,6 +687,8 @@ components: entity to the API consumer as a result of collecting performance information as part of a PM job. type: object + required: + - entries properties: entries: description: > @@ -750,8 +752,6 @@ components: - performanceMetric - performanceValues minItems: 1 - required: - - entries PmJobModifications: description: > @@ -803,6 +803,9 @@ components: * NOTE 2: In particular when choosing short collection and reporting periods, the number of PM jobs that can be supported depends on the capability of the producing entity. type: object + required: + - collectionPeriod + - reportingPeriod properties: performanceMetric: description: > @@ -840,9 +843,6 @@ components: The boundary shall allow a single reporting as well as periodic reporting up to the boundary. $ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime" - required: - - collectionPeriod - - reportingPeriod ThresholdCriteria: description: > @@ -853,6 +853,9 @@ 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). type: object + required: + - performanceMetric + - thresholdType properties: performanceMetric: description: > @@ -898,9 +901,6 @@ components: required: - thresholdValue - hysteresis - required: - - performanceMetric - - thresholdType #---------------- # common types to SOL009 @@ -1584,7 +1584,7 @@ components: $ref: "#/components/schemas/CreatePmJobRequest" required: true - CreateThesholdRequest: + CreateThresholdRequest: description: > Request parameters to create a threshold. content: diff --git a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml index f4e6537..25b9099 100644 --- a/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml +++ b/src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml @@ -167,6 +167,17 @@ components: The notification shall be triggered by the NFV-MANO functional entity when a threshold has been crossed. type: object + required: + - id + - notificationType + - timeStamp + - thresholdId + - crossingDirection + - objectType + - objectInstanceId + - performanceMetric + - performanceValue + - _links properties: id: description: > @@ -241,22 +252,19 @@ components: $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink" required: - objectInstance + + PerformanceInformationAvailableNotification: + description: > + This notification informs the receiver that performance information is available. + type: object required: - id - notificationType + - pmJobId - timeStamp - - thresholdId - - crossingDirection - objectType - objectInstanceId - - performanceMetric - - performanceValue - _links - - PerformanceInformationAvailableNotification: - description: > - This notification informs the receiver that performance information is available. - type: object properties: id: description: > @@ -323,12 +331,4 @@ components: required: - pmJob - performanceReport - required: - - id - - notificationType - - pmJobId - - timeStamp - - objectType - - objectInstanceId - - _links -- GitLab