Newer
Older
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"
title: "DRAFT - SOL005 - NSD Management Interface"
contact:
name: "NFV-SOL WG"
license:
name: "ETSI Forge copyright notice"
url: "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
/ns_descriptors:
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."
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."
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."
schema:
$ref: "#/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."
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."
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."
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: []
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"
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
- name: "body"
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."
responses:
201:
description: "Status 201"
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."
properties:
NsdInfo:
$ref: "#/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}:
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."
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."
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."
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."
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."
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."
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."
headers:
WWW-Authenticate:
type: "string"
description: "Challenge if the corresponding HTTP request\nhas not provided\
\ authorization, or error details if the corresponding HTTP request\
Loading
Loading full blame…