Commit 08cc532f authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

Merge branch '3.7.1-dev' into 'master'

3.7.1 dev

See merge request !6
parents fc28d2d4 144afcd2
Pipeline #13903 passed with stage
in 0 seconds
...@@ -19,8 +19,8 @@ info: ...@@ -19,8 +19,8 @@ info:
version: 1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 version: 1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1 description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
paths: paths:
/nfvmanocim/api_versions: /nfvmanocim/api_versions:
......
...@@ -16,11 +16,11 @@ info: ...@@ -16,11 +16,11 @@ info:
license: license:
name: ETSI Forge copyright notice name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 version: 2.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1 description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers: servers:
- url: http://127.0.0.1/nfvmanocim/v2 - url: http://127.0.0.1/nfvmanocim/v2
...@@ -807,7 +807,10 @@ components: ...@@ -807,7 +807,10 @@ components:
name: subscriptionId name: subscriptionId
in: path in: path
description: >- description: >-
Identifier of the subscription Identifier of this subscription. This identifier can be retrieved from the
resource referenced by the "Location" HTTP header in the response to a POST
request creating a new "Individual subscription" resource. It can also be
retrieved from the "id" attribute in the message content of that response.
required: true required: true
schema: schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
...@@ -825,7 +828,11 @@ components: ...@@ -825,7 +828,11 @@ components:
name: peerEntityId name: peerEntityId
in: path in: path
description: > description: >
Identifier of the peer entity Identifier of the peer functional entity. This identifier can be retrieved
from the resource referenced by the "Location" HTTP header in the response
to a POST request creating a new "Individual peer entity" resource.
It can also be retrieved from the "id" attribute in the message content of
that response.
required: true required: true
schema: schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
...@@ -1413,10 +1420,10 @@ components: ...@@ -1413,10 +1420,10 @@ components:
maximum: 1 maximum: 1
Subscriptions.Post.422: Subscriptions.Post.422:
description: > description: >
422 Unprocessable Entity 422 Unprocessable Content
Shall be returned upon the following error: The content type Shall be returned upon the following error: The content type
of the payload body is supported and the payload body of a request of the message content is supported and the message content of a request
contains syntactically correct data but the data cannot be processed. contains syntactically correct data but the data cannot be processed.
The general cause for this error and its handling is specified in The general cause for this error and its handling is specified in
......
...@@ -735,11 +735,11 @@ components: ...@@ -735,11 +735,11 @@ components:
PeerEntity: PeerEntity:
description: > description: >
This type represents an individual peer entity. This type represents an individual peer entity.
* NOTE: ETSI GS NFV-IFA 031 defines an additional attribute named "apiDiscoveryEndpoint" in the
PeerManoEntity. The modelling of this attribute is not specified in the present document version.
* NOTE 1: The value of the "peerEntityId" attribute is the same as the value of the "id" attribute in the * 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 "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. 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 type: object
required: required:
- id - id
...@@ -1477,6 +1477,7 @@ components: ...@@ -1477,6 +1477,7 @@ components:
Permitted values: Permitted values:
- TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.
- TLS_TUNNEL_13: Using TLS tunnel, as defined by TLS 1.3 in IETF RFC 8446.
- OAUTH2: Using access token, as defined by the OAuth 2.0 specification - OAUTH2: Using access token, as defined by the OAuth 2.0 specification
in IETF RFC 6749. in IETF RFC 6749.
type: array type: array
...@@ -1568,6 +1569,7 @@ components: ...@@ -1568,6 +1569,7 @@ components:
Permitted values: Permitted values:
- TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.
- TLS_TUNNEL_13: Using TLS tunnel, as defined by TLS 1.3 in IETF RFC 8446.
- OAUTH2: Using access token, as defined by the OAuth 2.0 specification - OAUTH2: Using access token, as defined by the OAuth 2.0 specification
in IETF RFC 6749. in IETF RFC 6749.
type: array type: array
......
...@@ -16,11 +16,11 @@ info: ...@@ -16,11 +16,11 @@ info:
license: license:
name: ETSI Forge copyright notice name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 version: 2.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1 description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers: servers:
- url: http://127.0.0.1/callback/v2 - url: http://127.0.0.1/callback/v2
......
...@@ -19,8 +19,8 @@ info: ...@@ -19,8 +19,8 @@ info:
version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1 description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers: servers:
- url: http://127.0.0.1/nfvmanofm/v1 - url: http://127.0.0.1/nfvmanofm/v1
...@@ -162,7 +162,7 @@ paths: ...@@ -162,7 +162,7 @@ paths:
"406": "406":
$ref: ../components/SOL009_resp.yaml#/components/responses/406 $ref: ../components/SOL009_resp.yaml#/components/responses/406
"422": "422":
$ref: ../components/SOL009_resp.yaml#/components/responses/422 $ref: '#/components/responses/Subscriptions.Post.422'
"500": "500":
$ref: ../components/SOL009_resp.yaml#/components/responses/500 $ref: ../components/SOL009_resp.yaml#/components/responses/500
"503": "503":
...@@ -304,7 +304,7 @@ components: ...@@ -304,7 +304,7 @@ components:
Identifier of the alarm. This identifier can be retrieved from the Identifier of the alarm. This identifier can be retrieved from the
"id" attribute of the "alarm" attribute in the AlarmNotification or "id" attribute of the "alarm" attribute in the AlarmNotification or
AlarmClearedNotification. It can also be retrieved from the "id" AlarmClearedNotification. It can also be retrieved from the "id"
attribute of the applicable array element in the payload body of the attribute of the applicable array element in the message content of the
response to a GET request to the "Alarms" resource. response to a GET request to the "Alarms" resource.
in: path in: path
required: true required: true
...@@ -316,7 +316,7 @@ components: ...@@ -316,7 +316,7 @@ components:
Identifier of this subscription. This identifier can be retrieved from Identifier of this subscription. This identifier can be retrieved from
the resource referenced by the "Location" HTTP header in the response the resource referenced by the "Location" HTTP header in the response
to a POST request creating a new "Individual subscription" resource. to a POST request creating a new "Individual subscription" resource.
It can also be retrieved from the "id" attribute in the payload body It can also be retrieved from the "id" attribute in the message content
of that response. of that response.
in: path in: path
required: true required: true
...@@ -511,10 +511,10 @@ components: ...@@ -511,10 +511,10 @@ components:
maximum: 1 maximum: 1
Subscriptions.Post.422: Subscriptions.Post.422:
description: > description: >
422 Unprocessable Entity 422 Unprocessable Content
Shall be returned upon the following error: The content type Shall be returned upon the following error: The content type
of the payload body is supported and the payload body of a request of the message content is supported and the message content of a request
contains syntactically correct data but the data cannot be processed. contains syntactically correct data but the data cannot be processed.
The general cause for this error and its handling is specified in The general cause for this error and its handling is specified in
......
...@@ -19,8 +19,8 @@ info: ...@@ -19,8 +19,8 @@ info:
version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1 description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers: servers:
- url: http://127.0.0.1/callback/v1 - url: http://127.0.0.1/callback/v1
......
...@@ -19,8 +19,8 @@ info: ...@@ -19,8 +19,8 @@ info:
version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1 description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers: servers:
- url: http://127.0.0.1/nfvmanologm/v1 - url: http://127.0.0.1/nfvmanologm/v1
...@@ -285,7 +285,7 @@ paths: ...@@ -285,7 +285,7 @@ paths:
"303": "303":
$ref: '#/components/responses/Subscriptions.Post.303' $ref: '#/components/responses/Subscriptions.Post.303'
"422": "422":
$ref: '../components/SOL009_resp.yaml#/components/responses/422' $ref: '#/components/responses/Subscriptions.Post.422'
"400": "400":
$ref: '../components/SOL009_resp.yaml#/components/responses/400' $ref: '../components/SOL009_resp.yaml#/components/responses/400'
"401": "401":
...@@ -423,6 +423,7 @@ components: ...@@ -423,6 +423,7 @@ components:
required: false required: false
schema: schema:
type: string type: string
exclude_default.LoggingJobs: exclude_default.LoggingJobs:
name: exclude_default name: exclude_default
description: > description: >
...@@ -436,6 +437,7 @@ components: ...@@ -436,6 +437,7 @@ components:
required: false required: false
schema: schema:
type: string type: string
filter.LogmSubscriptions: filter.LogmSubscriptions:
name: filter name: filter
description: > description: >
...@@ -450,27 +452,39 @@ components: ...@@ -450,27 +452,39 @@ components:
required: false required: false
schema: schema:
type: string type: string
logJobId: logJobId:
name: logJobId name: logJobId
in: path in: path
description: >- description: >-
Identifier of the logging job. Identifier of the logging job. This identifier can be retrieved from the
resource referenced by the "Location" HTTP header in the response to a
POST request creating a new "Individual logging job" resource.
It can also be retrieved from the "id" attribute in the message content of
that response.
required: true required: true
schema: schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
logReportId: logReportId:
name: logReportId name: logReportId
in: path in: path
description: >- description: >-
Identifier of the report. Identifier of the log report. This identifier can be retrieved from:
a) the "logReportsIds" attribute of the applicable element in the message content
of the response to a GET request to a logging job (see clause 8.6.2.6), and
b) the "logReport" attribute available from a LogReportAvailableNotification.
required: true required: true
schema: schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
subscriptionId: subscriptionId:
name: subscriptionId name: subscriptionId
in: path in: path
description: >- description: >-
Identifier of the subscription Identifier of the subscription. This identifier can be retrieved from the resource referenced by the "Location"
HTTP header in the response to a POST request creating a new "Individual subscription" resource.
It can also be retrieved from the "id" attribute in the message content of that response.
required: true required: true
schema: schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
...@@ -494,6 +508,7 @@ components: ...@@ -494,6 +508,7 @@ components:
schema: schema:
$ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/CreateLoggingJobRequest" $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/CreateLoggingJobRequest"
required: true required: true
CompileLogRequest: CompileLogRequest:
description: >- description: >-
Log compilation request. Log compilation request.
...@@ -502,6 +517,7 @@ components: ...@@ -502,6 +517,7 @@ components:
schema: schema:
$ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/CompileLogRequest" $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/CompileLogRequest"
required: true required: true
LogReportAvailableNotification: LogReportAvailableNotification:
description: >- description: >-
Notification about the availability of a log report. Notification about the availability of a log report.
...@@ -670,20 +686,25 @@ components: ...@@ -670,20 +686,25 @@ components:
schema: schema:
type: string type: string
LogReportCompiled.Post.201: Subscriptions.Post.422:
description: > description: >
201 CREATED 422 UNPROCESSABLE CONTENT
Shall be returned for a successful compilation of the log data and creation of the associated log report Shall be returned upon the following error: The content type
(synchronous mode). of the message content is supported and the message content of a request
The response body shall contain a representation of the log report resource, as defined in clause 8.6.2.7. contains syntactically correct data but the data cannot be processed.
The HTTP response shall include a "Location" HTTP header that indicate the URI of the
"Individual log report" resource just created 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: headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate: WWW-Authenticate:
description: > description: >
Challenge if the corresponding HTTP request has not provided Challenge if the corresponding HTTP request has not provided
...@@ -696,35 +717,25 @@ components: ...@@ -696,35 +717,25 @@ components:
Version of the API used in the response. Version of the API used in the response.
schema: schema:
type: string type: string
Location:
description: >
URI of the "Individual log report" resource just created
schema:
type: string
content: content:
application/json: application/json:
schema: schema:
$ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogReport" $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
subscriptions.post.422: LogReportCompiled.Post.201:
description: > description: >
422 UNPROCESSABLE ENTITY 201 CREATED
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 be returned for a successful compilation of the log data and creation of the associated log report
shall convey more information about the error. (synchronous mode).
The response body shall contain a representation of the log report resource, as defined in clause 8.6.2.7.
The HTTP response shall include a "Location" HTTP header that indicate the URI of the
"Individual log report" resource just created
headers: headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate: WWW-Authenticate:
description: > description: >
Challenge if the corresponding HTTP request has not provided Challenge if the corresponding HTTP request has not provided
...@@ -737,10 +748,15 @@ components: ...@@ -737,10 +748,15 @@ components:
Version of the API used in the response. Version of the API used in the response.
schema: schema:
type: string type: string
Location:
description: >
URI of the "Individual log report" resource just created
schema:
type: string
content: content:
application/json: application/json:
schema: schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogReport"
LogReportCompiled.Post.202: LogReportCompiled.Post.202:
description: > description: >
...@@ -810,12 +826,12 @@ components: ...@@ -810,12 +826,12 @@ components:
LogReportCompiled.Post.422: LogReportCompiled.Post.422:
description: > description: >
422 UNPROCESSABLE ENTITY 422 UNPROCESSABLE CONTENT
The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, 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. 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 Specifically, in case of this task resource, the response code 422 shall also be returned if the
"objectInstanceId" value provided in the payload body of the request does not correspond to an object "objectInstanceId" value provided in the message content of the request does not correspond to an object
instance for which log data is being collected by the logging job represented by this resource. instance for which log data is being collected by the logging job represented by this resource.
The response body shall contain a ProblemDetails structure, in which the "detail" attribute should The response body shall contain a ProblemDetails structure, in which the "detail" attribute should
convey more information about the error. convey more information about the error.
......
...@@ -487,8 +487,8 @@ components: ...@@ -487,8 +487,8 @@ components:
requestMethod: requestMethod:
description: >- description: >-
HTTP request method to be matched. To match, the HTTP request method of the message shall be the HTTP request method to be matched. To match, the HTTP request method of the message shall be the
same as the value of this attribute. Valid values are specified in IETF RFC 7231. The API producer same as the value of this attribute. Valid values are specified in IETF RFC 9110 and IETF RFC 5789.
shall support this attribute. The API producer shall support this attribute.
type: string type: string
requestUriPattern: requestUriPattern:
description: >- description: >-
......
...@@ -19,8 +19,8 @@ info: ...@@ -19,8 +19,8 @@ info:
version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1 description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers: servers:
- url: http://127.0.0.1/callback/v1 - url: http://127.0.0.1/callback/v1
......
...@@ -20,8 +20,8 @@ info: ...@@ -20,8 +20,8 @@ info:
version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1 description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers: servers:
- url: http://127.0.0.1/nfvmanopm/v2 - url: http://127.0.0.1/nfvmanopm/v2
...@@ -434,10 +434,10 @@ components: ...@@ -434,10 +434,10 @@ components:
$ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/PmJob" $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/PmJob"
pm_jobs.Post.422: