Commit 7a10c8d8 authored by rameshnaraya's avatar rameshnaraya
Browse files

SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.

parent c91ca1d6
Pipeline #156 failed with stage
---
swagger: "2.0"
info:
description: "DRAFT - SOL005 - NSD 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\n"
description: >
"DRAFT - SOL005 - NSD 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: "2.4.1"
title: "DRAFT - SOL005 - NSD Management Interface"
contact:
......@@ -13,245 +14,350 @@ info:
license:
name: "ETSI Forge copyright notice"
url: "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
externalDocs:
description: "ETSI GS NFV-SOL 005 V2.4.1"
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/nsd/v1"
schemes:
- https
consumes:
- "application/json"
produces:
- "application/json"
paths:
/ns_descriptors:
###############################################################################
# NS Descriptors #
###############################################################################
'/ns_descriptors':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2.3.2
get:
summary: "Query NSD Info"
description: "The GET method queries information about multiple NS descriptor\
\ resources. This method shall follow the provisions specified in the Tables\
\ 5.4.2.3.2-1 and 5.4.2.3.2-2 of GS NFV-SOL 005 for URI query parameters,\
\ request and response data structures, and response codes."
summary: "Query information about multiple NS descriptor resources."
description: >
"The GET method queries information about multiple NS descriptor resources.
This method shall follow the provisions specified in the
Tables 5.4.2.3.2-1 and 5.4.2.3.2-2 for URI query parameters,
request and response data structures, and response codes."
parameters:
- name: "Accept"
in: "header"
required: true
type: "string"
description: "This header field shall be present if the response is expected\
\ to have a non-empty message body."
- name: "Authorization"
in: "header"
required: false
type: "string"
description: "The authorization token for the request.\nDetails are specified\
\ in clause 4.5.3 of GS NFV-SOL 005."
- name: "filter"
in: "query"
required: false
type: "string"
description: >
"Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI query
string. The OSS/BSS may supply filtering parameters.
All attribute names that appear in the NsdInfo and in data types referenced from
it shall be supported in attribute-based filtering parameters."
- name: "all_fields"
in: "query"
required: false
type: "string"
description: >
"Include all complex attributes in the response. See clause 4.3.3 for details.
The NFVO shall support this parameter."
- name: "fields"
in: "query"
required: false
type: "string"
description: >
"Complex attributes to be included into the response. See clause 4.3.3 for
details. The NFVO should support this parameter."
- name: "exclude_fields"
in: "query"
required: false
type: "string"
description: >
"Complex attributes to be excluded from the response. See clause 4.3.3 for
details. The NFVO should support this parameter."
- name: "exclude_default"
in: "query"
required: false
type: "string"
description: >
"Indicates to exclude the following complex attributes from the response. See
clause 4.3.3 for details. The VNFM shall support this parameter.
The following attributes shall be excluded from the NsdInfo structure in the
response body if this parameter is provided, or none of the parameters
"all_fields," "fields", "exclude_fields", "exclude_default" are provided:
userDefinedData."
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
responses:
200:
description: "Information about zero or more NS descriptors.\nThe response\
\ body shall contain a representation of zero or more NS descriptors,\
\ as defined in clause 5.5.2.2 of GS NFV-SOL 005."
description: >
"Information about zero or more NS descriptors.
The response body shall contain a representation of
zero or more NS descriptors, as defined in
clause 5.5.2.2"
schema:
$ref: "#/definitions/NsdInfo"
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
headers:
Content-Type:
type: "string"
description: "The MIME type of the body of the response.\nThis header\
\ field shall be present if the\nresponse has a non-empty message\
\ body."
type: string
description: The MIME type of the body of the response.
WWW-Authenticate:
type: "string"
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."
type: string
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.
400:
description: "There are two possible scenarios listed below.\n\nError: Invalid\
\ attribute-based filtering parameters. \n\nThe response body shall contain\
\ a ProblemDetails structure, in which the \"detail\" attribute should\
\ convey more information about the error.\n\nError: Invalid attribute\
\ selector. The response body shall contain a ProblemDetails structure,\
\ in which the \"detail\" attribute should convey more information about\
\ the error."
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409"
412:
$ref: "responses/SOL005_resp.yaml#/responses/412"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
post:
summary: "Create NSD Info"
description: "The POST method is used to create a new NS descriptor resource.\
\ This method shall follow the provisions specified in the Tables 5.4.2.3.1-1\
\ and 5.4.2.3.1-2 of GS NFV-SOL 005 for URI query parameters, request and\
\ response data structures, and response codes."
consumes: []
summary: "Create a new NS descriptor resource."
description: >
"The POST method is used to create a new NS descriptor resource or a new version of an on-boarded NS descriptor
resource. This method shall follow the provisions specified in the
Tables 5.4.2.3.1-1 and 5.4.2.3.1-2 for URI query parameters,
request and response data structures, and response codes."
parameters:
- name: "Accept"
in: "header"
required: false
type: "string"
description: "Content-Types that are acceptable for the\nresponse. This header\
\ field shall be present if the\nresponse is expected to have a non-empty\n\
message body."
- name: "Content-Type"
in: "header"
required: false
type: "string"
description: "The MIME type of the body of the request.\nThis header field\
\ shall be present if the\nrequest has a non-empty message body."
- name: "Authorization"
in: "header"
required: false
type: "string"
description: "The authorization token for the request.\nDetails are specified\
\ in clause 4.5.3 of GS NFV-SOL 005"
- name: "body"
- name: "createNsdInfoRequest"
description: >
"The CreateNsdInfoRequest contains parameters for creating
an NS descriptor resource, as defined in clause 5.5.2.4 of GS NFV-SOL 005."
in: "body"
required: true
schema:
type: "object"
required:
- "CreateNsdInfoRequest"
properties:
CreateNsdInfoRequest:
$ref: "#/definitions/CreateNsdInfoRequest"
description: "The CreateNsdInfoRequest contains parameters for creating\
\ an NS descriptor resource, as defined in\nclause 5.5.2.4 of GS NFV-SOL\
\ 005."
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
201:
description: "Status 201"
description: >
Status 201
An NS descriptor resource was created
successfully, as a new NS descriptor resource.
The response body shall contain a representation of
the new NS descriptor resource, as defined in
clause 5.5.2.2.
The HTTP response shall include a "Location"
HTTP header that contains the resource URI of the
new NS descriptor resource.
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409"
412:
$ref: "responses/SOL005_resp.yaml#/responses/412"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
schema:
type: "object"
description: "An NS descriptor resource was created successfully, as a\
\ new NS descriptor resource. The response body shall contain a representation\
\ of the new NS descriptor resource, as defined in clause 5.5.2.2 of\
\ GS NFV-SOL 005."
description: >
"An NS descriptor resource was created successfully, as a
new NS descriptor resource. The response body shall contain a representation
of the new NS descriptor resource, as defined in clause 5.5.2.2 of
GS NFV-SOL 005."
properties:
NsdInfo:
$ref: "#/definitions/NsdInfo"
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
headers:
Location:
type: "string"
description: "The HTTP response shall include a \"Location\" HTTP header\
\ that contains the resource URI of the new NS descriptor resource."
Content-Type:
type: "string"
description: "The MIME type of the body of the response.\nThis header\
\ field shall be present if the\nresponse has a non-empty message\
\ body."
WWW-Authenticate:
type: "string"
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."
/ns_descriptors/{nsdInfoId}:
description: >
"The HTTP response shall include a "Location" HTTP header
that contains the resource URI of the new NS descriptor resource."
###############################################################################
# Individual NS Descriptor #
###############################################################################
'/ns_descriptors/{nsdInfoId}':
get:
summary: "Query NSD Info"
description: "The GET method reads information about an individual NS descriptor.\
\ This method shall follow the provisions specified in GS NFV-SOL 005 Tables\
\ 5.4.3.3.2-1 and 5.4.3.3.2-2 of GS NFV-SOL 005 for URI query parameters,\
\ request and response data structures, and response codes."
summary: "Read information about an individual NS descriptor resource."
description: >
"The GET method reads information about an individual NS descriptor.
This method shall follow the provisions specified in GS NFV-SOL 005 Tables
5.4.3.3.2-1 and 5.4.3.3.2-2 of GS NFV-SOL 005 for URI query parameters,
request and response data structures, and response codes."
parameters:
- name: "Accept"
in: "header"
required: true
type: "string"
description: "Content-Types that are acceptable for the\nresponse. This header\
\ field shall be present \nif the response is expected to have a non-empty\
\ message body."
- name: "Authorization"
in: "header"
required: false
type: "string"
description: "The authorization token for the request.\nDetails are specified\
\ in clause 4.5.3 of GS NFV-SOL 005."
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
responses:
200:
description: "Information about the individual NS descriptor. The response\
\ body shall contain a representation of the individual NS descriptor,\
\ as defined in clause 5.5.2.2 of GS NFV-SOL 005."
description: >
200 OK
Information about the individual NS descriptor.
The response body shall contain a representation of
the individual NS descriptor, as defined in
clause 5.5.2.2.
schema:
$ref: "#/definitions/NsdInfo"
headers:
Content-Type:
type: "string"
description: "The MIME type of the body of the response. This header\
\ field shall be present if the response has a non-empty message body."
WWW-Authenticate:
type: "string"
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."
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409"
412:
$ref: "responses/SOL005_resp.yaml#/responses/412"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
delete:
summary: "Delete NSD"
description: "The DELETE method deletes an individual NS descriptor resource.\
\ An individual NS descriptor resource can only be deleted when there is no\
\ NS instance using it (i.e. usageState = NOT_IN_USE) and has been disabled\
\ already (i.e. operationalState = DISABLED). Otherwise, the DELETE method\
\ shall fail. This method shall follow the provisions specified in the Tables\
\ 5.4.3.3.5-1 and 5.4.3.3.5-2 of GS NFV-SOL 005 for URI query parameters,\
\ request and response data structures, and response codes."
summary: "Delete an individual NS descriptor resource."
description: >
"The DELETE method deletes an individual NS descriptor resource.
An individual NS descriptor resource can only be deleted when there is no
NS instance using it (i.e. usageState = NOT_IN_USE) and has been disabled
already (i.e. operationalState = DISABLED). Otherwise, the DELETE method
shall fail. This method shall follow the provisions specified in the Tables
5.4.3.3.5-1 and 5.4.3.3.5-2 of GS NFV-SOL 005 for URI query parameters,
request and response data structures, and response codes."
parameters:
- name: "Authorization"
in: "header"
required: false
type: "string"
description: "The authorization token for the request.\nDetails are specified\
\ in clause 4.5.3 of GS NFV-SOL 005."
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
responses:
204:
description: "The operation has completed successfully. The response body\
\ shall be empty."
schema:
type: "object"
description: "The operation has completed successfully. The response body\
\ shall be empty."
description: >
204 No Content
The operation has completed successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
type: "string"
description: "Challenge if the corresponding HTTP request\nhas not provided\
\ authorization, or error details if the corresponding HTTP request\
\ has provided an invalid authorization token."
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.
type: string
maximum: 1
minimum: 0
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
description: "Status 409"
schema:
required:
- "ProblemDetails"
type: "object"
description: "Error: The operation cannot be executed currently, due to\
\ a conflict with the state of the resource. Typically, this is due\
\ to the fact the NS descriptor resource is in the enabled operational\
\ state (i.e. operationalState = ENABLED) or there are running NS instances\
\ using the concerned individual NS descriptor resource (i.e. usageState\
\ = IN_USE). The response body shall contain a ProblemDetails structure,\
\ in which the \"detail\" attribute shall convey more information about\
\ the error."
properties:
ProblemDetails:
$ref: "#/definitions/ProblemDetails"
$ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409"
412:
$ref: "responses/SOL005_resp.yaml#/responses/412"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
patch:
summary: "Update NSD Info"
description: "The PATCH method modifies the operational state and/or user defined\
\ data of an individual NS descriptor resource. This method can be used to:\n\
1) Enable a previously disabled individual NS descriptor resource, allowing\
\ again its use for instantiation of new\nnetwork service with this descriptor.\
\ The usage state (i.e. \"IN_USE/NOT_IN_USE\") shall not change as a\nresult.\n\
2) Disable a previously enabled individual NS descriptor resource, preventing\
\ any further use for instantiation of\nnew network service(s) with this descriptor.\
\ The usage state (i.e. \"IN_USE/NOT_IN_USE\") shall not change\nas a result.\n\
3) Modify the user defined data of an individual NS descriptor resource.\n\
This method shall follow the provisions specified in the Tables 5.4.3.3.4-1\
\ and 5.4.3.3.4-2 for URI query parameters,\nrequest and response data structures,\
\ and response codes."
consumes: []
description: >
"The PATCH method modifies the operational state and/or user defined
data of an individual NS descriptor resource. This method can be used to:
1) Enable a previously disabled individual NS descriptor resource, allowing
again its use for instantiation of new network service with this descriptor.
The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change as result.
2) Disable a previously enabled individual NS descriptor resource, preventing
any further use for instantiation of new network service(s) with this descriptor.
The usage state (i.e. "IN_USE/NOT_IN_USE") shall not changes a result.
3) Modify the user defined data of an individual NS descriptor resource.
This method shall follow the provisions specified in the Tables 5.4.3.3.4-1
and 5.4.3.3.4-2 for URI query parameters,request and response data structures,
and response codes."
parameters:
- name: "Accept"
in: "header"
required: true
type: "string"
description: "Content-Types that are acceptable for the\nresponse. This header\
\ field shall be present if the response is expected to have a non-empty\
\ message body."
- name: "Content-Type"
in: "header"
required: true
type: "string"
description: "The MIME type of the body of the request.\nThis header field\
\ shall be present if the\nrequest has a non-empty message body."
- name: "Authorization"
in: "header"
required: false
type: "string"
description: "The authorization token for the request.\nDetails are specified\
\ in clause 4.5.3."
- name: "body"
- name: "NsdInfoModifications"