@itentialopensource/adapter-etsi_sol005

{ "openapi": "3.0.0", "info": { "title": "SOL005 - NS Lifecycle Management Interface", "description": "SOL005 - NS Lifecycle Management Interface\nIMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it\nrefers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification\ntakes precedence.\nPlease report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues\n", "contact": { "name": "NFV-SOL WG" }, "version": "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" }, "servers": [ { "url": "http://127.0.0.1/nslcm/v1", "variables": {} }, { "url": "https://127.0.0.1/nslcm/v1", "variables": {} } ], "paths": { "/api_versions": { "get": { "summary": "Retrieve API version information", "description": "The GET method reads API version information. This method shall follow the provisions specified in table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not supported.\n", "operationId": "RetrieveAPIversioninformation", "parameters": [ { "name": "Version", "in": "header", "description": "Version of the API requested to use when responding to this request.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 OK\nAPI version information was read successfully. The response body shall contain 4.4 API version information, as defined in clause 4.4.1.13.", "headers": { "Version": { "description": "The used API version.", "content": { "text/plain": { "schema": { "type": "string", "description": "The used API version." } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersionsResponse" } } } }, "400": { "description": "400 BAD REQUEST\n400 code can be returned in the following specified cases, the specific cause has to be proper specified in the \"ProblemDetails\" structure to be returned.\nIf 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), 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.\nIf the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it 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.\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\nThe use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersions400Error1" } } } }, "401": { "description": "401 UNAUTHORIZED\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersions401Error1" } } } }, "403": { "description": "403 FORBIDDEN\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersions403Error1" } } } }, "404": { "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis 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.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersions404Error1" } } } }, "405": { "description": "405 METHOD NOT ALLOWED\nIf a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersions405Error1" } } } }, "406": { "description": "406 NOT ACCEPTABLE\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersions406Error1" } } } }, "413": { "description": "413 PAYLOAD TOO LARGE\nIf the payload body 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": { "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersions413Error1" } } } }, "414": { "description": "414 URI TOO LONG\nIf the request URI of a request is longer than the API producer is willing or able to process, it shall respond with this response code. This condition can e.g. be caused by passing long queries in the request URI of a GET request. The \"ProblemDetails\" structure may be omitted.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersions414Error1" } } } }, "416": { "description": "416 Range Not Satisfiable", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersions416Error1" } } } }, "422": { "description": "422 UNPROCESSABLE ENTITY\nIf the payload body 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.\nThis error response code is only applicable for methods that have a request body.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersions422Error1" } } } }, "429": { "description": "429 TOO MANY REQUESTS\nIf the API consumer has sent too many requests in a defined period of time and the API producer is able to detect that condition (\"rate limiting\"), the API producer shall respond with this response code, following the provisions in IETF RFC 6585 [17] for the use of the \"Retry-After\" HTTP header. The \"ProblemDetails\" structure shall be provided and shall include in the \"detail\" attribute more information about the source of the problem.\nThe period of time and allowed number of requests are configured within the API producer by means outside the scope of the present document.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersions429Error1" } } } }, "500": { "description": "500 INTERNAL SERVER ERROR\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersions500Error1" } } } }, "503": { "description": "503 SERVICE UNAVAILABLE\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersions503Error1" } } } }, "504": { "description": "504 GATEWAY TIMEOUT\nIf the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiVersions504Error1" } } } } }, "deprecated": false } }, "/ns_instances": { "get": { "summary": "Query multiple NS instances.", "description": "Query NS Instances.\nThe GET method queries information about multiple NS instances. This method shall support the URI query parameters,\nrequest and response data structures, and response codes, as specified in the Tables 6.4.2.3.2-1 and 6.4.2.3.2-2.\n", "operationId": "QuerymultipleNSinstances.", "parameters": [ { "name": "Version", "in": "header", "description": "Version of the API requested to use when responding to this request.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "The authorization token for the request. Reference: IETF RFC 7235.", "style": "simple", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the URI query string. The API consumer may supply this parameter. All attribute names that appear in the FmSubscription and in data types referenced from it shall be supported by the NFV-MANO functional entity in the filter expression.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "all_fields", "in": "query", "description": "Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support this parameter.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "exclude_fields", "in": "query", "description": "Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "exclude_default", "in": "query", "description": "Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity shall support this parameter. The NFVO shall support this parameter.\nThe following attributes shall be excluded from the NsInstance structure in the response body if this parameter is provided, or none of the parameters \"all_fields,\" \"fields\", \"exclude_fields\", \"exclude_default\" are provided: -\tvnfInstances -\tpnfInfo -\tvirtualLinkInfo -\tvnffgInfo -\tsapInfo -\tnsScaleStatus -\tadditionalAffinityOrAntiAffinityRules - wanConnectionInfo", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "nextpage_opaque_marker", "in": "query", "description": "Marker to obtain the next page of a paged response. Shall be supported by the NFV-MANO functional entity if the entity supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 OK\nShall be returned when information about zero or more NS instances has been queried successfully. The response\nbody shall contain in an array the representations of zero or more NS instances, as defined in clause 6.5.2.8.\nIf the \"filter\" URI parameter or one of the \"all_fields\", \"fields\" (if supported), \"exclude_fields\" (if supported)\nor \"exclude_default\" URI parameters was supplied in the request, the data in the response body shall have been\ntransformed according to the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013 [16], respectively.\nIf the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 [16] for this resource,\ninclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013 [16].", "headers": { "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } }, "WWW-Authenticate": { "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the\ncorresponding HTTP request has provided an invalid authorization token.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the\ncorresponding HTTP request has provided an invalid authorization token.\n" } } } }, "Link": { "description": "Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.\n" } } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NsInstancesResponse" }, "description": "" } } } }, "400": { "description": "400 BAD REQUEST\n400 code can be returned in the following specified cases, the specific cause has to be proper specified in the \"ProblemDetails\" structure to be returned.\nIf 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), 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.\nIf the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it 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.\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\nThe use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NsInstances400Error1" } } } }, "401": { "description": "401 UNAUTHORIZED\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NsInstances401Error1" } } } }, "403": { "description": "403 FORBIDDEN\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NsInstances403Error1" } } } }, "404": { "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis 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.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NsInstances404Error1" } } } }, "405": { "description": "405 METHOD NOT ALLOWED\nIf a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NsInstances405Error1" } } } }, "406": { "description": "406 NOT ACCEPTABLE\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted.", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NsInstances406Error1" } } } }, "409": { "description": "409 CONFLICT", "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.\n", "content": { "text/plain": { "schema": { "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.\n" } } } }, "Version": { "description": "Version of the API used in the response.\n", "content": { "text/plain": { "schema": { "type": "string", "description": "Version of the API used in the response.\n" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NsInstances409Error1" } } } }, "416": { "description": "416 Ran