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" version: "2.4.1" 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" 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': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2.3.2 get: 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: "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. The response body shall contain a representation of zero or more NS descriptors, as defined in clause 5.5.2.2" schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" headers: Content-Type: 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. 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" post: 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: "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: $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 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." properties: 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." ############################################################################### # Individual NS Descriptor # ############################################################################### '/ns_descriptors/{nsdInfoId}': get: 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 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: > 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/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 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 description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 204: description: > 204 No Content The operation has completed 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. 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: $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: 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: "NsdInfoModifications" in: "body" required: true schema: type: "object" required: - "NsdInfoModifications" properties: NsdInfoModifications: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications" description: > "The operation was completed successfully. The response body shall contain attribute modifications for an 'Individual NS Descriptor' resource (see clause 5.5.2.6 of GS NFV SOL-005)." - 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: 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. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 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. type: string maximum: 1 minimum: 0 schema: type: array items: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications" 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" parameters: - name: "nsdInfoId" description: > Identifier of the individual NS descriptor resource. in: "path" required: true type: "string" ############################################################################### # NSD Content # ############################################################################### '/ns_descriptors/{nsdInfoId}/nsd_content': get: summary: "Fetch the content of a NSD." description: > "The GET method fetches the content of the NSD.The NSD can be implemented as a single file or as a collection of multiple files. If the NSD is implemented in the form of multiple files, a ZIP file embedding these files shall be returned. If the NSD is implemented as a single file, either that file or a ZIP file embedding that file shall be returned. The selection of the format is controlled by the "Accept" HTTP header passed in the GET request:• If the "Accept" header contains only "text/plain" and the NSD is implemented as a single file, the file shall be returned; otherwise, an error message shall be returned.• If the "Accept" header contains only "application/zip", the single file or the multiple files that make up the NSD shall be returned embedded in a ZIP file.• If the "Accept" header contains both "text/plain" and "application/zip", it is up to the NFVO to choose the format to return for a single-file NSD; for a multi-file NSD, a ZIP file shall be returned.NOTE: The structure of the NSD zip file is outside the scope of the present document." parameters: - name: Accept description: > Content-Types that are acceptable for the response. in: header required: true type: string enum: - text/plain - application/zip - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: "Range" in: "header" required: false type: "string" description: > "The request may contain a "Range" HTTP header to obtain single range of bytes from the NSD file. This can be used to continue an aborted transmission.If the NFVO does not support range requests, the NFVO shall ignore the 'Range" header, process the GET request, and return the whole NSD file with a 200 OK response (rather than returning a 4xx error status code)." responses: 200: description: > "On success, the content of the NSD is returned. The payload body shall contain a copy of the file representing the NSD or a ZIP file that contains the file or multiple files representing the NSD, as specified above. The "Content-Type" HTTP header shall be set according to the format of the returned file, i.e. to "text/plain" for a YAML file or to "application/zip" for a ZIP file." headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 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. type: string maximum: 1 minimum: 0 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 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" put: summary: "Upload the content of a NSD." description: > "The PUT method is used to upload the content of a NSD. The NSD to be uploaded can be implemented as a single file or as a collection of multiple files, as defined in clause 5.4.4.3.2 of GS NFV-SOL 005. If the NSD is implemented in the form of multiple files, a ZIP file embedding these files shall be uploaded. If the NSD is implemented as a single file, either that file or a ZIP file embedding that file shall be uploaded. The "Content-Type" HTTP header in the PUT request shall be set accordingly based on the format selection of the NSD. If the NSD to be uploaded is a text file, the "Content-Type" header is set to "text/plain". If the NSD to be uploaded is a zip file, the "Content-Type" header is set to "application/zip". This method shall follow the provisions specified in the Tables 5.4.4.3.3-1 and 5.4.4.3.3-2 of GS-NFV-SOL 005 for URI query parameters, request and response data structures, and response codes." parameters: - name: Accept description: > Content-Types that are acceptable for the response. in: header required: true type: string enum: - text/plain - application/zip - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 202: description: > "Status 202" headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 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. type: string maximum: 1 minimum: 0 204: description: > "The NSD content was successfully uploaded and validated (synchronous mode). The response body shall be empty." 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 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" parameters: - name: "nsdInfoId" in: "path" required: true type: "string" ############################################################################### # PNF Descriptors # ############################################################################### '/pnf_descriptors': get: summary: "Query information about multiple PNF descriptor resources." description: > "The GET method queries information about multiple PNF descriptor resources." parameters: - 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 PnfdInfo 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 NFVO shall support this parameter. The following attributes shall be excluded from the PnfdInfo 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. responses: 200: description: > 200 OK Information about zero or more PNF descriptors. The response body shall contain a representation of zero or more PNF descriptors, as defined in clause 5.5.2.2 headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 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. type: string maximum: 1 minimum: 0 schema: type: array items: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" 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" post: summary: "Create a new PNF descriptor resource." description: > "The POST method is used to create a new PNF descriptor resource." parameters: - name: "CreatePnfdInfoRequest" description: > "Parameters of creating a PNF descriptor resource, as defined in clause 5.5.2.6." in: "body" required: true schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest" - 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 A PNF descriptor resource was created successfully, as a new PNF descriptor resource. The response body shall contain a representation of the new PNF descriptor resource, as defined in clause 5.5.2.5. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the new PNF descriptor resource. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 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. type: string maximum: 1 minimum: 0 schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 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" ############################################################################### # Individual PNF Descriptor # ############################################################################### '/pnf_descriptors/{pnfdInfoId}': get: summary: "Read an individual PNFD resource." description: > "The GET method reads information about an individual PNF descriptor. This method shall follow the provisions specified in the Tables 5.4.6.3.2-1 and 5.4.6.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and response data structures, and response codes." responses: 200: description: > Information about the individual PNFD descriptor. The response body shall contain a representation of the individual PNF descriptor, as defined in clause 5.5.2.5. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 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. type: string maximum: 1 minimum: 0 schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" 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 an individual PNF descriptor resource." description: > "The DELETE method deletes an individual PNF descriptor resource. An individual PNF descriptor resource can only be deleted when there is no NS instance using it or there is NSD referencing it. To delete all PNFD versions identified by a particular value of the "pnfdInvariantId" attribute, the procedure is to first use the GET method with filter "pnfdInvariantId" towards the PNF descriptors resource to find all versions of the PNFD. Then, the client uses the DELETE method described in this clause to delete each PNFD version individually. This method shall follow the provisions specified in the Tables 5.4.6.3.5-1 and 5.4.6.3.5-2 of GS NFV-SOL 005 for URI query parameters, request and response data structures, and response codes." responses: 204: description: > 204 No Content The operation has completed successfully. The response body shall be empty. 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 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" patch: summary: "Modify the user defined data of an individual PNF descriptor resource." description: > "The PATCH method modifies the user defined data of an individual PNF descriptor resource. This method shall follow the provisions specified in the Tables 5.4.6.3.4-1 and 5.4.6.3.4-2 for URI query parameters, request and response data structures, and response codes." parameters: - name: "body" in: "body" required: true schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications" responses: 200: description: > 200 OK The operation was completed successfully. The response body shall contain attribute modifications for an 'Individual PNF Descriptor' resource (see clause 5.5.2.4). headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 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. type: string maximum: 1 minimum: 0 schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications" 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 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" parameters: - name: "pnfdInfoId" description: > Identifier of the individual PNF descriptor resource. in: "path" required: true type: "string" ############################################################################### # PNFD Content # ############################################################################### '/pnf_descriptors/{pnfdInfoId}/pnfd_content': get: summary: "Fetch the content of a PNFD." description: > "The GET method fetches the content of the PNFD." parameters: - name: Accept description: > Content-Types that are acceptable for the response. in: header required: true type: string enum: - text/plain - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 200: description: > 200 OK On success, the content of the PNFD is returned. The payload body shall contain a copy of the file representing the PNFD. The Content-Type" HTTP header shall be set to "text/plain". 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 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: > Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact pnfdOnboardingState has a value different from ONBOARDED. The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error. 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" put: summary: "Upload the content of a PNFD." description: > "The PUT method is used to upload the content of a PNFD. This method shall follow the provisions specified in the Tables 5.4.7.3.3-1 and 5.4.7.3.3-2 of GS NFV-SOL 005for URI query parameters, request and response data structures, and response codes." parameters: - name: Accept description: > Content-Types that are acceptable for the response. in: header required: true type: string enum: - text/plain - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 204: description: > 204 No Content The PNFD content was successfully uploaded and validated. The response body shall be empty. 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 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: > 409 Conflict Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that the PnfdOnboardingState has a value other than CREATED. The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error.. 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" parameters: - name: "pnfdInfoId" description: > Identifier of the individual PNF descriptor. in: "path" required: true type: "string" ############################################################################### # Subscriptions # ############################################################################### '/subscriptions': get: summary: "Query multiple subscriptions." description: > "The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Tables 5.4.8.3.2-1 and 5.4.8.3.2-2 of GS NFV-SOL 005." parameters: - 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 VnfPkgInfo and in data types referenced from it shall be supported in attribute-based filtering parameters." - 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: > The list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 Location: description: The resource URI of the created NS instance type: string format: url 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. type: string maximum: 1 minimum: 0 schema: type: "array" description: > "The list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method." items: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" 303: description: > A subscription with the same callbackURI and the same filter already exits and the policy of the NFVO is to not create redundant subscriptions. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing subscription resource. The response body shall be empty. 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 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" post: summary: "Subscribe to NSD and PNFD change notifications." description: > "The POST method creates a new subscription. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Tables 5.4.8.3.1-1 and 5.4.8.3.1-2 of GS-NFV SOL 005. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases. Consequently, the NFVO may either allow creating a subscription resource if another 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 subscription resource (in which case it shall return a "303 See Other" response code referencing the existing subscription resource with the same filter and callbackUri)." parameters: - name: "body" in: "body" required: true schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscriptionRequest" responses: 201: description: > "Status 201" schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" headers: Location: type: "string" description: > "The HTTP response shall include a "Location:"HTTP header that points to the created subscription resource." ############################################################################### # Individual Subscription # ############################################################################### '/subscriptions/{subscriptionId}': get: summary: "Read an individual subscription resource." description: > "The GET method retrieves information about a subscription by reading an individual subscription resource. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Tables 5.4.9.3.2-1 and 5.4.9.3.2-2." parameters: [] responses: 200: description: > "Status 200" schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" delete: summary: "Terminate Subscription" description: > "The DELETE method terminates an individual subscription. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Tables 5.4.9.3.5-1 and 5.4.9.3.3-2 of GS NFV-SOL 005." parameters: [] responses: 204: description: > "The subscription resource was deleted successfully. The response body shall be empty." parameters: - name: "subscriptionId" in: "path" required: true type: "string"