Skip to content
GitLab
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
Hide whitespace changes
Inline Side-by-side
src/SOL009/APIVersion/APIVersion.yaml
View file @ 08cc532f
......@@ -19,8 +19,8 @@ info:
version: 1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
paths:
/nfvmanocim/api_versions:
......
src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml
View file @ 08cc532f
......@@ -16,11 +16,11 @@ info:
license:
name: ETSI Forge copyright notice
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:
description: ETSI GS NFV-SOL 009 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf
description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers:
- url: http://127.0.0.1/nfvmanocim/v2
......@@ -807,7 +807,10 @@ components:
name: subscriptionId
in: path
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
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
......@@ -825,7 +828,11 @@ components:
name: peerEntityId
in: path
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
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
......@@ -1413,10 +1420,10 @@ components:
maximum: 1
Subscriptions.Post.422:
description: >
422 Unprocessable Entity
422 Unprocessable Content
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.
The general cause for this error and its handling is specified in
......
src/SOL009/NFVManoConfigurationAndInformationManagement/components/NFVManoConfigurationAndInformationManagement_def.yaml
View file @ 08cc532f
......@@ -735,11 +735,11 @@ components:
PeerEntity:
description: >
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
"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
......@@ -1477,6 +1477,7 @@ components:
Permitted values:
- 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
in IETF RFC 6749.
type: array
......@@ -1568,6 +1569,7 @@ components:
Permitted values:
- 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
in IETF RFC 6749.
type: array
......
src/SOL009/NFVManoConfigurationAndInformationManagementNotification/NFVManoConfigurationAndInformationManagementNotification.yaml
View file @ 08cc532f
......@@ -16,11 +16,11 @@ info:
license:
name: ETSI Forge copyright notice
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:
description: ETSI GS NFV-SOL 009 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf
description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers:
- url: http://127.0.0.1/callback/v2
......
src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml
View file @ 08cc532f
......@@ -19,8 +19,8 @@ info:
version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf
description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers:
- url: http://127.0.0.1/nfvmanofm/v1
......@@ -162,7 +162,7 @@ paths:
"406":
$ref: ../components/SOL009_resp.yaml#/components/responses/406
"422":
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: '#/components/responses/Subscriptions.Post.422'
"500":
$ref: ../components/SOL009_resp.yaml#/components/responses/500
"503":
......@@ -304,7 +304,7 @@ components:
Identifier of the alarm. This identifier can be retrieved from the
"id" attribute of the "alarm" attribute in the AlarmNotification or
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.
in: path
required: true
......@@ -316,7 +316,7 @@ components:
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 payload body
It can also be retrieved from the "id" attribute in the message content
of that response.
in: path
required: true
......@@ -511,10 +511,10 @@ components:
maximum: 1
Subscriptions.Post.422:
description: >
422 Unprocessable Entity
422 Unprocessable Content
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.
The general cause for this error and its handling is specified in
......
src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml
View file @ 08cc532f
......@@ -19,8 +19,8 @@ info:
version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf
description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers:
- url: http://127.0.0.1/callback/v1
......
src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml
View file @ 08cc532f
......@@ -19,8 +19,8 @@ info:
version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf
description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers:
- url: http://127.0.0.1/nfvmanologm/v1
......@@ -285,7 +285,7 @@ paths:
"303":
$ref: '#/components/responses/Subscriptions.Post.303'
"422":
$ref: '../components/SOL009_resp.yaml#/components/responses/422'
$ref: '#/components/responses/Subscriptions.Post.422'
"400":
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
"401":
......@@ -423,6 +423,7 @@ components:
required: false
schema:
type: string
exclude_default.LoggingJobs:
name: exclude_default
description: >
......@@ -436,6 +437,7 @@ components:
required: false
schema:
type: string
filter.LogmSubscriptions:
name: filter
description: >
......@@ -450,27 +452,39 @@ components:
required: false
schema:
type: string
logJobId:
name: logJobId
in: path
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
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
logReportId:
name: logReportId
in: path
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
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
subscriptionId:
name: subscriptionId
in: path
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
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
......@@ -494,6 +508,7 @@ components:
schema:
$ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/CreateLoggingJobRequest"
required: true
CompileLogRequest:
description: >-
Log compilation request.
......@@ -502,6 +517,7 @@ components:
schema:
$ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/CompileLogRequest"
required: true
LogReportAvailableNotification:
description: >-
Notification about the availability of a log report.
......@@ -670,20 +686,25 @@ components:
schema:
type: string
LogReportCompiled.Post.201:
Subscriptions.Post.422:
description: >
201 CREATED
422 UNPROCESSABLE CONTENT
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.
The HTTP response shall include a "Location" HTTP header that indicate the URI of the
"Individual log report" resource just created
Shall be returned upon the following error: The content type
of the message content is supported and the message content 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:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
......@@ -696,35 +717,25 @@ components:
Version of the API used in the response.
schema:
type: string
Location:
description: >
URI of the "Individual log report" resource just created
schema:
type: string
content:
application/json:
schema:
$ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogReport"
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
subscriptions.post.422:
LogReportCompiled.Post.201:
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.
201 CREATED
In this case, the "detail" attribute in the "ProblemDetails" structure
shall convey more information about the error.
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.
The HTTP response shall include a "Location" HTTP header that indicate the URI of the
"Individual log report" resource just created
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
......@@ -737,10 +748,15 @@ components:
Version of the API used in the response.
schema:
type: string
Location:
description: >
URI of the "Individual log report" resource just created
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
$ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogReport"
LogReportCompiled.Post.202:
description: >
......@@ -810,12 +826,12 @@ components:
LogReportCompiled.Post.422:
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,
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
"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.
The response body shall contain a ProblemDetails structure, in which the "detail" attribute should
convey more information about the error.
......
src/SOL009/NFVManoLogManagement/components/NFVManoLogManagement_def.yaml
View file @ 08cc532f
......@@ -487,8 +487,8 @@ components:
requestMethod:
description: >-
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
shall support this attribute.
same as the value of this attribute. Valid values are specified in IETF RFC 9110 and IETF RFC 5789.
The API producer shall support this attribute.
type: string
requestUriPattern:
description: >-
......
src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml
View file @ 08cc532f
......@@ -19,8 +19,8 @@ info:
version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf
description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers:
- url: http://127.0.0.1/callback/v1
......
src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml
View file @ 08cc532f
......@@ -20,8 +20,8 @@ info:
version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf
description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers:
- url: http://127.0.0.1/nfvmanopm/v2
......@@ -434,10 +434,10 @@ components:
$ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/PmJob"
pm_jobs.Post.422:
description: >
422 Unprocessable Entity
422 Unprocessable Content
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.
The general cause for this error and its handling is specified in
......@@ -630,10 +630,10 @@ components:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
IndividualPmJob.Patch.422:
description: >
422 Unprocessable Entity
422 Unprocessable Content
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.
The general cause for this error and its handling is specified in
......@@ -752,10 +752,10 @@ components:
$ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/Threshold"
Thresholds.Post.422:
description: >
422 Unprocessable Entity
422 Unprocessable Content
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.
The general cause for this error and its handling is specified in
......@@ -936,10 +936,10 @@ components:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
Threshold.Patch.422:
description: >
422 Unprocessable Entity
422 Unprocessable Content
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.
The general cause for this error and its handling is specified in
......@@ -1048,7 +1048,10 @@ components:
name: pmJobId
in: path
description: >-
Identifier of the PM Job
Identifier of the PM 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 PM job resource. It can also be retrieved from the "id" attribute
in the message content of that response.
required: true
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
......@@ -1066,7 +1069,10 @@ components:
name: thresholdId
in: path
description: >-
Identifier of the PM threshold
Identifier of the threshold. This identifier can be retrieved from the resource
referenced by the "Location" HTTP header in the response to a POST request creating
a new threshold resource. It can also be retrieved from the "id" attribute in the
message content of that response.
required: true
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
......
src/SOL009/NFVManoPerformanceManagementNotification/NFVManoPerformanceManagementNotification.yaml
View file @ 08cc532f
......@@ -19,8 +19,8 @@ info:
version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 009 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf
description: ETSI GS NFV-SOL 009 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers:
- url: http://127.0.0.1/callback/v2
......
src/SOL009/components/SOL009_resp.yaml
View file @ 08cc532f
......@@ -74,7 +74,7 @@ components:
"ProblemDetails" structure to be returned.
If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect
query parameters or the payload body contains a syntactically incorrect data structure),
query parameters or the message content contains a syntactically incorrect data structure),
the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided,
and should include in the "detail" attribute more information about the source of the problem.
......@@ -206,7 +206,7 @@ components:
This response code is not appropriate in case the resource addressed by the URI is a container resource
which is designed to contain child resources, but does not contain any child resource at the time
the request is received. For a GET request to an existing empty container resource, a typical response
contains a 200 OK response code and a payload body with an empty array.
contains a 200 OK response code and a message content with an empty array.
headers:
Content-Type:
description: The MIME type of the body of the response.
......@@ -375,7 +375,7 @@ components:
description: >
413 PAYLOAD TOO LARGE
If the payload body of a request is larger than the amount of data the API producer is willing or able to process,
If the message content of a request is larger than the amount of data the API producer is willing or able to process,
it shall respond with this response code, following the provisions in IETF RFC 7231 for the use
of the "Retry-After" HTTP header and for closing the connection. The "ProblemDetails" structure may be omitted.
headers:
......@@ -474,9 +474,9 @@ components:
422:
description: >
422 UNPROCESSABLE ENTITY
422 UNPROCESSABLE CONTENT
If the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data
If the message content of a request contains syntactically correct data (e.g. well-formed JSON) but the data
cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond
with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail"
attribute more information about the source of the problem.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment