diff options
| -rw-r--r-- | so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/pom.xml | 163 | ||||
| -rw-r--r-- | so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/src/main/resources/SOL005-NSLifecycleManagement-API.json | 24383 |
2 files changed, 24546 insertions, 0 deletions
diff --git a/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/pom.xml b/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/pom.xml index 071a866..6e83177 100644 --- a/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/pom.xml +++ b/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/pom.xml @@ -8,4 +8,167 @@ </parent> <artifactId>so-etsi-nfvo-ns-lcm-api</artifactId> <name>SO ETSI NFVO NS LCM Manager Api</name> + + <build> + <plugins> + <plugin> + <groupId>io.swagger</groupId> + <artifactId>swagger-codegen-maven-plugin</artifactId> + <version>${version-swagger-codegen}</version> + <executions> + <execution> + <id>so-etsi-nfvo-ns-lcm-api</id> + <goals> + <goal>generate</goal> + </goals> + <configuration> + <inputSpec>${basedir}/src/main/resources/SOL005-NSLifecycleManagement-API.json</inputSpec> + <language>java</language> + <library>okhttp-gson</library> + <output>${project.build.directory}/generated-sources/so-etsi-nfvo-ns-lcm-api</output> + <apiPackage>org.onap.so.etsi.nfvo.ns.lcm.api</apiPackage> + <modelPackage>org.onap.so.etsi.nfvo.ns.lcm.model</modelPackage> + <generateApiTests>false</generateApiTests> + <generateModelTests>false</generateModelTests> + <configOptions> + <sourceFolder>src/gen/java/main</sourceFolder> + <withXml>true</withXml> + <useRxJava2>true</useRxJava2> + <serializableModel>true</serializableModel> + <dateLibrary>java8-localdatetime</dateLibrary> + </configOptions> + </configuration> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>build-helper-maven-plugin</artifactId> + <executions> + <execution> + <id>add-source</id> + <phase>generate-sources</phase> + <goals> + <goal>add-source</goal> + </goals> + <configuration> + <sources> + <source>${project.basedir}/target/generated-sources/so-etsi-nfvo-ns-lcm-api/src/gen/java/main</source> + </sources> + </configuration> + </execution> + </executions> + </plugin> + </plugins> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.eclipse.m2e</groupId> + <artifactId>lifecycle-mapping</artifactId> + <version>1.0.0</version> + <configuration> + <lifecycleMappingMetadata> + <pluginExecutions> + <pluginExecution> + <pluginExecutionFilter> + <groupId>io.swagger</groupId> + <artifactId>swagger-codegen-maven-plugin</artifactId> + <goals> + <goal>generate</goal> + </goals> + <versionRange>[2.2.0,)</versionRange> + </pluginExecutionFilter> + <action> + <execute> + <runOnIncremental>false</runOnIncremental> + </execute> + </action> + </pluginExecution> + </pluginExecutions> + </lifecycleMappingMetadata> + </configuration> + </plugin> + </plugins> + </pluginManagement> + </build> + <dependencies> + <dependency> + <groupId>io.swagger</groupId> + <artifactId>swagger-annotations</artifactId> + <version>${swagger-core-version}</version> + </dependency> + <dependency> + <groupId>com.squareup.retrofit2</groupId> + <artifactId>converter-gson</artifactId> + <version>${retrofit-version}</version> + </dependency> + <dependency> + <groupId>com.squareup.retrofit2</groupId> + <artifactId>retrofit</artifactId> + <version>${retrofit-version}</version> + </dependency> + <dependency> + <groupId>com.squareup.retrofit2</groupId> + <artifactId>converter-scalars</artifactId> + <version>${retrofit-version}</version> + </dependency> + <dependency> + <groupId>org.apache.oltu.oauth2</groupId> + <artifactId>org.apache.oltu.oauth2.client</artifactId> + <version>${oltu-version}</version> + </dependency> + <dependency> + <groupId>io.gsonfire</groupId> + <artifactId>gson-fire</artifactId> + <version>${gson-fire-version}</version> + </dependency> + <dependency> + <groupId>org.threeten</groupId> + <artifactId>threetenbp</artifactId> + <version>${threetenbp-version}</version> + </dependency> + <dependency> + <groupId>io.reactivex.rxjava2</groupId> + <artifactId>rxjava</artifactId> + </dependency> + <dependency> + <groupId>com.squareup.retrofit2</groupId> + <artifactId>adapter-rxjava2</artifactId> + <version>${retrofit-version}</version> + </dependency> + <dependency> + <groupId>com.google.code.gson</groupId> + <artifactId>gson</artifactId> + </dependency> + <dependency> + <groupId>com.squareup.okio</groupId> + <artifactId>okio</artifactId> + <version>${okio-version}</version> + </dependency> + <dependency> + <groupId>com.squareup.okhttp3</groupId> + <artifactId>okhttp</artifactId> + <version>${okhttp3-version}</version> + </dependency> + <dependency> + <groupId>com.squareup.okhttp3</groupId> + <artifactId>logging-interceptor</artifactId> + <version>${okhttp3-version}</version> + </dependency> + <dependency> + <groupId>com.squareup.okhttp</groupId> + <artifactId>logging-interceptor</artifactId> + <version>${okhttp-version}</version> + </dependency> + <dependency> + <groupId>com.squareup.okhttp</groupId> + <artifactId>okhttp</artifactId> + <version>${okhttp-version}</version> + </dependency> + <dependency> + <groupId>javax.xml.bind</groupId> + <artifactId>jaxb-api</artifactId> + </dependency> + </dependencies> + </project>
\ No newline at end of file diff --git a/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/src/main/resources/SOL005-NSLifecycleManagement-API.json b/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/src/main/resources/SOL005-NSLifecycleManagement-API.json new file mode 100644 index 0000000..8a7eb9d --- /dev/null +++ b/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/src/main/resources/SOL005-NSLifecycleManagement-API.json @@ -0,0 +1,24383 @@ +{ + "swagger":"2.0", + "info":{ + "version":"1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1", + "title":"SOL005 - NS Lifecycle Management Interface", + "description":"SOL005 - NS Lifecycle 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", + "license":{ + "name":"ETSI Forge copyright notice", + "url":"https://forge.etsi.org/etsi-forge-copyright-notice.txt" + }, + "contact":{ + "name":"NFV-SOL WG" + } + }, + "externalDocs":{ + "description":"ETSI GS NFV-SOL 005 V2.7.1", + "url":"https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf" + }, + "basePath":"/nslcm/v1", + "schemes":[ + "http", + "https" + ], + "consumes":[ + "application/json" + ], + "produces":[ + "application/json" + ], + "paths":{ + "/api_versions":{ + "parameters":[ + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":false, + "type":"string" + } + ], + "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", + "responses":{ + "200":{ + "description":"API version information was read successfully. The response body shall contain 4.4 API version information, as defined in clause 4.4.1.13.\n", + "schema":{ + "description":"This type represents API version information.\n", + "type":"object", + "required":[ + "uriPrefix", + "apiVersions" + ], + "properties":{ + "uriPrefix":{ + "description":"Specifies the URI prefix for the API, in the following form {apiRoot}/{apiName}/{apiMajorVersion}/.\n", + "type":"string" + }, + "apiVersions":{ + "description":"Version(s) supported for the API signalled by the uriPrefix attribute.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "version" + ], + "properties":{ + "version":{ + "description":"Identifies a supported version. The value of the version attribute shall be a version identifier as specified in clause 4.6.1.\n", + "type":"string" + }, + "isDeprecated":{ + "description":"The Boolean is a data type having two values (TRUE and FALSE).\n", + "type":"boolean" + }, + "retirementDate":{ + "description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n", + "format":"date-time", + "type":"string" + } + } + } + } + } + }, + "headers":{ + "Content-Type":{ + "description":"The MIME type of the body of the response.", + "type":"string", + "maximum":1, + "minimum":1 + }, + "Version":{ + "description":"The used API version.", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "416":{ + "description":"416 RANGE NOT SATISFIABLE\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/ns_instances":{ + "parameters":[ + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235.\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + } + ], + "post":{ + "summary":"Create a NS instance resource.", + "description":"The POST method creates a new NS instance resource. As the result of successfully executing this method, a new \"Individual NS instance\" resource as defined in clause 6.4.3 shall have been created, and the value of the \"instantiationState\" attribute in the representation of that resource shall be \"NOT_INSTANTIATED\". A notification of type NsIdentifierCreationNotification shall be triggered as part of successfully executing this method as defined in clause 6.5.2.6.\n", + "parameters":[ + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Content-Type", + "description":"The MIME type of the body of the request. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"CreateNsRequest", + "in":"body", + "required":true, + "schema":{ + "type":"object", + "required":[ + "nsdId", + "nsName", + "nsDescription" + ], + "properties":{ + "nsdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsName":{ + "description":"Human-readable name of the NS instance to be created.\n", + "type":"string" + }, + "nsDescription":{ + "description":"Human-readable description of the NS instance to be created.\n", + "type":"string" + } + } + }, + "description":"The NS creation parameters, as defined in clause 6.5.2.7.\n" + } + ], + "responses":{ + "201":{ + "description":"201 Created\nShall be returned when a new \"Individual NS instance\" resource and the associated NS instance identifier has been created successfully. The response body shall contain a representation of the created NS instance, as defined in clause 6.5.2.10. The HTTP response shall include a \"Location\" HTTP header that contains the resource URI of the created NS instance.\n", + "schema":{ + "description":"This type represents a response for Query NS operation. It shall comply with the provisions defined in Table 6.5.2.10-1.\n", + "type":"object", + "required":[ + "id", + "nsInstanceName", + "nsInstanceDescription", + "nsdId", + "nsdInfoId", + "nsState", + "_links" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsInstanceName":{ + "description":"Human readable name of the NS instance.\n", + "type":"string" + }, + "nsInstanceDescription":{ + "description":"Human readable description of the NS instance.\n", + "type":"string" + }, + "nsdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsdInfoId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "flavourId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "vnfInstance":{ + "description":"Information on constituent VNF(s) of the NS instance.\n", + "type":"array", + "items":{ + "description":"This type represents a VNF instance. Clause B.3.2 of ETSI GS NFV-SOL 003 [4] provides examples illustrating the relationship among the different run-time information elements (CP, VL and link ports) used to represent the connectivity of a VNF.\n", + "type":"object", + "required":[ + "id", + "vnfdId", + "vnfProvider", + "vnfProductName", + "vnfSoftwareVersion", + "vnfdVersion", + "vnfPkgId", + "instantiationState" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfInstanceName":{ + "description":"Name of the VNF instance. This attribute can be modified with the PATCH method.\n", + "type":"string" + }, + "vnfInstanceDescription":{ + "description":"Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n", + "type":"string" + }, + "vnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfProvider":{ + "description":"Provider of the VNF and the VNFD. The value is copied from the VNFD.\n", + "type":"string" + }, + "vnfProductName":{ + "description":"Name to identify the VNF Product. The value is copied from the VNFD.\n", + "type":"string" + }, + "vnfSoftwareVersion":{ + "description":"A Version. Representation: string of variable length.\n", + "type":"string" + }, + "vnfdVersion":{ + "description":"A Version. Representation: string of variable length.\n", + "type":"string" + }, + "vnfPkgId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfConfigurableProperties":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "instantiationState":{ + "description":"The instantiation state of the VNF.\n", + "type":"string", + "enum":[ + "NOT_INSTANTIATED", + "INSTANTIATED" + ] + }, + "instantiatedVnfInfo":{ + "description":"Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.\n", + "type":"object", + "required":[ + "flavourId", + "vnfState", + "extCpInfo" + ], + "properties":{ + "flavourId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "vnfState":{ + "type":"string", + "enum":[ + "STARTED", + "STOPPED" + ] + }, + "scaleStatus":{ + "description":"Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how \"big\" the VNF has been scaled w.r.t. that aspect.\n", + "type":"array", + "items":{ + "required":[ + "aspectId", + "scaleLevel" + ], + "type":"object", + "properties":{ + "aspectId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "scaleLevel":{ + "description":"Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n", + "type":"integer" + } + } + } + }, + "maxScaleLevels":{ + "description":"Maximum allowed scale levels of the VNF, one entry per aspect. This attribute shall be present if the VNF supports scaling.\n", + "type":"array", + "items":{ + "required":[ + "aspectId", + "scaleLevel" + ], + "type":"object", + "properties":{ + "aspectId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "scaleLevel":{ + "description":"Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n", + "type":"integer" + } + } + } + }, + "extCpInfo":{ + "description":"Information about the external CPs exposed by the VNF instance.\n", + "type":"array", + "minItems":1, + "items":{ + "description":"This type represents information about an external CP of a VNF. It shall comply with the provisions defined in Table 6.5.3.70-1.\n", + "type":"object", + "required":[ + "id", + "cpdId" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpdId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "cpProtocolInfo":{ + "description":"Network protocol information for this CP.\n", + "type":"array", + "minItems":1, + "items":{ + "description":"This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.\n", + "type":"object", + "required":[ + "layerProtocol", + "ipOverEthernet" + ], + "properties":{ + "layerProtocol":{ + "description":"The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1.\n", + "type":"object", + "required":[ + "macAddress", + "ipAddresses" + ], + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "addresses":{ + "description":"Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "type":{ + "description":"The type of the IP addresses\n", + "type":"string", + "enum":[ + "PV4", + "PV6" + ] + }, + "addresses":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g. in case of egress connections. See note.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + }, + "extLinkPortId":{ + "description":"This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.\n", + "type":"object", + "required":[ + "layerProtocol", + "ipOverEthernet" + ], + "properties":{ + "layerProtocol":{ + "description":"The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1.\n", + "type":"object", + "required":[ + "macAddress", + "ipAddresses" + ], + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "addresses":{ + "description":"Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "type":{ + "description":"The type of the IP addresses\n", + "type":"string", + "enum":[ + "PV4", + "PV6" + ] + }, + "addresses":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g. in case of egress connections. See note.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "associatedVnfcCpId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "associatedVnfVirtualLinkId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + } + } + } + }, + "extVirtualLinkInfo":{ + "description":"Information about the external VLs the VNF instance is connected to.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "extLinkPorts":{ + "description":"Link ports of this VL.\n", + "type":"array", + "items":{ + "description":"This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n", + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + } + } + } + } + } + } + }, + "extManagedVirtualLinkInfo":{ + "description":"External virtual links the VNF instance is connected to.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "vnfVirtualLinkDescId" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfVirtualLinkDescId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "networkResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "vnfLinkPorts":{ + "description":"Link ports of this VL.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpInstanceType":{ + "description":"Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: * VNFC_CP: The link port is connected to a VNFC CP * EXT_CP: The link port is associated to an external CP.\n", + "type":"string", + "enum":[ + "VNFC_CP", + "EXT_CP" + ] + } + } + } + } + } + } + }, + "monitoringParameters":{ + "description":"Performance metrics tracked by the VNFM (e.g. for auto-scaling purposes) as identified by the VNF provider in the VNFD.\n", + "type":"array", + "items":{ + "description":"This type represents a monitoring parameter that is tracked by the VNFM, for example, for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.69-1.\n", + "type":"object", + "required":[ + "id", + "performanceMetric" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "name":{ + "description":"Human readable name of the monitoring parameter, as defined in the VNFD.\n", + "type":"string" + }, + "performanceMetric":{ + "description":"Performance metric that is monitored. This attribute shall contain the related \"Measurement Name\" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.\n", + "type":"string" + } + } + } + }, + "localizationLanguage":{ + "description":"Information about localization language of the VNF (includes e.g. strings in the VNFD). The localization languages supported by a VNF can be declared in the VNFD, and localization language selection can take place at instantiation time. The value shall comply with the format defined in IETF RFC 5646.\n", + "type":"string" + }, + "vnfcResourceInfo":{ + "description":"Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n", + "type":"array", + "items":{ + "description":"This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n", + "type":"object", + "required":[ + "id", + "vduId", + "computeResource" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "vduId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "computeResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "storageResourceIds":{ + "description":"References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "reservationId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfcCpInfo":{ + "description":"CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is associated to an external CP of the VNF instance. May be present otherwise.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "cpdId" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpdId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "vnfExtCpId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpProtocolInfo":{ + "description":"Network protocol information for this CP.\n", + "type":"array", + "items":{ + "description":"This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.\n", + "type":"object", + "required":[ + "layerProtocol", + "ipOverEthernet" + ], + "properties":{ + "layerProtocol":{ + "description":"The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1.\n", + "type":"object", + "required":[ + "macAddress", + "ipAddresses" + ], + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "addresses":{ + "description":"Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "type":{ + "description":"The type of the IP addresses\n", + "type":"string", + "enum":[ + "PV4", + "PV6" + ] + }, + "addresses":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g. in case of egress connections. See note.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + }, + "vnfLinkPortId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "virtualLinkResourceInfo":{ + "description":"Information about the virtualised network resources used by the VLs of the VNF instance.\n", + "type":"array", + "items":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n", + "type":"object", + "required":[ + "id", + "vnfVirtualLinkDescId", + "networkResource" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "vnfVirtualLinkDescId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "networkResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "reservationId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfLinkPorts":{ + "description":"Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpInstanceType":{ + "description":"Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: * VNFC_CP: The link port is connected to a VNFC CP * EXT_CP: The link port is associated to an external CP.\n", + "type":"string", + "enum":[ + "VNFC_CP", + "EXT_CP" + ] + } + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "virtualStorageResourceInfo":{ + "description":"Information on the virtualised storage resource(s) used as storage for the VNF instance.\n", + "type":"array", + "items":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n", + "type":"object", + "required":[ + "id", + "virtualStorageDescId", + "storageResource" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "virtualStorageDescId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "storageResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "reservationId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "extensions":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "pnfInfo":{ + "description":"Information on the PNF(s) that are part of the NS instance.\n", + "type":"array", + "items":{ + "description":"This type represents the information about a PNF that is part of an NS instance. It shall comply with the provisions defined in Table 6.5.3.13-1.\n", + "type":"object", + "required":[ + "pnfId", + "pnfdId", + "pnfdInfoId", + "pnfProfileId" + ], + "properties":{ + "pnfId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfName":{ + "description":"Name of the PNF.\n", + "type":"string" + }, + "pnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfdInfoId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "cpInfo":{ + "description":"This type represents the information about the external CP of the PNF. It shall comply with the provisions defined in Table 6.5.3.17-1.\n", + "type":"object", + "required":[ + "cpInstanceId", + "cpdId" + ], + "properties":{ + "cpInstanceId":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + }, + "cpdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "cpProtocolData":{ + "description":"Parameters for configuring the network protocols on the CP.\n", + "type":"array", + "items":{ + "description":"This type represents network protocol data.\n", + "type":"object", + "required":[ + "layerProtocol" + ], + "properties":{ + "layerProtocol":{ + "description":"Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents network address data for IP over Ethernet.\n", + "type":"object", + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "fixedAddresses":{ + "description":"Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "numDynamicAddresses":{ + "description":"Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"integer" + }, + "addressRange":{ + "description":"An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "virtualLinkInfo":{ + "description":"Information on the VL(s) of the NS instance. This attribute shall be present if the nsState attribute value is INSTANTIATED and if the NS instance has specified connectivity.\n", + "type":"array", + "items":{ + "description":"This type specifies the information about an NS VL instance. It shall comply with the provisions defined in Table 6.5.3.53-1\n", + "type":"object", + "required":[ + "id", + "nsVirtualLinkDescId", + "nsVirtualLinkProfileId" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + }, + "nsVirtualLinkDescId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "nsVirtualLinkProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"Identifier(s) of the virtualised network resource(s) realizing the VL instance. See note.\n", + "type":"array", + "items":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + } + }, + "linkPort":{ + "description":"Link ports of the VL instance. Cardinality of zero indicates that no port has yet been created for the VL instance.\n", + "type":"array", + "items":{ + "description":"This type represents information about a link port of a VL instance. It shall comply with the provisions defined in Table 6.5.3.55-1.\n", + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "nsCpHandle":{ + "description":"Identifier of the CP/SAP instance to be connected to this link port. The value refers to a vnfExtCpInfo item in the VnfInstance, or a pnfExtCpInfo item in the PnfInfo, or a sapInfo item in the NS instance. There shall be at most one link port associated with any connection point instance.\n", + "type":"array", + "items":{ + "description":"This type represents an identifier of the CP or SAP instance. It shall comply with the provisions defined in Table 6.5.3.56-1.\n", + "type":"object", + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfExtCpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "pnfInfoId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfExtCpInstanceId":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + }, + "nsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsSapInstanceId":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + }, + "vnffgInfo":{ + "description":"Information on the VNFFG(s) of the NS instance.\n", + "type":"array", + "items":{ + "description":"Information on the VNFFG(s) of the NS instance.\n", + "type":"object", + "required":[ + "id", + "vnffgdId", + "vnfInstanceId", + "pnfInfoId" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnffgdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "vnfInstanceId":{ + "description":"Identifier(s) of the constituent VNF instance(s) of this VNFFG instance.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "pnfdInfoId":{ + "description":"Identifier(s) of the constituent PNF instance(s) of this VNFFG instance.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "nsVirtualLinkInfoId":{ + "description":"Identifier(s) of the constituent VL instance(s) of this VNFFG instance.\n", + "type":"array", + "items":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + } + }, + "nsCpHandle":{ + "description":"Identifiers of the CP instances attached to the constituent VNFs and PNFs or the SAP instances of the VNFFG. See note.\n", + "type":"array", + "items":{ + "description":"This type represents an identifier of the CP or SAP instance. It shall comply with the provisions defined in Table 6.5.3.56-1.\n", + "type":"object", + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfExtCpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "pnfInfoId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfExtCpInstanceId":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + }, + "nsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsSapInstanceId":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + }, + "sapInfo":{ + "description":"Information on the SAP(s) of the NS instance.\n", + "type":"array", + "items":{ + "description":"This type represents an SAP instance. It shall comply with the provisions defined in Table 6.5.3.67-1.\n", + "type":"object", + "required":[ + "id", + "sapdId", + "sapName", + "sapProtocolInfo" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + }, + "sapdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "sapName":{ + "description":"Human readable name for the SAP instance.\n", + "type":"string" + }, + "description":{ + "description":"Human readable description for the SAP instance.\n", + "type":"string" + }, + "sapProtocolInfo":{ + "description":"Network protocol information for this SAP.\n", + "type":"array", + "items":{ + "description":"This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.\n", + "type":"object", + "required":[ + "layerProtocol", + "ipOverEthernet" + ], + "properties":{ + "layerProtocol":{ + "description":"The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1.\n", + "type":"object", + "required":[ + "macAddress", + "ipAddresses" + ], + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "addresses":{ + "description":"Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "type":{ + "description":"The type of the IP addresses\n", + "type":"string", + "enum":[ + "PV4", + "PV6" + ] + }, + "addresses":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g. in case of egress connections. See note.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + }, + "nestedNsInstanceId":{ + "description":"Identifier of the nested NS(s) of the NS instance.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "nsState":{ + "description":"The state of the NS instance. Permitted values: NOT_INSTANTIATED: The NS instance is terminated or not instantiated. INSTANTIATED: The NS instance is instantiated.\n", + "type":"string", + "enum":[ + "NOT_INSTANTIATED", + "INSTANTIATED" + ] + }, + "monitoringParameter":{ + "description":"Performance metrics tracked by the NFVO (e.g. for auto-scaling purposes) as identified by the NS designer in the NSD.\n", + "type":"array", + "items":{ + "description":"This type represents a monitoring parameter that is tracked by the NFVO, for example, for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.68-1.\n", + "type":"object", + "required":[ + "id", + "performanceMetric" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "name":{ + "description":"Human readable name of the monitoring parameter, as defined in the NSD.\n", + "type":"string" + }, + "performanceMetric":{ + "description":"Performance metric that is monitored. This attribute shall contain the related \"Measurement Name\" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.\n", + "type":"string" + } + } + } + }, + "nsScaleStatus":{ + "description":"Status of each NS scaling aspect declared in the applicable DF, how \"big\" the NS instance has been scaled w.r.t. that aspect. This attribute shall be present if the nsState attribute value is INSTANTIATED.\n", + "type":"array", + "items":{ + "description":"This type represents the target NS Scale level for each NS scaling aspect of the current deployment flavor.\n", + "type":"object", + "required":[ + "nsScalingAspectId", + "nsScaleLevelId" + ], + "properties":{ + "nsScalingAspectId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "nsScaleLevelId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "additionalAffinityOrAntiAffinityRule":{ + "description":"Information on the additional affinity or anti-affinity rule from NS instantiation operation. Shall not conflict with rules already specified in the NSD.\n", + "type":"array", + "items":{ + "description":"This type describes the additional affinity or anti-affinity rule applicable between the VNF instances to be instantiated in the NS instantiation operation request or between the VNF instances to be instantiated in the NS instantiation operation request and the existing VNF instances..\n", + "type":"object", + "required":[ + "affinityOrAntiAffiinty", + "scope" + ], + "properties":{ + "vnfdId":{ + "description":"Reference to a VNFD. When the VNFD which is not used to instantiate VNF, it presents all VNF instances of this type as the subjects of the affinity or anti-affinity rule. The VNF instance which the VNFD presents is not necessary as a part of the NS to be instantiated.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "vnfProfileId":{ + "description":"Reference to a vnfProfile defined in the NSD. At least one VnfProfile which is used to instantiate VNF for the NS to be instantiated as the subject of the affinity or anti-affinity rule shall be present. When the VnfProfile which is not used to instantiate VNF, it presents all VNF instances of this type as the subjects of the affinity or anti-affinity rule. The VNF instance which the VnfProfile presents is not necessary as a part of the NS to be instantiated.\n", + "type":"array", + "items":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + } + }, + "vnfInstanceId":{ + "description":"Reference to the existing VNF instance as the subject of the affinity or anti-affinity rule. The existing VNF instance is not necessary as a part of the NS to be instantiated.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "affinityOrAntiAffiinty":{ + "description":"The type of the constraint. Permitted values: AFFINITY ANTI_AFFINITY.\n", + "type":"string", + "enum":[ + "AFFINITY", + "ANTI_AFFINITY" + ] + }, + "scope":{ + "description":"Specifies the scope of the rule where the placement constraint applies. Permitted values: NFVI_POP ZONE ZONE_GROUP NFVI_NODE.\n", + "type":"string", + "enum":[ + "NFVI_POP", + "ZONE", + "ZONE_GROUP", + "NFVI_NODE" + ] + } + } + } + }, + "_links":{ + "type":"object", + "description":"Links to resources related to this resource.", + "required":[ + "self" + ], + "properties":{ + "self":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "nestedNsInstances":{ + "description":"Links to resources related to this notification.\n", + "type":"array", + "items":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + } + }, + "instantiate":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "terminate":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "update":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "scale":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "heal":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + } + } + } + } + }, + "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.\n" + }, + "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.\n", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "409":{ + "description":"409 CONFLICT\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "416":{ + "description":"416 RANGE NOT SATISFIABLE\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + }, + "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, request 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", + "parameters":[ + { + "name":"filter", + "in":"query", + "required":false, + "type":"string", + "description":"Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFVO shall support receiving this parameter as part of the URI query string. The OSS/BSS may supply this parameter. All attribute names that appear in the NsInstance and in data types referenced from it shall be supported by the NFVO in the filter expression.\n" + }, + { + "name":"all_fields", + "in":"query", + "required":false, + "type":"string", + "description":"Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter.\n" + }, + { + "name":"fields", + "in":"query", + "required":false, + "type":"string", + "description":"\"Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO should support this parameter.\"\n" + }, + { + "name":"exclude_fields", + "in":"query", + "required":false, + "type":"string", + "description":"\"Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO should support this parameter.\"\n" + }, + { + "name":"exclude_default", + "in":"query", + "required":false, + "type":"string", + "description":"\"Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter. The 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: - vnfInstances - pnfInfo - virtualLinkInfo - vnffgInfo - sapInfo - nsScaleStatus - additionalAffinityOrAntiAffinityRules\"\n" + }, + { + "name":"nextpage_opaque_marker", + "in":"query", + "description":"Marker to obtain the next page of a paged response. Shall be supported by the NFVO if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.\n", + "required":false, + "type":"string" + }, + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + } + ], + "responses":{ + "200":{ + "description":"200 OK\nShall be returned when information about zero or more NS instances has been queried successfully. The response body shall contain in an array the representations of zero or more NS instances, as defined in clause 6.5.2.8. If the \"filter\" URI parameter or one of the \"all_fields\", \"fields\" (if supported), \"exclude_fields\" (if supported) or \"exclude_default\" URI parameters was supplied in the request, the data in the response body shall have been transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013 [16], respectively. If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 [16] for this resource, inclusion 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].\n", + "headers":{ + "Content-Type":{ + "description":"The MIME type of the body of the response.", + "type":"string", + "maximum":1, + "minimum":1 + }, + "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.\n", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + }, + "Link":{ + "description":"Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.\n", + "type":"string", + "maximum":1, + "minimum":0 + } + }, + "schema":{ + "type":"array", + "items":{ + "properties":{ + "NsInstance":{ + "description":"This type represents a response for Query NS operation. It shall comply with the provisions defined in Table 6.5.2.10-1.\n", + "type":"object", + "required":[ + "id", + "nsInstanceName", + "nsInstanceDescription", + "nsdId", + "nsdInfoId", + "nsState", + "_links" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsInstanceName":{ + "description":"Human readable name of the NS instance.\n", + "type":"string" + }, + "nsInstanceDescription":{ + "description":"Human readable description of the NS instance.\n", + "type":"string" + }, + "nsdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsdInfoId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "flavourId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "vnfInstance":{ + "description":"Information on constituent VNF(s) of the NS instance.\n", + "type":"array", + "items":{ + "description":"This type represents a VNF instance. Clause B.3.2 of ETSI GS NFV-SOL 003 [4] provides examples illustrating the relationship among the different run-time information elements (CP, VL and link ports) used to represent the connectivity of a VNF.\n", + "type":"object", + "required":[ + "id", + "vnfdId", + "vnfProvider", + "vnfProductName", + "vnfSoftwareVersion", + "vnfdVersion", + "vnfPkgId", + "instantiationState" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfInstanceName":{ + "description":"Name of the VNF instance. This attribute can be modified with the PATCH method.\n", + "type":"string" + }, + "vnfInstanceDescription":{ + "description":"Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n", + "type":"string" + }, + "vnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfProvider":{ + "description":"Provider of the VNF and the VNFD. The value is copied from the VNFD.\n", + "type":"string" + }, + "vnfProductName":{ + "description":"Name to identify the VNF Product. The value is copied from the VNFD.\n", + "type":"string" + }, + "vnfSoftwareVersion":{ + "description":"A Version. Representation: string of variable length.\n", + "type":"string" + }, + "vnfdVersion":{ + "description":"A Version. Representation: string of variable length.\n", + "type":"string" + }, + "vnfPkgId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfConfigurableProperties":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "instantiationState":{ + "description":"The instantiation state of the VNF.\n", + "type":"string", + "enum":[ + "NOT_INSTANTIATED", + "INSTANTIATED" + ] + }, + "instantiatedVnfInfo":{ + "description":"Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.\n", + "type":"object", + "required":[ + "flavourId", + "vnfState", + "extCpInfo" + ], + "properties":{ + "flavourId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "vnfState":{ + "type":"string", + "enum":[ + "STARTED", + "STOPPED" + ] + }, + "scaleStatus":{ + "description":"Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how \"big\" the VNF has been scaled w.r.t. that aspect.\n", + "type":"array", + "items":{ + "required":[ + "aspectId", + "scaleLevel" + ], + "type":"object", + "properties":{ + "aspectId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "scaleLevel":{ + "description":"Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n", + "type":"integer" + } + } + } + }, + "maxScaleLevels":{ + "description":"Maximum allowed scale levels of the VNF, one entry per aspect. This attribute shall be present if the VNF supports scaling.\n", + "type":"array", + "items":{ + "required":[ + "aspectId", + "scaleLevel" + ], + "type":"object", + "properties":{ + "aspectId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "scaleLevel":{ + "description":"Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n", + "type":"integer" + } + } + } + }, + "extCpInfo":{ + "description":"Information about the external CPs exposed by the VNF instance.\n", + "type":"array", + "minItems":1, + "items":{ + "description":"This type represents information about an external CP of a VNF. It shall comply with the provisions defined in Table 6.5.3.70-1.\n", + "type":"object", + "required":[ + "id", + "cpdId" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpdId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "cpProtocolInfo":{ + "description":"Network protocol information for this CP.\n", + "type":"array", + "minItems":1, + "items":{ + "description":"This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.\n", + "type":"object", + "required":[ + "layerProtocol", + "ipOverEthernet" + ], + "properties":{ + "layerProtocol":{ + "description":"The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1.\n", + "type":"object", + "required":[ + "macAddress", + "ipAddresses" + ], + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "addresses":{ + "description":"Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "type":{ + "description":"The type of the IP addresses\n", + "type":"string", + "enum":[ + "PV4", + "PV6" + ] + }, + "addresses":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g. in case of egress connections. See note.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + }, + "extLinkPortId":{ + "description":"This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.\n", + "type":"object", + "required":[ + "layerProtocol", + "ipOverEthernet" + ], + "properties":{ + "layerProtocol":{ + "description":"The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1.\n", + "type":"object", + "required":[ + "macAddress", + "ipAddresses" + ], + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "addresses":{ + "description":"Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "type":{ + "description":"The type of the IP addresses\n", + "type":"string", + "enum":[ + "PV4", + "PV6" + ] + }, + "addresses":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g. in case of egress connections. See note.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "associatedVnfcCpId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "associatedVnfVirtualLinkId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + } + } + } + }, + "extVirtualLinkInfo":{ + "description":"Information about the external VLs the VNF instance is connected to.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "extLinkPorts":{ + "description":"Link ports of this VL.\n", + "type":"array", + "items":{ + "description":"This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n", + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + } + } + } + } + } + } + }, + "extManagedVirtualLinkInfo":{ + "description":"External virtual links the VNF instance is connected to.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "vnfVirtualLinkDescId" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfVirtualLinkDescId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "networkResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "vnfLinkPorts":{ + "description":"Link ports of this VL.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpInstanceType":{ + "description":"Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: * VNFC_CP: The link port is connected to a VNFC CP * EXT_CP: The link port is associated to an external CP.\n", + "type":"string", + "enum":[ + "VNFC_CP", + "EXT_CP" + ] + } + } + } + } + } + } + }, + "monitoringParameters":{ + "description":"Performance metrics tracked by the VNFM (e.g. for auto-scaling purposes) as identified by the VNF provider in the VNFD.\n", + "type":"array", + "items":{ + "description":"This type represents a monitoring parameter that is tracked by the VNFM, for example, for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.69-1.\n", + "type":"object", + "required":[ + "id", + "performanceMetric" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "name":{ + "description":"Human readable name of the monitoring parameter, as defined in the VNFD.\n", + "type":"string" + }, + "performanceMetric":{ + "description":"Performance metric that is monitored. This attribute shall contain the related \"Measurement Name\" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.\n", + "type":"string" + } + } + } + }, + "localizationLanguage":{ + "description":"Information about localization language of the VNF (includes e.g. strings in the VNFD). The localization languages supported by a VNF can be declared in the VNFD, and localization language selection can take place at instantiation time. The value shall comply with the format defined in IETF RFC 5646.\n", + "type":"string" + }, + "vnfcResourceInfo":{ + "description":"Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n", + "type":"array", + "items":{ + "description":"This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n", + "type":"object", + "required":[ + "id", + "vduId", + "computeResource" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "vduId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "computeResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "storageResourceIds":{ + "description":"References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "reservationId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfcCpInfo":{ + "description":"CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is associated to an external CP of the VNF instance. May be present otherwise.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "cpdId" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpdId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "vnfExtCpId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpProtocolInfo":{ + "description":"Network protocol information for this CP.\n", + "type":"array", + "items":{ + "description":"This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.\n", + "type":"object", + "required":[ + "layerProtocol", + "ipOverEthernet" + ], + "properties":{ + "layerProtocol":{ + "description":"The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1.\n", + "type":"object", + "required":[ + "macAddress", + "ipAddresses" + ], + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "addresses":{ + "description":"Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "type":{ + "description":"The type of the IP addresses\n", + "type":"string", + "enum":[ + "PV4", + "PV6" + ] + }, + "addresses":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g. in case of egress connections. See note.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + }, + "vnfLinkPortId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "virtualLinkResourceInfo":{ + "description":"Information about the virtualised network resources used by the VLs of the VNF instance.\n", + "type":"array", + "items":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n", + "type":"object", + "required":[ + "id", + "vnfVirtualLinkDescId", + "networkResource" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "vnfVirtualLinkDescId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "networkResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "reservationId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfLinkPorts":{ + "description":"Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpInstanceType":{ + "description":"Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: * VNFC_CP: The link port is connected to a VNFC CP * EXT_CP: The link port is associated to an external CP.\n", + "type":"string", + "enum":[ + "VNFC_CP", + "EXT_CP" + ] + } + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "virtualStorageResourceInfo":{ + "description":"Information on the virtualised storage resource(s) used as storage for the VNF instance.\n", + "type":"array", + "items":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n", + "type":"object", + "required":[ + "id", + "virtualStorageDescId", + "storageResource" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "virtualStorageDescId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "storageResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "reservationId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "extensions":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "pnfInfo":{ + "description":"Information on the PNF(s) that are part of the NS instance.\n", + "type":"array", + "items":{ + "description":"This type represents the information about a PNF that is part of an NS instance. It shall comply with the provisions defined in Table 6.5.3.13-1.\n", + "type":"object", + "required":[ + "pnfId", + "pnfdId", + "pnfdInfoId", + "pnfProfileId" + ], + "properties":{ + "pnfId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfName":{ + "description":"Name of the PNF.\n", + "type":"string" + }, + "pnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfdInfoId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "cpInfo":{ + "description":"This type represents the information about the external CP of the PNF. It shall comply with the provisions defined in Table 6.5.3.17-1.\n", + "type":"object", + "required":[ + "cpInstanceId", + "cpdId" + ], + "properties":{ + "cpInstanceId":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + }, + "cpdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "cpProtocolData":{ + "description":"Parameters for configuring the network protocols on the CP.\n", + "type":"array", + "items":{ + "description":"This type represents network protocol data.\n", + "type":"object", + "required":[ + "layerProtocol" + ], + "properties":{ + "layerProtocol":{ + "description":"Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents network address data for IP over Ethernet.\n", + "type":"object", + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "fixedAddresses":{ + "description":"Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "numDynamicAddresses":{ + "description":"Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"integer" + }, + "addressRange":{ + "description":"An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "virtualLinkInfo":{ + "description":"Information on the VL(s) of the NS instance. This attribute shall be present if the nsState attribute value is INSTANTIATED and if the NS instance has specified connectivity.\n", + "type":"array", + "items":{ + "description":"This type specifies the information about an NS VL instance. It shall comply with the provisions defined in Table 6.5.3.53-1\n", + "type":"object", + "required":[ + "id", + "nsVirtualLinkDescId", + "nsVirtualLinkProfileId" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + }, + "nsVirtualLinkDescId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "nsVirtualLinkProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"Identifier(s) of the virtualised network resource(s) realizing the VL instance. See note.\n", + "type":"array", + "items":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + } + }, + "linkPort":{ + "description":"Link ports of the VL instance. Cardinality of zero indicates that no port has yet been created for the VL instance.\n", + "type":"array", + "items":{ + "description":"This type represents information about a link port of a VL instance. It shall comply with the provisions defined in Table 6.5.3.55-1.\n", + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "nsCpHandle":{ + "description":"Identifier of the CP/SAP instance to be connected to this link port. The value refers to a vnfExtCpInfo item in the VnfInstance, or a pnfExtCpInfo item in the PnfInfo, or a sapInfo item in the NS instance. There shall be at most one link port associated with any connection point instance.\n", + "type":"array", + "items":{ + "description":"This type represents an identifier of the CP or SAP instance. It shall comply with the provisions defined in Table 6.5.3.56-1.\n", + "type":"object", + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfExtCpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "pnfInfoId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfExtCpInstanceId":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + }, + "nsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsSapInstanceId":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + }, + "vnffgInfo":{ + "description":"Information on the VNFFG(s) of the NS instance.\n", + "type":"array", + "items":{ + "description":"Information on the VNFFG(s) of the NS instance.\n", + "type":"object", + "required":[ + "id", + "vnffgdId", + "vnfInstanceId", + "pnfInfoId" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnffgdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "vnfInstanceId":{ + "description":"Identifier(s) of the constituent VNF instance(s) of this VNFFG instance.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "pnfdInfoId":{ + "description":"Identifier(s) of the constituent PNF instance(s) of this VNFFG instance.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "nsVirtualLinkInfoId":{ + "description":"Identifier(s) of the constituent VL instance(s) of this VNFFG instance.\n", + "type":"array", + "items":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + } + }, + "nsCpHandle":{ + "description":"Identifiers of the CP instances attached to the constituent VNFs and PNFs or the SAP instances of the VNFFG. See note.\n", + "type":"array", + "items":{ + "description":"This type represents an identifier of the CP or SAP instance. It shall comply with the provisions defined in Table 6.5.3.56-1.\n", + "type":"object", + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfExtCpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "pnfInfoId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfExtCpInstanceId":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + }, + "nsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsSapInstanceId":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + }, + "sapInfo":{ + "description":"Information on the SAP(s) of the NS instance.\n", + "type":"array", + "items":{ + "description":"This type represents an SAP instance. It shall comply with the provisions defined in Table 6.5.3.67-1.\n", + "type":"object", + "required":[ + "id", + "sapdId", + "sapName", + "sapProtocolInfo" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + }, + "sapdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "sapName":{ + "description":"Human readable name for the SAP instance.\n", + "type":"string" + }, + "description":{ + "description":"Human readable description for the SAP instance.\n", + "type":"string" + }, + "sapProtocolInfo":{ + "description":"Network protocol information for this SAP.\n", + "type":"array", + "items":{ + "description":"This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.\n", + "type":"object", + "required":[ + "layerProtocol", + "ipOverEthernet" + ], + "properties":{ + "layerProtocol":{ + "description":"The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1.\n", + "type":"object", + "required":[ + "macAddress", + "ipAddresses" + ], + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "addresses":{ + "description":"Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "type":{ + "description":"The type of the IP addresses\n", + "type":"string", + "enum":[ + "PV4", + "PV6" + ] + }, + "addresses":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g. in case of egress connections. See note.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + }, + "nestedNsInstanceId":{ + "description":"Identifier of the nested NS(s) of the NS instance.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "nsState":{ + "description":"The state of the NS instance. Permitted values: NOT_INSTANTIATED: The NS instance is terminated or not instantiated. INSTANTIATED: The NS instance is instantiated.\n", + "type":"string", + "enum":[ + "NOT_INSTANTIATED", + "INSTANTIATED" + ] + }, + "monitoringParameter":{ + "description":"Performance metrics tracked by the NFVO (e.g. for auto-scaling purposes) as identified by the NS designer in the NSD.\n", + "type":"array", + "items":{ + "description":"This type represents a monitoring parameter that is tracked by the NFVO, for example, for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.68-1.\n", + "type":"object", + "required":[ + "id", + "performanceMetric" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "name":{ + "description":"Human readable name of the monitoring parameter, as defined in the NSD.\n", + "type":"string" + }, + "performanceMetric":{ + "description":"Performance metric that is monitored. This attribute shall contain the related \"Measurement Name\" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.\n", + "type":"string" + } + } + } + }, + "nsScaleStatus":{ + "description":"Status of each NS scaling aspect declared in the applicable DF, how \"big\" the NS instance has been scaled w.r.t. that aspect. This attribute shall be present if the nsState attribute value is INSTANTIATED.\n", + "type":"array", + "items":{ + "description":"This type represents the target NS Scale level for each NS scaling aspect of the current deployment flavor.\n", + "type":"object", + "required":[ + "nsScalingAspectId", + "nsScaleLevelId" + ], + "properties":{ + "nsScalingAspectId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "nsScaleLevelId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "additionalAffinityOrAntiAffinityRule":{ + "description":"Information on the additional affinity or anti-affinity rule from NS instantiation operation. Shall not conflict with rules already specified in the NSD.\n", + "type":"array", + "items":{ + "description":"This type describes the additional affinity or anti-affinity rule applicable between the VNF instances to be instantiated in the NS instantiation operation request or between the VNF instances to be instantiated in the NS instantiation operation request and the existing VNF instances..\n", + "type":"object", + "required":[ + "affinityOrAntiAffiinty", + "scope" + ], + "properties":{ + "vnfdId":{ + "description":"Reference to a VNFD. When the VNFD which is not used to instantiate VNF, it presents all VNF instances of this type as the subjects of the affinity or anti-affinity rule. The VNF instance which the VNFD presents is not necessary as a part of the NS to be instantiated.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "vnfProfileId":{ + "description":"Reference to a vnfProfile defined in the NSD. At least one VnfProfile which is used to instantiate VNF for the NS to be instantiated as the subject of the affinity or anti-affinity rule shall be present. When the VnfProfile which is not used to instantiate VNF, it presents all VNF instances of this type as the subjects of the affinity or anti-affinity rule. The VNF instance which the VnfProfile presents is not necessary as a part of the NS to be instantiated.\n", + "type":"array", + "items":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + } + }, + "vnfInstanceId":{ + "description":"Reference to the existing VNF instance as the subject of the affinity or anti-affinity rule. The existing VNF instance is not necessary as a part of the NS to be instantiated.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "affinityOrAntiAffiinty":{ + "description":"The type of the constraint. Permitted values: AFFINITY ANTI_AFFINITY.\n", + "type":"string", + "enum":[ + "AFFINITY", + "ANTI_AFFINITY" + ] + }, + "scope":{ + "description":"Specifies the scope of the rule where the placement constraint applies. Permitted values: NFVI_POP ZONE ZONE_GROUP NFVI_NODE.\n", + "type":"string", + "enum":[ + "NFVI_POP", + "ZONE", + "ZONE_GROUP", + "NFVI_NODE" + ] + } + } + } + }, + "_links":{ + "type":"object", + "description":"Links to resources related to this resource.", + "required":[ + "self" + ], + "properties":{ + "self":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "nestedNsInstances":{ + "description":"Links to resources related to this notification.\n", + "type":"array", + "items":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + } + }, + "instantiate":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "terminate":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "update":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "scale":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "heal":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + } + } + } + } + } + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "409":{ + "description":"409 CONFLICT\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "416":{ + "description":"416 RANGE NOT SATISFIABLE\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/ns_instances/{nsInstanceId}":{ + "parameters":[ + { + "name":"nsInstanceId", + "description":"Identifier of the NS instance.\n", + "in":"path", + "type":"string", + "required":true + }, + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235.\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + } + ], + "get":{ + "summary":"Read an individual NS instance resource.", + "description":"The GET method retrieves information about a NS instance by reading an individual NS instance resource.\n", + "parameters":[ + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Content-Type", + "description":"The MIME type of the body of the request. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + } + ], + "responses":{ + "200":{ + "description":"200 OK\nShall be returned when information about an individual NS instance has been read successfully. The response body shall contain a representation of the NS instance, as defined in clause 6.5.2.10.\n", + "schema":{ + "description":"This type represents a response for Query NS operation. It shall comply with the provisions defined in Table 6.5.2.10-1.\n", + "type":"object", + "required":[ + "id", + "nsInstanceName", + "nsInstanceDescription", + "nsdId", + "nsdInfoId", + "nsState", + "_links" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsInstanceName":{ + "description":"Human readable name of the NS instance.\n", + "type":"string" + }, + "nsInstanceDescription":{ + "description":"Human readable description of the NS instance.\n", + "type":"string" + }, + "nsdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsdInfoId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "flavourId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "vnfInstance":{ + "description":"Information on constituent VNF(s) of the NS instance.\n", + "type":"array", + "items":{ + "description":"This type represents a VNF instance. Clause B.3.2 of ETSI GS NFV-SOL 003 [4] provides examples illustrating the relationship among the different run-time information elements (CP, VL and link ports) used to represent the connectivity of a VNF.\n", + "type":"object", + "required":[ + "id", + "vnfdId", + "vnfProvider", + "vnfProductName", + "vnfSoftwareVersion", + "vnfdVersion", + "vnfPkgId", + "instantiationState" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfInstanceName":{ + "description":"Name of the VNF instance. This attribute can be modified with the PATCH method.\n", + "type":"string" + }, + "vnfInstanceDescription":{ + "description":"Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n", + "type":"string" + }, + "vnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfProvider":{ + "description":"Provider of the VNF and the VNFD. The value is copied from the VNFD.\n", + "type":"string" + }, + "vnfProductName":{ + "description":"Name to identify the VNF Product. The value is copied from the VNFD.\n", + "type":"string" + }, + "vnfSoftwareVersion":{ + "description":"A Version. Representation: string of variable length.\n", + "type":"string" + }, + "vnfdVersion":{ + "description":"A Version. Representation: string of variable length.\n", + "type":"string" + }, + "vnfPkgId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfConfigurableProperties":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "instantiationState":{ + "description":"The instantiation state of the VNF.\n", + "type":"string", + "enum":[ + "NOT_INSTANTIATED", + "INSTANTIATED" + ] + }, + "instantiatedVnfInfo":{ + "description":"Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.\n", + "type":"object", + "required":[ + "flavourId", + "vnfState", + "extCpInfo" + ], + "properties":{ + "flavourId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "vnfState":{ + "type":"string", + "enum":[ + "STARTED", + "STOPPED" + ] + }, + "scaleStatus":{ + "description":"Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how \"big\" the VNF has been scaled w.r.t. that aspect.\n", + "type":"array", + "items":{ + "required":[ + "aspectId", + "scaleLevel" + ], + "type":"object", + "properties":{ + "aspectId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "scaleLevel":{ + "description":"Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n", + "type":"integer" + } + } + } + }, + "maxScaleLevels":{ + "description":"Maximum allowed scale levels of the VNF, one entry per aspect. This attribute shall be present if the VNF supports scaling.\n", + "type":"array", + "items":{ + "required":[ + "aspectId", + "scaleLevel" + ], + "type":"object", + "properties":{ + "aspectId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "scaleLevel":{ + "description":"Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n", + "type":"integer" + } + } + } + }, + "extCpInfo":{ + "description":"Information about the external CPs exposed by the VNF instance.\n", + "type":"array", + "minItems":1, + "items":{ + "description":"This type represents information about an external CP of a VNF. It shall comply with the provisions defined in Table 6.5.3.70-1.\n", + "type":"object", + "required":[ + "id", + "cpdId" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpdId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "cpProtocolInfo":{ + "description":"Network protocol information for this CP.\n", + "type":"array", + "minItems":1, + "items":{ + "description":"This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.\n", + "type":"object", + "required":[ + "layerProtocol", + "ipOverEthernet" + ], + "properties":{ + "layerProtocol":{ + "description":"The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1.\n", + "type":"object", + "required":[ + "macAddress", + "ipAddresses" + ], + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "addresses":{ + "description":"Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "type":{ + "description":"The type of the IP addresses\n", + "type":"string", + "enum":[ + "PV4", + "PV6" + ] + }, + "addresses":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g. in case of egress connections. See note.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + }, + "extLinkPortId":{ + "description":"This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.\n", + "type":"object", + "required":[ + "layerProtocol", + "ipOverEthernet" + ], + "properties":{ + "layerProtocol":{ + "description":"The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1.\n", + "type":"object", + "required":[ + "macAddress", + "ipAddresses" + ], + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "addresses":{ + "description":"Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "type":{ + "description":"The type of the IP addresses\n", + "type":"string", + "enum":[ + "PV4", + "PV6" + ] + }, + "addresses":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g. in case of egress connections. See note.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "associatedVnfcCpId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "associatedVnfVirtualLinkId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + } + } + } + }, + "extVirtualLinkInfo":{ + "description":"Information about the external VLs the VNF instance is connected to.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "extLinkPorts":{ + "description":"Link ports of this VL.\n", + "type":"array", + "items":{ + "description":"This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n", + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + } + } + } + } + } + } + }, + "extManagedVirtualLinkInfo":{ + "description":"External virtual links the VNF instance is connected to.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "vnfVirtualLinkDescId" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfVirtualLinkDescId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "networkResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "vnfLinkPorts":{ + "description":"Link ports of this VL.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpInstanceType":{ + "description":"Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: * VNFC_CP: The link port is connected to a VNFC CP * EXT_CP: The link port is associated to an external CP.\n", + "type":"string", + "enum":[ + "VNFC_CP", + "EXT_CP" + ] + } + } + } + } + } + } + }, + "monitoringParameters":{ + "description":"Performance metrics tracked by the VNFM (e.g. for auto-scaling purposes) as identified by the VNF provider in the VNFD.\n", + "type":"array", + "items":{ + "description":"This type represents a monitoring parameter that is tracked by the VNFM, for example, for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.69-1.\n", + "type":"object", + "required":[ + "id", + "performanceMetric" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "name":{ + "description":"Human readable name of the monitoring parameter, as defined in the VNFD.\n", + "type":"string" + }, + "performanceMetric":{ + "description":"Performance metric that is monitored. This attribute shall contain the related \"Measurement Name\" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.\n", + "type":"string" + } + } + } + }, + "localizationLanguage":{ + "description":"Information about localization language of the VNF (includes e.g. strings in the VNFD). The localization languages supported by a VNF can be declared in the VNFD, and localization language selection can take place at instantiation time. The value shall comply with the format defined in IETF RFC 5646.\n", + "type":"string" + }, + "vnfcResourceInfo":{ + "description":"Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n", + "type":"array", + "items":{ + "description":"This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n", + "type":"object", + "required":[ + "id", + "vduId", + "computeResource" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "vduId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "computeResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "storageResourceIds":{ + "description":"References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "reservationId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfcCpInfo":{ + "description":"CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is associated to an external CP of the VNF instance. May be present otherwise.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "cpdId" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpdId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "vnfExtCpId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpProtocolInfo":{ + "description":"Network protocol information for this CP.\n", + "type":"array", + "items":{ + "description":"This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.\n", + "type":"object", + "required":[ + "layerProtocol", + "ipOverEthernet" + ], + "properties":{ + "layerProtocol":{ + "description":"The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1.\n", + "type":"object", + "required":[ + "macAddress", + "ipAddresses" + ], + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "addresses":{ + "description":"Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "type":{ + "description":"The type of the IP addresses\n", + "type":"string", + "enum":[ + "PV4", + "PV6" + ] + }, + "addresses":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g. in case of egress connections. See note.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + }, + "vnfLinkPortId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "virtualLinkResourceInfo":{ + "description":"Information about the virtualised network resources used by the VLs of the VNF instance.\n", + "type":"array", + "items":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n", + "type":"object", + "required":[ + "id", + "vnfVirtualLinkDescId", + "networkResource" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "vnfVirtualLinkDescId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "networkResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "reservationId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfLinkPorts":{ + "description":"Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "cpInstanceType":{ + "description":"Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: * VNFC_CP: The link port is connected to a VNFC CP * EXT_CP: The link port is associated to an external CP.\n", + "type":"string", + "enum":[ + "VNFC_CP", + "EXT_CP" + ] + } + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "virtualStorageResourceInfo":{ + "description":"Information on the virtualised storage resource(s) used as storage for the VNF instance.\n", + "type":"array", + "items":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n", + "type":"object", + "required":[ + "id", + "virtualStorageDescId", + "storageResource" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "virtualStorageDescId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "storageResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "reservationId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "extensions":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "pnfInfo":{ + "description":"Information on the PNF(s) that are part of the NS instance.\n", + "type":"array", + "items":{ + "description":"This type represents the information about a PNF that is part of an NS instance. It shall comply with the provisions defined in Table 6.5.3.13-1.\n", + "type":"object", + "required":[ + "pnfId", + "pnfdId", + "pnfdInfoId", + "pnfProfileId" + ], + "properties":{ + "pnfId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfName":{ + "description":"Name of the PNF.\n", + "type":"string" + }, + "pnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfdInfoId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "cpInfo":{ + "description":"This type represents the information about the external CP of the PNF. It shall comply with the provisions defined in Table 6.5.3.17-1.\n", + "type":"object", + "required":[ + "cpInstanceId", + "cpdId" + ], + "properties":{ + "cpInstanceId":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + }, + "cpdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "cpProtocolData":{ + "description":"Parameters for configuring the network protocols on the CP.\n", + "type":"array", + "items":{ + "description":"This type represents network protocol data.\n", + "type":"object", + "required":[ + "layerProtocol" + ], + "properties":{ + "layerProtocol":{ + "description":"Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents network address data for IP over Ethernet.\n", + "type":"object", + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "fixedAddresses":{ + "description":"Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "numDynamicAddresses":{ + "description":"Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"integer" + }, + "addressRange":{ + "description":"An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "virtualLinkInfo":{ + "description":"Information on the VL(s) of the NS instance. This attribute shall be present if the nsState attribute value is INSTANTIATED and if the NS instance has specified connectivity.\n", + "type":"array", + "items":{ + "description":"This type specifies the information about an NS VL instance. It shall comply with the provisions defined in Table 6.5.3.53-1\n", + "type":"object", + "required":[ + "id", + "nsVirtualLinkDescId", + "nsVirtualLinkProfileId" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + }, + "nsVirtualLinkDescId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "nsVirtualLinkProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"Identifier(s) of the virtualised network resource(s) realizing the VL instance. See note.\n", + "type":"array", + "items":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + } + }, + "linkPort":{ + "description":"Link ports of the VL instance. Cardinality of zero indicates that no port has yet been created for the VL instance.\n", + "type":"array", + "items":{ + "description":"This type represents information about a link port of a VL instance. It shall comply with the provisions defined in Table 6.5.3.55-1.\n", + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "nsCpHandle":{ + "description":"Identifier of the CP/SAP instance to be connected to this link port. The value refers to a vnfExtCpInfo item in the VnfInstance, or a pnfExtCpInfo item in the PnfInfo, or a sapInfo item in the NS instance. There shall be at most one link port associated with any connection point instance.\n", + "type":"array", + "items":{ + "description":"This type represents an identifier of the CP or SAP instance. It shall comply with the provisions defined in Table 6.5.3.56-1.\n", + "type":"object", + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfExtCpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "pnfInfoId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfExtCpInstanceId":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + }, + "nsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsSapInstanceId":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + }, + "vnffgInfo":{ + "description":"Information on the VNFFG(s) of the NS instance.\n", + "type":"array", + "items":{ + "description":"Information on the VNFFG(s) of the NS instance.\n", + "type":"object", + "required":[ + "id", + "vnffgdId", + "vnfInstanceId", + "pnfInfoId" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnffgdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "vnfInstanceId":{ + "description":"Identifier(s) of the constituent VNF instance(s) of this VNFFG instance.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "pnfdInfoId":{ + "description":"Identifier(s) of the constituent PNF instance(s) of this VNFFG instance.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "nsVirtualLinkInfoId":{ + "description":"Identifier(s) of the constituent VL instance(s) of this VNFFG instance.\n", + "type":"array", + "items":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + } + }, + "nsCpHandle":{ + "description":"Identifiers of the CP instances attached to the constituent VNFs and PNFs or the SAP instances of the VNFFG. See note.\n", + "type":"array", + "items":{ + "description":"This type represents an identifier of the CP or SAP instance. It shall comply with the provisions defined in Table 6.5.3.56-1.\n", + "type":"object", + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfExtCpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "pnfInfoId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfExtCpInstanceId":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + }, + "nsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsSapInstanceId":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + }, + "sapInfo":{ + "description":"Information on the SAP(s) of the NS instance.\n", + "type":"array", + "items":{ + "description":"This type represents an SAP instance. It shall comply with the provisions defined in Table 6.5.3.67-1.\n", + "type":"object", + "required":[ + "id", + "sapdId", + "sapName", + "sapProtocolInfo" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + }, + "sapdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "sapName":{ + "description":"Human readable name for the SAP instance.\n", + "type":"string" + }, + "description":{ + "description":"Human readable description for the SAP instance.\n", + "type":"string" + }, + "sapProtocolInfo":{ + "description":"Network protocol information for this SAP.\n", + "type":"array", + "items":{ + "description":"This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.\n", + "type":"object", + "required":[ + "layerProtocol", + "ipOverEthernet" + ], + "properties":{ + "layerProtocol":{ + "description":"The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1.\n", + "type":"object", + "required":[ + "macAddress", + "ipAddresses" + ], + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "addresses":{ + "description":"Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "type":{ + "description":"The type of the IP addresses\n", + "type":"string", + "enum":[ + "PV4", + "PV6" + ] + }, + "addresses":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "isDynamic":{ + "description":"Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n", + "type":"boolean" + }, + "addressRange":{ + "description":"An IP address range used, e.g. in case of egress connections. See note.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + }, + "nestedNsInstanceId":{ + "description":"Identifier of the nested NS(s) of the NS instance.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "nsState":{ + "description":"The state of the NS instance. Permitted values: NOT_INSTANTIATED: The NS instance is terminated or not instantiated. INSTANTIATED: The NS instance is instantiated.\n", + "type":"string", + "enum":[ + "NOT_INSTANTIATED", + "INSTANTIATED" + ] + }, + "monitoringParameter":{ + "description":"Performance metrics tracked by the NFVO (e.g. for auto-scaling purposes) as identified by the NS designer in the NSD.\n", + "type":"array", + "items":{ + "description":"This type represents a monitoring parameter that is tracked by the NFVO, for example, for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.68-1.\n", + "type":"object", + "required":[ + "id", + "performanceMetric" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "name":{ + "description":"Human readable name of the monitoring parameter, as defined in the NSD.\n", + "type":"string" + }, + "performanceMetric":{ + "description":"Performance metric that is monitored. This attribute shall contain the related \"Measurement Name\" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.\n", + "type":"string" + } + } + } + }, + "nsScaleStatus":{ + "description":"Status of each NS scaling aspect declared in the applicable DF, how \"big\" the NS instance has been scaled w.r.t. that aspect. This attribute shall be present if the nsState attribute value is INSTANTIATED.\n", + "type":"array", + "items":{ + "description":"This type represents the target NS Scale level for each NS scaling aspect of the current deployment flavor.\n", + "type":"object", + "required":[ + "nsScalingAspectId", + "nsScaleLevelId" + ], + "properties":{ + "nsScalingAspectId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "nsScaleLevelId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "additionalAffinityOrAntiAffinityRule":{ + "description":"Information on the additional affinity or anti-affinity rule from NS instantiation operation. Shall not conflict with rules already specified in the NSD.\n", + "type":"array", + "items":{ + "description":"This type describes the additional affinity or anti-affinity rule applicable between the VNF instances to be instantiated in the NS instantiation operation request or between the VNF instances to be instantiated in the NS instantiation operation request and the existing VNF instances..\n", + "type":"object", + "required":[ + "affinityOrAntiAffiinty", + "scope" + ], + "properties":{ + "vnfdId":{ + "description":"Reference to a VNFD. When the VNFD which is not used to instantiate VNF, it presents all VNF instances of this type as the subjects of the affinity or anti-affinity rule. The VNF instance which the VNFD presents is not necessary as a part of the NS to be instantiated.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "vnfProfileId":{ + "description":"Reference to a vnfProfile defined in the NSD. At least one VnfProfile which is used to instantiate VNF for the NS to be instantiated as the subject of the affinity or anti-affinity rule shall be present. When the VnfProfile which is not used to instantiate VNF, it presents all VNF instances of this type as the subjects of the affinity or anti-affinity rule. The VNF instance which the VnfProfile presents is not necessary as a part of the NS to be instantiated.\n", + "type":"array", + "items":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + } + }, + "vnfInstanceId":{ + "description":"Reference to the existing VNF instance as the subject of the affinity or anti-affinity rule. The existing VNF instance is not necessary as a part of the NS to be instantiated.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "affinityOrAntiAffiinty":{ + "description":"The type of the constraint. Permitted values: AFFINITY ANTI_AFFINITY.\n", + "type":"string", + "enum":[ + "AFFINITY", + "ANTI_AFFINITY" + ] + }, + "scope":{ + "description":"Specifies the scope of the rule where the placement constraint applies. Permitted values: NFVI_POP ZONE ZONE_GROUP NFVI_NODE.\n", + "type":"string", + "enum":[ + "NFVI_POP", + "ZONE", + "ZONE_GROUP", + "NFVI_NODE" + ] + } + } + } + }, + "_links":{ + "type":"object", + "description":"Links to resources related to this resource.", + "required":[ + "self" + ], + "properties":{ + "self":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "nestedNsInstances":{ + "description":"Links to resources related to this notification.\n", + "type":"array", + "items":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + } + }, + "instantiate":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "terminate":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "update":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "scale":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "heal":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + } + } + } + } + }, + "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.\n", + "maximum":1, + "minimum":1 + }, + "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.\n", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "416":{ + "description":"416 RANGE NOT SATISFIABLE\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + }, + "delete":{ + "summary":"Delete NS instance resource.", + "description":"Delete NS Identifier\nThis method deletes an individual NS instance resource. As the result of successfully executing this method, the \"Individual NS instance\" resource shall not exist any longer. A notification of type \"NsIdentifierDeletionNotification\" shall be triggered as part of successfully executing this method as defined in clause 6.5.2.7.\n", + "responses":{ + "204":{ + "description":"204 No Content\nShall be returned when the \"Individual NS instance\" resource and the associated NS identifier have been deleted successfully. The response body shall be empty.\n", + "headers":{ + "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.\n", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "409":{ + "description":"409 CONFLICT\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "412":{ + "description":"412 PRECONDITION FAILED\nError: A precondition given in an HTTP request header is not fulfilled. Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity. The response body should contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/ns_instances/{nsInstanceId}/instantiate":{ + "parameters":[ + { + "name":"nsInstanceId", + "description":"Identifier of the NS instance to be instantiated.\n", + "in":"path", + "type":"string", + "required":true + } + ], + "post":{ + "summary":"Instantiate a NS.", + "description":"The POST method requests to instantiate a NS instance resource. The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2. In addition, once the NFVO has successfully completed the underlying NS LCM operation occurrence, it shall set the \"nsState\" attribute to the value \"INSTANTIATED\" in the representation of the \"Individual NS instance\" resource.\n", + "parameters":[ + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Content-Type", + "description":"The MIME type of the body of the request. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"InstantiateNsRequest", + "in":"body", + "required":true, + "schema":{ + "type":"object", + "required":[ + "nsFlavourId" + ], + "properties":{ + "nsFlavourId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "sapData":{ + "description":"Create data concerning the SAPs of this NS.\n", + "type":"array", + "items":{ + "description":"This type represents the information related to a SAP of a NS. It shall comply with the provisions defined in Table 6.5.3.10-1.\n", + "type":"object", + "required":[ + "sapdId", + "sapName", + "description" + ], + "properties":{ + "sapdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "sapName":{ + "description":"Human readable name for the SAP.\n", + "type":"string" + }, + "description":{ + "description":"Human readable description for the SAP.\n", + "type":"string" + }, + "sapProtocolData":{ + "description":"Parameters for configuring the network protocols on the SAP.\n", + "type":"array", + "items":{ + "description":"This type represents network protocol data.\n", + "type":"object", + "required":[ + "layerProtocol" + ], + "properties":{ + "layerProtocol":{ + "description":"Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents network address data for IP over Ethernet.\n", + "type":"object", + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "fixedAddresses":{ + "description":"Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "numDynamicAddresses":{ + "description":"Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"integer" + }, + "addressRange":{ + "description":"An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + } + }, + "addpnfData":{ + "description":"Information on the PNF(s) that are part of this NS.\n", + "type":"array", + "items":{ + "description":"This type specifies an PNF to be added to the NS instance and the PNF Profile to use for this PNF. It shall comply with the provisions defined in Table 6.5.3.14-1.\n", + "type":"object", + "required":[ + "pnfId", + "pnfName", + "pnfdId", + "pnfProfileId" + ], + "properties":{ + "pnfId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfName":{ + "description":"Name of the PNF\n", + "type":"string" + }, + "pnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "cpData":{ + "description":"Address assigned for the PNF external CP(s).\n", + "type":"array", + "items":{ + "description":"This type represents the configuration data on the external CP of the PNF. It shall comply with the provisions defined in Table 6.5.3.16-1.\n", + "type":"object", + "required":[ + "cpProtocolData" + ], + "properties":{ + "cpInstanceId":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + }, + "cpdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "cpProtocolData":{ + "description":"Address assigned for this CP.\n", + "type":"array", + "items":{ + "description":"This type represents network protocol data.\n", + "type":"object", + "required":[ + "layerProtocol" + ], + "properties":{ + "layerProtocol":{ + "description":"Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents network address data for IP over Ethernet.\n", + "type":"object", + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "fixedAddresses":{ + "description":"Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "numDynamicAddresses":{ + "description":"Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"integer" + }, + "addressRange":{ + "description":"An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "vnfInstanceData":{ + "description":"Specify an existing VNF instance to be used in the NS. If needed, the VNF Profile to be used for this VNF instance is also provided. The DF of the VNF instance shall match the VNF DF present in the associated VNF Profile.\n", + "type":"array", + "items":{ + "description":"This type specifies an existing VNF instance to be used in the NS instance and if needed, the VNF Profile to use for this VNF instance. It shall comply with the provisions defined in Table 6.5.3.19-1.\n", + "type":"object", + "required":[ + "vnfInstanceId", + "vnfProfileId" + ], + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "nestedNsInstanceData":{ + "description":"Specify an existing NS instance to be used as a nested NS within the NS. If needed, the NS Profile to be used for this nested NS instance is also provided. NOTE 2: The NS DF of each nested NS shall be one of the allowed flavours in the associated NSD (as referenced in the nestedNsd attribute of the NSD of the NS to be instantiated). NOTE 3: The NSD of each referenced NSs (i.e. each nestedInstanceId) shall match the one of the nested NSD in the composite NSD.\n", + "type":"array", + "items":{ + "description":"This type specifies an existing nested NS instance to be used in the NS instance and if needed, the NsProfile to use for this nested NS instance. It shall comply with the provisions defined in Table 6.5.3.19a-1.\n", + "type":"object", + "required":[ + "nestedNsInstanceId" + ], + "properties":{ + "nestedNsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsProfileId":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "locationConstraints":{ + "description":"Defines the location constraints for the VNF to be instantiated as part of the NS instantiation. An example can be a constraint for the VNF to be in a specific geographic location..\n", + "type":"array", + "items":{ + "description":"This type represents the association of location constraints to a VNF instance to be created according to a specific VNF profile. It shall comply with the provisions defined in Table 6.5.3.20-1.\n", + "type":"object", + "required":[ + "vnfProfileId" + ], + "properties":{ + "vnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "locationConstraints":{ + "description":"This type represents location constraints for a VNF to be instantiated. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776 [13].\n", + "type":"object", + "required":[ + "countryCode" + ], + "properties":{ + "countryCode":{ + "description":"The two-letter ISO 3166 [29] country code in capital letters.\n", + "type":"string" + }, + "civicAddressElement":{ + "description":"Zero or more elements comprising the civic address.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "caType", + "caValue" + ], + "properties":{ + "caType":{ + "description":"Describe the content type of caValue. The value of caType shall comply with Section 3.4 of IETF RFC 4776 [13].\n", + "type":"integer" + }, + "caValue":{ + "description":"Content of civic address element corresponding to the caType. The format caValue shall comply with Section 3.4 of IETF RFC 4776 [13].\n", + "type":"string" + } + } + } + } + } + } + } + } + }, + "additionalParamsForNs":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "additionalParamForNestedNs":{ + "description":"Allows the OSS/BSS to provide additional parameter(s) per nested NS instance (as opposed to the composite NS level, which is covered in additionalParamForNs, and as opposed to the VNF level, which is covered in additionalParamForVnf). This is for nested NS instances that are to be created by the NFVO as part of the NS instantiation and not for existing nested NS instances that are referenced for reuse.\n", + "type":"array", + "items":{ + "description":"This type specifies additional parameters on a per-nested NS instance basis. It shall comply with the provisions defined in Table 6.5.3.21a-1.\n", + "type":"object", + "required":[ + "nsProfileId" + ], + "properties":{ + "nsProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "additionalParam":{ + "description":"Additional parameters that are to be applied on a per nested NS instance.\n", + "type":"array", + "items":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + } + }, + "additionalParamsForVnf":{ + "description":"Allows the OSS/BSS to provide additional parameter(s) per VNF instance (as opposed to the composite NS level, which is covered in additionalParamsForNs and as opposed to the nested NS level, which is covered in additionalParamForNestedNs). This is for VNFs that are to be created by the NFVO as part of the NS instantiation and not for existing VNF that are referenced for reuse.\n", + "type":"array", + "items":{ + "description":"This type defines the additional parameters for the VNF instance to be created associated with an NS instance. It shall comply with the provisions defined in Table 6.5.3.22-1.\n", + "type":"object", + "required":[ + "vnfProfileId" + ], + "properties":{ + "vnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "vnfInstanceName":{ + "description":"Human-readable name of the VNF instance to be created.\n", + "type":"string" + }, + "vnfInstanceDescription":{ + "description":"Human-readable description of the VNF instance to be created.\n", + "type":"string" + }, + "vnfConfigurableProperties":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "extensions":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "additionalParams":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "startTime":{ + "description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n", + "format":"date-time", + "type":"string" + }, + "nsInstantiationLevelId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "additionalAffinityOrAntiAffinityRule":{ + "description":"Specifies additional affinity or anti-affinity constraint for the VNF instances to be instantiated as part of the NS instantiation. Shall not conflict with rules already specified in the NSD.\n", + "type":"array", + "items":{ + "description":"This type describes the additional affinity or anti-affinity rule applicable between the VNF instances to be instantiated in the NS instantiation operation request or between the VNF instances to be instantiated in the NS instantiation operation request and the existing VNF instances..\n", + "type":"object", + "required":[ + "affinityOrAntiAffiinty", + "scope" + ], + "properties":{ + "vnfdId":{ + "description":"Reference to a VNFD. When the VNFD which is not used to instantiate VNF, it presents all VNF instances of this type as the subjects of the affinity or anti-affinity rule. The VNF instance which the VNFD presents is not necessary as a part of the NS to be instantiated.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "vnfProfileId":{ + "description":"Reference to a vnfProfile defined in the NSD. At least one VnfProfile which is used to instantiate VNF for the NS to be instantiated as the subject of the affinity or anti-affinity rule shall be present. When the VnfProfile which is not used to instantiate VNF, it presents all VNF instances of this type as the subjects of the affinity or anti-affinity rule. The VNF instance which the VnfProfile presents is not necessary as a part of the NS to be instantiated.\n", + "type":"array", + "items":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + } + }, + "vnfInstanceId":{ + "description":"Reference to the existing VNF instance as the subject of the affinity or anti-affinity rule. The existing VNF instance is not necessary as a part of the NS to be instantiated.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "affinityOrAntiAffiinty":{ + "description":"The type of the constraint. Permitted values: AFFINITY ANTI_AFFINITY.\n", + "type":"string", + "enum":[ + "AFFINITY", + "ANTI_AFFINITY" + ] + }, + "scope":{ + "description":"Specifies the scope of the rule where the placement constraint applies. Permitted values: NFVI_POP ZONE ZONE_GROUP NFVI_NODE.\n", + "type":"string", + "enum":[ + "NFVI_POP", + "ZONE", + "ZONE_GROUP", + "NFVI_NODE" + ] + } + } + } + } + } + }, + "description":"Parameters for the instantiate NS operation, as defined in clause 6.5.2.11.\n" + } + ], + "responses":{ + "202":{ + "description":"202 ACCEPTED\n", + "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", + "maximum":1, + "minimum":0 + }, + "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", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "409":{ + "description":"409 CONFLICT\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "416":{ + "description":"416 RANGE NOT SATISFIABLE\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/ns_instances/{nsInstanceId}/scale":{ + "parameters":[ + { + "name":"nsInstanceId", + "description":"Identifier of the NS instance to be scaled.\n", + "in":"path", + "type":"string", + "required":true + } + ], + "post":{ + "summary":"Scale a NS instance.", + "description":"The POST method requests to scale a NS instance resource. The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2. In addition, once the NFVO has successfully completed the underlying NS LCM operation occurrence, it shall reflect the result of scaling the NS instance by updating the \"nsScaleStatus\" attribute in the representation of the \"Individual NS instance\" resource.\n", + "parameters":[ + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Content-Type", + "description":"The MIME type of the body of the request. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"body", + "in":"body", + "required":true, + "schema":{ + "description":"This type represents a request for the scale NS operation. Either the parameter scaleNsData or the parameter scaleVnfData, but not both shall be provided\n", + "type":"object", + "required":[ + "scaleType" + ], + "properties":{ + "scaleType":{ + "description":"Indicates the type of scaling to be performed. Possible values: - SCALE_NS - SCALE_VNF\n", + "type":"string", + "enum":[ + "SCALE_NS", + "SCALE_VNF" + ] + }, + "scaleNsData":{ + "description":"This type represents the information to scale a NS.\n", + "type":"object", + "properties":{ + "vnfInstanceToBeAdded":{ + "description":"An existing VNF instance to be added to the NS instance as part of the scaling operation. If needed, the VNF Profile to be used for this VNF instance may also be provided.\n", + "type":"array", + "items":{ + "description":"This type specifies an existing VNF instance to be used in the NS instance and if needed, the VNF Profile to use for this VNF instance. It shall comply with the provisions defined in Table 6.5.3.19-1.\n", + "type":"object", + "required":[ + "vnfInstanceId", + "vnfProfileId" + ], + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "vnfInstanceToBeRemoved":{ + "description":"The VNF instance to be removed from the NS instance as part of the scaling operation.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "scaleNsByStepsData":{ + "description":"This type represents the information used to scale an NS instance by one or more scaling steps, with respect to a particular NS scaling aspect. Performing a scaling step means increasing/decreasing the capacity of an NS instance in a discrete manner, i.e. moving from one NS scale level to another. The NS scaling aspects and their corresponding NS scale levels applicable to the NS instance are declared in the NSD.\n", + "type":"object", + "required":[ + "scalingDirection", + "aspectId" + ], + "properties":{ + "scalingDirection":{ + "description":"The scaling direction. Possible values are: - SCALE_IN - SCALE_OUT.\n", + "type":"string", + "enum":[ + "SCALE_IN", + "SCALE_OUT" + ] + }, + "aspectId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "numberOfSteps":{ + "description":"The number of scaling steps to be performed. Defaults to 1.\n", + "type":"integer", + "default":1 + } + } + }, + "scaleNsToLevelData":{ + "description":"This type represents the information used to scale an NS instance to a target size. The target size is either expressed as an NS instantiation level or as a list of NS scale levels, one per NS scaling aspect, of the current DF. The NS instantiation levels, the NS scaling aspects and their corresponding NS scale levels applicable to the NS instance are declared in the NSD.\n", + "type":"object", + "properties":{ + "nsInstantiationLevel":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "nsScaleInfo":{ + "description":"For each NS scaling aspect of the current DF, defines the target NS scale level to which the NS instance is to be scaled.\n", + "type":"array", + "items":{ + "description":"This type represents the target NS Scale level for each NS scaling aspect of the current deployment flavor.\n", + "type":"object", + "required":[ + "nsScalingAspectId", + "nsScaleLevelId" + ], + "properties":{ + "nsScalingAspectId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "nsScaleLevelId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + }, + "additionalParamsForNs":{ + "description":"This type defines the additional parameters for the VNF instance to be created associated with an NS instance. It shall comply with the provisions defined in Table 6.5.3.22-1.\n", + "type":"object", + "required":[ + "vnfProfileId" + ], + "properties":{ + "vnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "vnfInstanceName":{ + "description":"Human-readable name of the VNF instance to be created.\n", + "type":"string" + }, + "vnfInstanceDescription":{ + "description":"Human-readable description of the VNF instance to be created.\n", + "type":"string" + }, + "vnfConfigurableProperties":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "extensions":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "additionalParams":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + }, + "additionalParamsForVnf":{ + "description":"Allows the OSS/BSS to provide additional parameter(s) per VNF instance (as opposed to the NS level, which is covered in additionalParamforNs). This is for VNFs that are to be created by the NFVO as part of the NS scaling and not for existing VNF that are covered by the scaleVnfData.\n", + "type":"array", + "items":{ + "description":"This type defines the additional parameters for the VNF instance to be created associated with an NS instance. It shall comply with the provisions defined in Table 6.5.3.22-1.\n", + "type":"object", + "required":[ + "vnfProfileId" + ], + "properties":{ + "vnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "vnfInstanceName":{ + "description":"Human-readable name of the VNF instance to be created.\n", + "type":"string" + }, + "vnfInstanceDescription":{ + "description":"Human-readable description of the VNF instance to be created.\n", + "type":"string" + }, + "vnfConfigurableProperties":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "extensions":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "additionalParams":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "locationConstraints":{ + "description":"The location constraints for the VNF to be instantiated as part of the NS scaling. An example can be a constraint for the VNF to be in a specific geographic location.\n", + "type":"array", + "items":{ + "description":"This type represents the association of location constraints to a VNF instance to be created according to a specific VNF profile. It shall comply with the provisions defined in Table 6.5.3.20-1.\n", + "type":"object", + "required":[ + "vnfProfileId" + ], + "properties":{ + "vnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "locationConstraints":{ + "description":"This type represents location constraints for a VNF to be instantiated. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776 [13].\n", + "type":"object", + "required":[ + "countryCode" + ], + "properties":{ + "countryCode":{ + "description":"The two-letter ISO 3166 [29] country code in capital letters.\n", + "type":"string" + }, + "civicAddressElement":{ + "description":"Zero or more elements comprising the civic address.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "caType", + "caValue" + ], + "properties":{ + "caType":{ + "description":"Describe the content type of caValue. The value of caType shall comply with Section 3.4 of IETF RFC 4776 [13].\n", + "type":"integer" + }, + "caValue":{ + "description":"Content of civic address element corresponding to the caType. The format caValue shall comply with Section 3.4 of IETF RFC 4776 [13].\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + }, + "scaleVnfData":{ + "description":"The necessary information to scale the referenced NS instance. It shall be present when scaleType = SCALE_VNF.\n", + "type":"array", + "items":{ + "description":"This type represents defines the information to scale a VNF instance to a given level, or to scale a VNF instance by steps.\n", + "type":"object", + "required":[ + "vnfInstanceid", + "scaleVnfType" + ], + "properties":{ + "vnfInstanceid":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "scaleVnfType":{ + "description":"Type of the scale VNF operation requested. Allowed values are: - SCALE_OUT - SCALE_IN - SCALE_TO_INSTANTIATION_LEVEL - SCALE_TO_SCALE_LEVEL(S) The set of types actually supported depends on the capabilities of the VNF being managed.\n", + "type":"string", + "enum":[ + "SCALE_OUT", + "SCALE_IN", + "SCALE_TO_INSTANTIATION_LEVEL", + "SCALE_TO_SCALE_LEVEL(S)" + ] + }, + "scaleToLevelData":{ + "description":"This type describes the information used to scale a VNF instance to a target size. The target size is either expressed as an instantiation level of that DF as defined in the VNFD, or given as a list of scale levels, one per scaling aspect of that DF. Instantiation levels and scaling aspects are declared in the VNFD. The NFVO shall then invoke the ScaleVnfToLevel operation towards the appropriate VNFM..\n", + "type":"object", + "properties":{ + "vnfInstantiationLevelId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "vnfScaleInfo":{ + "description":"For each scaling aspect of the current deployment flavor, indicates the target scale level to which the VNF is to be scaled.\n", + "type":"array", + "items":{ + "required":[ + "aspectId", + "scaleLevel" + ], + "type":"object", + "properties":{ + "aspectId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "scaleLevel":{ + "description":"Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n", + "type":"integer" + } + } + } + }, + "additionalParams":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + }, + "scaleByStepData":{ + "description":"This type describes the information to scale a VNF instance by steps. The NFVO shall then invoke the Scale VNF operation towards the appropriate VNFM.\n", + "type":"object", + "required":[ + "aspectId" + ], + "properties":{ + "aspectId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "numberOfSteps":{ + "description":"Number of scaling steps. It shall be a positive number. Defaults to 1. The VNF provider defines in the VNFD whether or not a particular VNF supports performing more than one step at a time. Such a property in the VNFD applies for all instances of a particular VNF.\n", + "type":"integer", + "default":1 + }, + "additionalParams":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + } + } + }, + "scaleTime":{ + "description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n", + "format":"date-time", + "type":"string" + } + } + }, + "description":"Parameters for the scale NS operation, as defined in clause 6.5.2.14.\n" + } + ], + "responses":{ + "202":{ + "description":"202 ACCEPTED\n", + "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", + "maximum":1, + "minimum":0 + }, + "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", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "409":{ + "description":"409 CONFLICT\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/ns_instances/{nsInstanceId}/update":{ + "parameters":[ + { + "name":"nsInstanceId", + "description":"Identifier of the NS instance to be updated.\n", + "in":"path", + "type":"string", + "required":true + } + ], + "post":{ + "summary":"Updates a NS instance.", + "description":"The POST method updates an NS instance.\n", + "parameters":[ + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Content-Type", + "description":"The MIME type of the body of the request. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"body", + "in":"body", + "required":true, + "schema":{ + "description":"This operation supports the update of a NS instance, It shall comply with the provisions defined in Table 6.5.2.12-1.\n", + "type":"object", + "required":[ + "updateType" + ], + "properties":{ + "updateType":{ + "description":"The type of update. It determines also which one of the following parameters is present in the operation. Possible values include: * ADD_VNF: Adding existing VNF instance(s) * REMOVE_VNF: Removing VNF instance(s) * INSTANTIATE_VNF: Instantiating new VNF(s) * CHANGE_VNF_DF: Changing VNF DF * OPERATE_VNF: Changing VNF state, * MODIFY_VNF_INFORMATION: Modifying VNF information and/or the configurable properties of VNF instance(s) * CHANGE_EXTERNAL_VNF_CONNECTIVITY: Changing the external connectivity of VNF instance(s) * ADD_SAP: Adding SAP(s) * REMOVE_SAP: Removing SAP(s) * ADD_NESTED_NS: Adding existing NS instance(s) as nested NS(s) * REMOVE_NESTED_NS: Removing existing nested NS instance(s) * ASSOC_NEW_NSD_VERSION: Associating a new NSD version to the NS instance * MOVE_VNF: Moving VNF instance(s) from one origin NS instance to another target NS instance * ADD_VNFFG: Adding VNFFG(s) * REMOVE_VNFFG: Removing VNFFG(s) * UPDATE_VNFFG: Updating VNFFG(s) * CHANGE_NS_DF: Changing NS DF * ADD_PNF: Adding PNF * MODIFY_PNF: Modifying PNF * REMOVE_PNF: Removing PNF\n", + "type":"string", + "enum":[ + "ADD_VNF", + "REMOVE_VNF", + "INSTANTIATE_VNF", + "CHANGE_VNF_DF", + "OPERATE_VNF", + "MODIFY_VNF_INFORMATION", + "CHANGE_EXTERNAL_VNF_CONNECTIVITY", + "ADD SAP", + "REMOVE_SAP", + "ADD_NESTED_NS", + "REMOVE_NESTED_NS", + "ASSOC_NEW_NSD_VERSION", + "MOVE_VNF", + "ADD_VNFFG", + "REMOVE_VNFFG", + "UPDATE_VNFFG", + "CHANGE_NS_DF", + "ADD_PNF", + "MODIFY_PNF", + "REMOVE_PNF" + ] + }, + "addVnfIstance":{ + "description":"Identifies an existing VNF instance to be added to the NS instance. It shall be present only if updateType = \"ADD_VNF\".\n", + "type":"array", + "items":{ + "description":"This type specifies an existing VNF instance to be used in the NS instance and if needed, the VNF Profile to use for this VNF instance. It shall comply with the provisions defined in Table 6.5.3.19-1.\n", + "type":"object", + "required":[ + "vnfInstanceId", + "vnfProfileId" + ], + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "removeVnfInstanceId":{ + "description":"Identifies an existing VNF instance to be removed from the NS instance. It contains the identifier(s) of the VNF instances to be removed. It shall be present only if updateType = \"REMOVE_VNF.\" Note: If a VNF instance is removed from a NS and this NS was the last one for which this VNF instance was a part, the VNF instance is terminated by the NFVO.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "instantiateVnfData":{ + "description":"Identifies the new VNF to be instantiated. It can be used e.g. for the bottom-up NS creation. It shall be present only if updateType = \"INSTANTIATE_VNF\".\n", + "type":"array", + "items":{ + "description":"This type represents the information related to a SAP of a NS. The InstantiateVnfData data type specifies the parameters that are needed for VNF instantiation. This information element is used for the bottom-up NS creation when the OSS/BSS explicitly requests VNF instantiation for a given NS. When the NFVO invokes the Instantiate VNF update operation, a set of these parameters are then passed by the NFVO to the VNFM. It shall comply with the provisions defined in Table 6.5.3.24-1.\n", + "type":"object", + "required":[ + "vnfdId", + "vnfFlavourId" + ], + "properties":{ + "vnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfFlavourId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "vnfInstantiationLevelId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "vnfInstanceName":{ + "description":"Human-readable name of the VNF instance to be created.\n", + "type":"string" + }, + "vnfInstanceDescription":{ + "description":"Human-readable description of the VNF instance to be created.\n", + "type":"string" + }, + "extVirtualLinks":{ + "description":"Information about external VLs to connect the VNF to.\n", + "type":"array", + "items":{ + "description":"This type represents an external VL. It shall comply with the provisions defined in Table 6.5.3.26-1.\n", + "type":"object", + "required":[ + "resourceId", + "extCps" + ], + "properties":{ + "extVirtualLinkId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "extCps":{ + "description":"External CPs of the VNF to be connected to this external VL.\n", + "type":"array", + "items":{ + "description":"This type represents configuration information for external CPs created from a CPD.\n", + "type":"object", + "required":[ + "cpdId" + ], + "properties":{ + "cpdId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "cpConfig":{ + "description":"List of instance data that need to be configured on the CP instances created from the respective CPD.\n", + "type":"array", + "items":{ + "description":"This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n", + "type":"object", + "properties":{ + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "linkPortId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "cpProtocolData":{ + "description":"Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": * The \"linkPortId\" and \"cpProtocolData\" attributes shall both be absent for the deletion of an existing external CP instance\n addressed by cpInstanceId.\n* At least one of these attributes shall be present for a to-be-created external CP instance or an existing external\n CP instance.\n* If the \"linkPortId\" attribute is absent, the VNFM shall create a link port.\n* If the \"cpProtocolData\" attribute is absent, the \"linkPortId\" attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n* If both \"cpProtocolData\" and \"linkportId\" are provided, the API consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n", + "type":"array", + "items":{ + "description":"This type represents network protocol data.\n", + "type":"object", + "required":[ + "layerProtocol" + ], + "properties":{ + "layerProtocol":{ + "description":"Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents network address data for IP over Ethernet.\n", + "type":"object", + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "fixedAddresses":{ + "description":"Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "numDynamicAddresses":{ + "description":"Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"integer" + }, + "addressRange":{ + "description":"An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "extLinkPorts":{ + "description":"Externally provided link ports to be used to connect external connection points to this external VL.\n", + "type":"array", + "items":{ + "description":"This type represents an externally provided link port to be used to connect an external connection point to an external VL.\n", + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + } + } + } + } + } + } + }, + "extManagedVirtualLinks":{ + "description":"Information about internal VLs that are managed by other entities than the VNFM.\n", + "type":"array", + "items":{ + "description":"This type represents an externally-managed internal VL. It shall comply with the provisions defined in Table 6.5.3.27-1.\n", + "type":"object", + "required":[ + "vnfVirtualLinkDescId", + "resourceId" + ], + "properties":{ + "extManagedVirtualLinkId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfVirtualLinkDescId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "localizationLanguage":{ + "description":"Localization language of the VNF to be instantiated. The value shall comply with the format defined in IETF RFC 5646.\n", + "type":"string" + }, + "vnfConfigurableProperties":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "additionalParams":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "extensions":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "locationConstraints":{ + "description":"This type represents the association of location constraints to a VNF instance to be created according to a specific VNF profile. It shall comply with the provisions defined in Table 6.5.3.20-1.\n", + "type":"object", + "required":[ + "vnfProfileId" + ], + "properties":{ + "vnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "locationConstraints":{ + "description":"This type represents location constraints for a VNF to be instantiated. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776 [13].\n", + "type":"object", + "required":[ + "countryCode" + ], + "properties":{ + "countryCode":{ + "description":"The two-letter ISO 3166 [29] country code in capital letters.\n", + "type":"string" + }, + "civicAddressElement":{ + "description":"Zero or more elements comprising the civic address.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "caType", + "caValue" + ], + "properties":{ + "caType":{ + "description":"Describe the content type of caValue. The value of caType shall comply with Section 3.4 of IETF RFC 4776 [13].\n", + "type":"integer" + }, + "caValue":{ + "description":"Content of civic address element corresponding to the caType. The format caValue shall comply with Section 3.4 of IETF RFC 4776 [13].\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + }, + "changeVnfFlavourData":{ + "description":"Identifies the new DF of the VNF instance to be changed to. It shall be present only if updateType = \"CHANGE_VNF_DF\".\n", + "type":"array", + "items":{ + "description":"The type represents the information that is requested to be changed deployment flavor for an existing VNF instance. It shall comply with the provisions defined in Table 6.5.3.25-1.\n", + "type":"object", + "required":[ + "vnfInstanceId", + "newFlavourId" + ], + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "newFlavourId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "instantiationLevelId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "extVirtualLinks":{ + "description":"Information about external VLs to connect the VNF to.\n", + "type":"array", + "items":{ + "description":"This type represents an external VL. It shall comply with the provisions defined in Table 6.5.3.26-1.\n", + "type":"object", + "required":[ + "resourceId", + "extCps" + ], + "properties":{ + "extVirtualLinkId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "extCps":{ + "description":"External CPs of the VNF to be connected to this external VL.\n", + "type":"array", + "items":{ + "description":"This type represents configuration information for external CPs created from a CPD.\n", + "type":"object", + "required":[ + "cpdId" + ], + "properties":{ + "cpdId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "cpConfig":{ + "description":"List of instance data that need to be configured on the CP instances created from the respective CPD.\n", + "type":"array", + "items":{ + "description":"This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n", + "type":"object", + "properties":{ + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "linkPortId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "cpProtocolData":{ + "description":"Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": * The \"linkPortId\" and \"cpProtocolData\" attributes shall both be absent for the deletion of an existing external CP instance\n addressed by cpInstanceId.\n* At least one of these attributes shall be present for a to-be-created external CP instance or an existing external\n CP instance.\n* If the \"linkPortId\" attribute is absent, the VNFM shall create a link port.\n* If the \"cpProtocolData\" attribute is absent, the \"linkPortId\" attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n* If both \"cpProtocolData\" and \"linkportId\" are provided, the API consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n", + "type":"array", + "items":{ + "description":"This type represents network protocol data.\n", + "type":"object", + "required":[ + "layerProtocol" + ], + "properties":{ + "layerProtocol":{ + "description":"Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents network address data for IP over Ethernet.\n", + "type":"object", + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "fixedAddresses":{ + "description":"Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "numDynamicAddresses":{ + "description":"Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"integer" + }, + "addressRange":{ + "description":"An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "extLinkPorts":{ + "description":"Externally provided link ports to be used to connect external connection points to this external VL.\n", + "type":"array", + "items":{ + "description":"This type represents an externally provided link port to be used to connect an external connection point to an external VL.\n", + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + } + } + } + } + } + } + }, + "extManagedVirtualLinks":{ + "description":"information about internal VLs that are managed by NFVO.\n", + "type":"array", + "items":{ + "description":"This type represents an externally-managed internal VL. It shall comply with the provisions defined in Table 6.5.3.27-1.\n", + "type":"object", + "required":[ + "vnfVirtualLinkDescId", + "resourceId" + ], + "properties":{ + "extManagedVirtualLinkId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfVirtualLinkDescId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "additionalParams":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "operateVnfData":{ + "description":"Identifies the state of the VNF instance to be changed. It shall be present only if updateType = \"OPERATE_VNF\".\n", + "type":"array", + "items":{ + "description":"This type represents a VNF instance for which the operational state needs to be changed and the requested new state. It shall comply with the provisions defined in Table 6.5.3.31-1.\n", + "type":"object", + "required":[ + "vnfInstanceId", + "changeStateTo" + ], + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "changeStateTo":{ + "description":"STARTED - The VNF instance is up and running. STOPPED - The VNF instance has been shut down.\n", + "type":"string", + "enum":[ + "STARTED", + "STOPPED" + ] + }, + "stopType":{ + "description":"* FORCEFUL: The VNFM will stop the VNF immediately after accepting the request.\n* GRACEFUL: The VNFM will first arrange to take the VNF out of service after accepting the request. Once that operation is successful or once\n the timer value specified in the \"gracefulStopTimeout\" attribute\n expires, the VNFM will stop the VNF.\n", + "type":"string", + "enum":[ + "FORCEFUL", + "GRACEFUL" + ] + }, + "gracefulStopTimeout":{ + "description":"The time interval (in seconds) to wait for the VNF to be taken out of service during graceful stop, before stopping the VNF.\n", + "type":"integer" + }, + "additionalParam":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "modifyVnfInfoData":{ + "description":"Identifies the VNF information parameters and/or the configurable properties of VNF instance to be modified. It shall be present only if updateType = \"MODIFY_VNF_INFORMATION\".\n", + "type":"array", + "items":{ + "description":"This type represents the information that is requested to be modified for a VNF instance. The information to be modified shall comply with the associated NSD. EXAMPLE. The vnfPkgId attribute value for a particular VNF instance can only be updated with a value that matches the identifier value of a VNF package whose vnfdId is present in the associated profile of the NSD.\n", + "type":"object", + "required":[ + "vnfInstanceId" + ], + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfInstanceName":{ + "description":"New value of the \"vnfInstanceName\" attribute in \"VnfInstance\", or \"null\" to remove the attribute.\n", + "type":"string" + }, + "vnfInstanceDescription":{ + "description":"New value of the \"vnfInstanceDescription\" attribute in \"VnfInstance\", or \"null\" to remove the attribute.\n", + "type":"string" + }, + "vnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfConfigurableProperties":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "extensions":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "changeExtVnfConnectivityData":{ + "description":"Specifies the new external connectivity data of the VNF instance to be changed. It shall be present only if updateType = \"CHANGE_EXTERNAL_VNF_CONNECTIVITY\".\n", + "type":"array", + "items":{ + "description":"This type describes the information invoked by the NFVO to change the external VNF connectivity information maintained by the VNFM. The types of changes that this operation supports are: 1) Disconnect the external CPs that are connected to a particular external VL, and connect them to a different external VL. 2) Change the connectivity parameters of the existing external CPs, including changing addresses. NOTE: Depending on the capabilities of the underlying VIM resources, certain changes (e.g. modifying the IP address assignment) might not be supported without deleting the resource and creating another one with the modified configuration. This type shall comply with the provisions defined in Table 6.5.3.33-1.\n", + "type":"object", + "required":[ + "vnfInstanceId", + "extVirtualLinks" + ], + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "extVirtualLinks":{ + "description":"Information about external VLs to change (e.g. connect the VNF to).\n", + "type":"array", + "items":{ + "description":"This type represents an external VL. It shall comply with the provisions defined in Table 6.5.3.26-1.\n", + "type":"object", + "required":[ + "resourceId", + "extCps" + ], + "properties":{ + "extVirtualLinkId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "extCps":{ + "description":"External CPs of the VNF to be connected to this external VL.\n", + "type":"array", + "items":{ + "description":"This type represents configuration information for external CPs created from a CPD.\n", + "type":"object", + "required":[ + "cpdId" + ], + "properties":{ + "cpdId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "cpConfig":{ + "description":"List of instance data that need to be configured on the CP instances created from the respective CPD.\n", + "type":"array", + "items":{ + "description":"This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n", + "type":"object", + "properties":{ + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "linkPortId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "cpProtocolData":{ + "description":"Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": * The \"linkPortId\" and \"cpProtocolData\" attributes shall both be absent for the deletion of an existing external CP instance\n addressed by cpInstanceId.\n* At least one of these attributes shall be present for a to-be-created external CP instance or an existing external\n CP instance.\n* If the \"linkPortId\" attribute is absent, the VNFM shall create a link port.\n* If the \"cpProtocolData\" attribute is absent, the \"linkPortId\" attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n* If both \"cpProtocolData\" and \"linkportId\" are provided, the API consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n", + "type":"array", + "items":{ + "description":"This type represents network protocol data.\n", + "type":"object", + "required":[ + "layerProtocol" + ], + "properties":{ + "layerProtocol":{ + "description":"Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents network address data for IP over Ethernet.\n", + "type":"object", + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "fixedAddresses":{ + "description":"Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "numDynamicAddresses":{ + "description":"Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"integer" + }, + "addressRange":{ + "description":"An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "extLinkPorts":{ + "description":"Externally provided link ports to be used to connect external connection points to this external VL.\n", + "type":"array", + "items":{ + "description":"This type represents an externally provided link port to be used to connect an external connection point to an external VL.\n", + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + } + } + } + } + } + } + }, + "additionalParams":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "addSap":{ + "description":"Identifies a new SAP to be added to the NS instance. It shall be present only if updateType = \"ADD_SAP.\"\n", + "type":"array", + "items":{ + "description":"This type represents the information related to a SAP of a NS. It shall comply with the provisions defined in Table 6.5.3.10-1.\n", + "type":"object", + "required":[ + "sapdId", + "sapName", + "description" + ], + "properties":{ + "sapdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "sapName":{ + "description":"Human readable name for the SAP.\n", + "type":"string" + }, + "description":{ + "description":"Human readable description for the SAP.\n", + "type":"string" + }, + "sapProtocolData":{ + "description":"Parameters for configuring the network protocols on the SAP.\n", + "type":"array", + "items":{ + "description":"This type represents network protocol data.\n", + "type":"object", + "required":[ + "layerProtocol" + ], + "properties":{ + "layerProtocol":{ + "description":"Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents network address data for IP over Ethernet.\n", + "type":"object", + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "fixedAddresses":{ + "description":"Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "numDynamicAddresses":{ + "description":"Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"integer" + }, + "addressRange":{ + "description":"An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + } + }, + "removeSapId":{ + "description":"The identifier an existing SAP to be removed from the NS instance. It shall be present only if updateType = \"REMOVE_SAP.\"\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "addNestedNsData":{ + "description":"The identifier of an existing nested NS instance to be added to (nested within) the NS instance. It shall be present only if updateType = \"ADD_NESTED_NS\".\n", + "type":"array", + "items":{ + "description":"This type specifies an existing nested NS instance to be used in the NS instance and if needed, the NsProfile to use for this nested NS instance. It shall comply with the provisions defined in Table 6.5.3.19a-1.\n", + "type":"object", + "required":[ + "nestedNsInstanceId" + ], + "properties":{ + "nestedNsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsProfileId":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + } + } + } + }, + "removeNestedNsId":{ + "description":"The identifier of an existing nested NS instance to be removed from the NS instance. It shall be present only if updateType = \"REMOVE_NESTED_NS\".\n", + "type":"array", + "items":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + } + }, + "assocNewNsdVersionData":{ + "description":"This type specifies a new NSD version that is associated to the NS instance. After issuing the Update NS operation with updateType = \"AssocNewNsdVersion\", the NFVO shall use the referred NSD as a basis for the given NS instance. Different versions of the same NSD have same nsdInvariantId, but different nsdId attributes, therefore if the nsdInvariantId of the NSD version that is to be associated to this NS instance is different from the one used before, the NFVO shall reject the request. Only new versions of the same NSD can be associated to an existing NS instance. This data type shall comply with the provisions defined in Table 6.5.3.34-1.\n", + "type":"object", + "required":[ + "newNsdId" + ], + "properties":{ + "newNsdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "sync":{ + "description":"Specify whether the NS instance shall be automatically synchronized to the new NSD by the NFVO (in case of true value) or the NFVO shall not do any action (in case of a false value) and wait for further guidance from OSS/BSS (i.e. waiting for OSS/BSS to issue NS lifecycle management operation to explicitly add/remove VNFs and modify information of VNF instances according to the new NSD). The synchronization to the new NSD means e.g. instantiating/adding those VNFs whose VNFD is referenced by the new NSD version but not referenced by the old one, terminating/removing those VNFs whose VNFD is referenced by the old NSD version but not referenced by the new NSD version, modifying information of VNF instances to the new applicable VNFD provided in the new NSD version. A cardinality of 0 indicates that synchronization shall not be done.\n", + "type":"boolean" + } + } + }, + "moveVnfInstanceData":{ + "description":"Specify existing VNF instance to be moved from one NS instance to another NS instance. It shall be present only if updateType = MOVE_VNF\".\n", + "type":"array", + "items":{ + "description":"This type specifies existing VNF instances to be moved from one NS instance (source) to another NS instance (destination). The NS instance defined in the Update NS operation indicates the source NS instance and the destination NS instance is specified in this data type (referred to targetNsInstanceId). It shall comply with the provisions defined in Table 6.5.3.35-1.\n", + "type":"object", + "required":[ + "targetNsInstanceId" + ], + "properties":{ + "targetNsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfInstanceId":{ + "description":"Specify the VNF instance that is moved.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + } + } + } + }, + "addVnffg":{ + "description":"Specify the new VNFFG to be created to the NS Instance. It shall be present only if updateType = \"ADD_VNFFG\".\n", + "type":"array", + "items":{ + "description":"This type specifies the parameters used for the creation of a new VNFFG instance. It shall comply with the provisions defined in Table 6.5.3.36-1.\n", + "type":"object", + "required":[ + "vnffgdId", + "vnffgName", + "description" + ], + "properties":{ + "targetNsInstanceId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "vnffgName":{ + "description":"Human readable name for the VNFFG.\n", + "type":"string" + }, + "description":{ + "description":"Human readable description for the VNFFG.\n", + "type":"string" + } + } + } + }, + "removeVnffgId":{ + "description":"Identifier of an existing VNFFG to be removed from the NS Instance. It shall be present only if updateType = \"REMOVE_VNFFG\".\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "updateVnffg":{ + "description":"Specify the new VNFFG Information data to be updated for a VNFFG of the NS Instance. It shall be present only if updateType = \"UPDATE_VNFFG\".\n", + "type":"array", + "items":{ + "description":"This type specifies the parameters used for the update of an existing VNFFG instance. It shall comply with the provisions defined in Table 6.5.3.37-1.\n", + "type":"object", + "required":[ + "vnffgInfoId" + ], + "properties":{ + "vnffgInfoId":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + }, + "nfp":{ + "description":"Indicate the desired new NFP(s) for a given VNFFG after the operations of addition/removal of NS components (e.g. VNFs, VLs, etc.) have been completed, or indicate the updated or newly created NFP classification and selection rule which applied to an existing NFP.\n", + "type":"array", + "items":{ + "description":"This type contains information used to create or modify NFP instance parameters for the update of an existing VNFFG instance. It shall comply with the provisions defined in Table 6.5.3.38-1.\n", + "type":"object", + "properties":{ + "nfpInfoId":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + }, + "nfpName":{ + "description":"Human readable name for the NFP. It shall be present for the new NFP, and it may be present otherwise. It shall be present for the new NFP, and it may be present otherwise.\n", + "type":"string" + }, + "description":{ + "description":"Human readable description for the NFP. It shall be present for the new NFP, and it may be present otherwise. It shall be present for the new NFP, and it may be present otherwise.\n", + "type":"string" + }, + "cpGroup":{ + "description":"Group(s) of CPs and/or SAPs which the NFP passes by. Cardinality can be 0 if only updated or newly created NFP classification and selection rule which applied to an existing NFP is provided. At least a CP or an nfpRule shall be present. When multiple identifiers are included, the position of the identifier in the cpGroup value specifies the position of the group in the path.\n", + "type":"array", + "items":{ + "description":"This type represents describes a group of CPs and/or SAPs pairs associated to the same position in an NFP. It shall comply with the provisions defined in Table 6.5.3.71-1.\n", + "type":"object", + "properties":{ + "cpPairInfo":{ + "description":"One or more pair(s) of ingress and egress CPs or SAPs which the NFP passes by. All CP or SAP pairs in a group shall be instantiated from connection point descriptors or service access point descriptors referenced in the corresponding NfpPositionDesc.\n", + "type":"array", + "minItems":1, + "items":{ + "description":"This type represents describes a pair of ingress and egress CPs or SAPs which the NFP passes by. It shall comply with the provisions defined in Table 6.5.3.72-1.\n", + "type":"object", + "properties":{ + "vnfExtCpIds":{ + "description":"Identifier(s) of the VNF CP(s) which form the pair. The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates that the CP or SAP is used both as an ingress and egress port at a particular NFP position.\n", + "type":"array", + "maxItems":2, + "items":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + } + }, + "pnfExtCpIds":{ + "description":"Identifier(s) of the PNF CP(s) which form the pair. The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates that the CP or SAP is used both as an ingress and egress port at a particular NFP position.\n", + "type":"array", + "maxItems":2, + "items":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + } + }, + "sapIds":{ + "description":"Identifier(s) of the SAP(s) which form the pair. The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates that the CP or SAP is used both as an ingress and egress port at a particular NFP position.\n", + "type":"array", + "maxItems":2, + "items":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + }, + "forwardingBehaviour":{ + "description":"Identifies a rule to apply to forward traffic to the ingress CPs or SAPs of the group. Permitted values: * ALL = Traffic flows shall be forwarded simultaneously to all CPs or SAPs of the group. * LB = Traffic flows shall be forwarded to one CP or SAP of the group selected based on a loadbalancing algorithm.\n", + "type":"string", + "enum":[ + "ALL", + "LB" + ] + }, + "forwardingBehaviourInputParameters":{ + "description":"This type represents provides input parameters to configure the forwarding behaviour. It shall comply with the provisions defined in Table 6.5.3.73-1.\n", + "type":"object", + "properties":{ + "algortihmName":{ + "description":"May be included if forwarding behaviour is equal to LB. Shall not be included otherwise. Permitted values: * ROUND_ROBIN * LEAST_CONNECTION * LEAST_TRAFFIC * LEAST_RESPONSE_TIME * CHAINED_FAILOVER * SOURCE_IP_HASH * SOURCE_MAC_HASH\n", + "type":"string", + "enum":[ + "ROUND_ROBIN", + "LEAST_CONNECTION", + "LEAST_TRAFFIC", + "LEAST_RESPONSE_TIME", + "CHAINED_FAILOVER", + "SOURCE_IP_HASH", + "SOURCE_MAC_HASH" + ] + }, + "algorithmWeights":{ + "description":"Percentage of messages sent to a CP instance. May be included if applicable to the algorithm. If applicable to the algorithm but not provided, default values determined by the VIM or NFVI are expected to be used. Weight applies to the CP instances in the order they have been created.\n", + "type":"array", + "items":{ + "type":"integer" + } + } + } + } + } + } + }, + "nfpRule":{ + "description":"The NfpRule data type is an expression of the conditions that shall be met in order for the NFP to be applicable to the packet. The condition acts as a flow classifier and it is met only if all the values expressed in the condition are matched by those in the packet. It shall comply with the provisions defined in Table 6.5.3.40-1.\n", + "type":"object", + "properties":{ + "etherDestinationAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "etherSourceAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "etherType":{ + "description":"Human readable description for the VNFFG.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "vlanTag":{ + "description":"Indicates a VLAN identifier in an IEEE 802.1Q-2018 tag [6] Multiple tags can be included for QinQ stacking. See note.\n", + "type":"array", + "items":{ + "description":"A string as defined in IETF RFC 8259.\n", + "type":"string" + } + }, + "protocol":{ + "description":"Indicates the L4 protocol, For IPv4 [7] this corresponds to the field called \"Protocol\" to identify the next level protocol. For IPv6 [28] this corresponds to the field is called the \"Next Header\" field. Permitted values: Any keyword defined in the IANA protocol registry [1], e.g.: TCP UDP ICMP\n", + "type":"string", + "enum":[ + "TCP", + "UDP", + "ICMP" + ] + }, + "dscp":{ + "description":"For IPv4 [7] a string of \"0\" and \"1\" digits that corresponds to the 6-bit Differentiated Services Code Point (DSCP) field of the IP header. For IPv6 [28] a string of \"0\" and \"1\" digits that corresponds to the 6 differentiated services bits of the traffic class header field\n", + "type":"string" + }, + "sourcePortRange":{ + "description":"The PortRange data type provides the lower and upper bounds of a range of Internet ports. It shall comply with the provisions defined in Table 6.5.3.42-1.\n", + "type":"object", + "required":[ + "lowerPort", + "upperPort" + ], + "properties":{ + "lowerPort":{ + "description":"Identifies the lower bound of the port range. upperPort Integer\n", + "type":"integer", + "minimum":0 + }, + "upperPort":{ + "description":"Identifies the upper bound of the port range.\n", + "type":"integer", + "minimum":0 + } + } + }, + "destinationPortRange":{ + "description":"The PortRange data type provides the lower and upper bounds of a range of Internet ports. It shall comply with the provisions defined in Table 6.5.3.42-1.\n", + "type":"object", + "required":[ + "lowerPort", + "upperPort" + ], + "properties":{ + "lowerPort":{ + "description":"Identifies the lower bound of the port range. upperPort Integer\n", + "type":"integer", + "minimum":0 + }, + "upperPort":{ + "description":"Identifies the upper bound of the port range.\n", + "type":"integer", + "minimum":0 + } + } + }, + "sourceIpAddressPrefix":{ + "description":"An IPV4 or IPV6 address range in CIDR format. For IPV4 address range, refer to IETF RFC 4632 [12]. For IPV6 address range, refer to IETF RFC 4291.\n", + "type":"string" + }, + "destinationIpAddressPrefix":{ + "description":"An IPV4 or IPV6 address range in CIDR format. For IPV4 address range, refer to IETF RFC 4632 [12]. For IPV6 address range, refer to IETF RFC 4291.\n", + "type":"string" + }, + "extendedCriteria":{ + "description":"Indicates values of specific bits in a frame.\n", + "type":"array", + "items":{ + "description":"The Mask data type identifies the value to be matched for a sequence of bits at a particular location in a frame. It shall comply with the provisions defined in Table 6.5.3.41-1.\n", + "type":"object", + "required":[ + "startingPoint", + "length", + "value" + ], + "properties":{ + "startingPoint":{ + "description":"Indicates the offset between the last bit of the source mac address and the first bit of the sequence of bits to be matched.\n", + "type":"integer" + }, + "length":{ + "description":"Indicates the number of bits to be matched.\n", + "type":"integer" + }, + "value":{ + "description":"Provide the sequence of bit values to be matched.\n", + "type":"string" + } + } + } + } + } + } + } + } + }, + "nfpInfoId":{ + "description":"Identifier(s) of the NFP to be deleted from a given VNFFG.\n", + "type":"array", + "items":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + }, + "changeNsFlavourData":{ + "description":"This type specifies an existing NS instance for which the DF needs to be changed. This specifies the new DF, the instantiationLevel of the new DF that may be used and the additional parameters as input for the flavour change. It shall comply with the provisions defined in Table 6.5.3.39-1.\n", + "type":"object", + "required":[ + "newNsFlavourId" + ], + "properties":{ + "newNsFlavourId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "instantiationLevelId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + } + } + }, + "addPnfData":{ + "description":"specifies the PNF to be added into the NS instance. It shall be present only if updateType = \"ADD_PNF\".\n", + "type":"array", + "items":{ + "description":"This type specifies an PNF to be added to the NS instance and the PNF Profile to use for this PNF. It shall comply with the provisions defined in Table 6.5.3.14-1.\n", + "type":"object", + "required":[ + "pnfId", + "pnfName", + "pnfdId", + "pnfProfileId" + ], + "properties":{ + "pnfId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfName":{ + "description":"Name of the PNF\n", + "type":"string" + }, + "pnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "cpData":{ + "description":"Address assigned for the PNF external CP(s).\n", + "type":"array", + "items":{ + "description":"This type represents the configuration data on the external CP of the PNF. It shall comply with the provisions defined in Table 6.5.3.16-1.\n", + "type":"object", + "required":[ + "cpProtocolData" + ], + "properties":{ + "cpInstanceId":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + }, + "cpdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "cpProtocolData":{ + "description":"Address assigned for this CP.\n", + "type":"array", + "items":{ + "description":"This type represents network protocol data.\n", + "type":"object", + "required":[ + "layerProtocol" + ], + "properties":{ + "layerProtocol":{ + "description":"Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents network address data for IP over Ethernet.\n", + "type":"object", + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "fixedAddresses":{ + "description":"Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "numDynamicAddresses":{ + "description":"Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"integer" + }, + "addressRange":{ + "description":"An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "modifyPnfData":{ + "description":"Specifies the PNF to be modified in the NS instance. It shall be present only if updateType = \"MODIFY_PNF\".\n", + "type":"array", + "items":{ + "description":"This type specifies an PNF to be modified in the NS instance. It shall comply with the provisions defined in Table 6.5.3.15-1.\n", + "type":"object", + "required":[ + "pnfId" + ], + "properties":{ + "pnfId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfName":{ + "description":"Name of the PNF.\n", + "type":"string" + }, + "cpData":{ + "description":"Address assigned for the PNF external CP(s).\n", + "type":"array", + "items":{ + "description":"This type represents the configuration data on the external CP of the PNF. It shall comply with the provisions defined in Table 6.5.3.16-1.\n", + "type":"object", + "required":[ + "cpProtocolData" + ], + "properties":{ + "cpInstanceId":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + }, + "cpdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "cpProtocolData":{ + "description":"Address assigned for this CP.\n", + "type":"array", + "items":{ + "description":"This type represents network protocol data.\n", + "type":"object", + "required":[ + "layerProtocol" + ], + "properties":{ + "layerProtocol":{ + "description":"Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET.\n", + "type":"string", + "enum":[ + "IP_OVER_ETHERNET" + ] + }, + "ipOverEthernet":{ + "description":"This type represents network address data for IP over Ethernet.\n", + "type":"object", + "properties":{ + "macAddress":{ + "description":"A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n", + "type":"string", + "format":"MAC" + }, + "ipAddresses":{ + "description":"List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n", + "type":"array", + "items":{ + "type":"object", + "required":[ + "type" + ], + "properties":{ + "type":{ + "description":"The type of the IP addresses. Permitted values: IPV4, IPV6.\n", + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "fixedAddresses":{ + "description":"Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"array", + "items":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + }, + "numDynamicAddresses":{ + "description":"Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n", + "type":"integer" + }, + "addressRange":{ + "description":"An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n", + "type":"object", + "required":[ + "minAddress", + "maxAddress" + ], + "properties":{ + "minAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + }, + "maxAddress":{ + "description":"An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type":"string", + "format":"IP" + } + } + }, + "subnetId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "removePnfId":{ + "description":"Identifier of the PNF to be deleted from the NS instance. It shall be present only if updateType = \"REMOVE_PNF\".\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "updateTime":{ + "description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n", + "format":"date-time", + "type":"string" + } + } + }, + "description":"Parameters for the update NS operation, as defined in clause 6.5.2.12.\n" + } + ], + "responses":{ + "202":{ + "description":"202 ACCEPTED\n", + "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", + "maximum":1, + "minimum":0 + }, + "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", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "409":{ + "description":"409 CONFLICT\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/ns_instances/{nsInstanceId}/heal":{ + "parameters":[ + { + "name":"nsInstanceId", + "description":"Identifier of the NS instance to be healed.\n", + "in":"path", + "type":"string", + "required":true + } + ], + "post":{ + "summary":"Heal a NS instance.", + "description":"The POST method requests to heal an NS instance. This method shall follow the provisions specified in the Tables 6.4.7.3.1-1 and 6.4.7.3.1-2 for URI query parameters, request and response data structures, and response codes. The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2.\n", + "parameters":[ + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Content-Type", + "description":"The MIME type of the body of the request. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"body", + "in":"body", + "required":true, + "schema":{ + "description":"This type represents request parameters for the \"Heal NS\" operation. This operation supports the healing of an NS instance, either by healing the complete NS instance or by healing one of more of the VNF instances that are part of this NS. It shall comply with the provisions defined in Table 6.5.2.13-1. Either the parameter healNsData or the parameter healVnfData, but not both shall be provided.\n", + "type":"object", + "properties":{ + "healNsData":{ + "description":"This type represents the information used to heal a NS. It shall comply with the provisions defined in Table 6.5.3.43-1.\n", + "type":"object", + "required":[ + "degreeHealing" + ], + "properties":{ + "degreeHealing":{ + "description":"Indicates the degree of healing. Possible values include: - HEAL_RESTORE: Complete the healing of the NS restoring the state of the NS before the failure occurred - HEAL_QOS: Complete the healing of the NS based on the newest QoS values - HEAL_RESET: Complete the healing of the NS resetting to the original instantiation state of the NS - PARTIAL_HEALING\n", + "type":"string", + "enum":[ + "HEAL_RESTORE", + "HEAL_QOS", + "HEAL_RESET", + "PARTIAL_HEALING" + ] + }, + "actionsHealing":{ + "description":"Used to specify dedicated healing actions in a particular order (e.g. as a script). The actionsHealing attribute can be used to provide a specific script whose content and actions might only be possible to be derived during runtime.\n", + "type":"array", + "items":{ + "description":"A string as defined in IETF RFC 8259.\n", + "type":"string" + } + }, + "healScript":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "additionalParamsforNs":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + }, + "healVnfData":{ + "description":"Provides the information needed to heal a VNF. See note.\n", + "type":"array", + "items":{ + "description":"This type represents the information to heal a VNF that is part of an NS. The NFVO shall then invoke the HealVNF operation towards the appropriate VNFM. It shall comply with the provisions defined in Table 6.5.3.44-1.\n", + "type":"object", + "required":[ + "vnfInstanceId" + ], + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "cause":{ + "description":"Indicates the reason why a healing procedure is required.\n", + "type":"string" + }, + "additionalParams":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + } + } + }, + "description":"Parameters for the heal NS operation, as defined in clause 6.5.2.13.\n" + } + ], + "responses":{ + "202":{ + "description":"202 ACCEPTED\n", + "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", + "maximum":1, + "minimum":0 + }, + "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", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "409":{ + "description":"409 CONFLICT\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/ns_instances/{nsInstanceId}/terminate":{ + "parameters":[ + { + "name":"nsInstanceId", + "description":"The identifier of the NS instance to be terminated.\n", + "in":"path", + "type":"string", + "required":true + } + ], + "post":{ + "summary":"Terminate a NS instance.", + "description":"Terminate NS task. The POST method terminates an NS instance. This method shall follow the provisions specified in the Tables 6.4.8.3.1-1 and 6.4.8.3.1-2 for URI query parameters, request and response data structures, and response codes. The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2. In addition, once the NFVO has successfully completed the underlying NS LCM operation occurrence, it shall set the \"nsState\" attribute in the representation of the \"Individual NS instance\" resource to the value \"NOT_INSTANTIATED\". This method can only be used with an NS instance in the INSTANTIATED state. Terminating an NS instance does not delete the NS instance identifier, but rather transitions the NS into the NOT_INSTANTIATED state.\n", + "parameters":[ + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Content-Type", + "description":"The MIME type of the body of the request. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"TerminateNsRequest", + "in":"body", + "required":true, + "schema":{ + "description":"This type represents a NS termination request. It shall comply with the provisions defined in Table 6.5.2.15-1.\n", + "type":"object", + "properties":{ + "terminationTime":{ + "description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n", + "format":"date-time", + "type":"string" + } + } + }, + "description":"The terminate NS request parameters, as defined in clause 6.5.2.15.\n" + } + ], + "responses":{ + "202":{ + "description":"202 ACCEPTED\n", + "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", + "maximum":1, + "minimum":0 + }, + "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", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "409":{ + "description":"409 CONFLICT\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/ns_lcm_op_occs":{ + "get":{ + "summary":"Query multiple NS LCM operation occurrences.", + "description":"Get Operation Status. Shall be returned upon the following 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 NS instance resource is in NOT_INSTANTIATED state, or that another lifecycle management operation is ongoing. The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute shall convey more information about the error\n", + "parameters":[ + { + "name":"filter", + "in":"query", + "required":false, + "type":"string", + "description":"Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013[16]. The NFVO shall support receiving this parameter as part of the URI query string. The OSS/BSS may supply this parameter. All attribute names that appear in the NsLcmOpOcc and in data types referenced from it shall be supported by the NFVO in the filter expression.\n" + }, + { + "name":"fields", + "in":"query", + "required":false, + "type":"string", + "description":"Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV SOL 013 for details. The NFVO should support this parameter.\n" + }, + { + "name":"exclude_fields", + "in":"query", + "required":false, + "type":"string", + "description":"Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV SOL 013 for details. The NFVO should support this parameter.\n" + }, + { + "name":"exclude_default", + "in":"query", + "required":false, + "type":"string", + "description":"Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV SOL 013 for details. The NFVO shall support this parameter. The following attributes shall be excluded from the NsLcmOpOcc structure in the response body if this parameter is provided: - operationParams - changedVnfInfo - error - resourceChanges\n" + }, + { + "name":"nextpage_opaque_marker", + "in":"query", + "description":"Marker to obtain the next page of a paged response. Shall be supported by the NFVO if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013 for this resource.\n", + "required":false, + "type":"string" + }, + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + } + ], + "responses":{ + "200":{ + "description":"200 OK\nShall be returned when status information for zero or more NS lifecycle management operation occurrences has been queried successfully. The response body shall contain in an array the status information about zero or more NS lifecycle operation occurrences, as defined in clause 6.5.2.3. If the \"filter\" URI parameter or one of the \"all_fields\", \"fields\", \"exclude_fields\" or \"exclude_default\" URI parameters was supplied in the request and is supported, the data in the response body shall have been transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013 [16], respectively. If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 [16] for this resource, inclusion 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].\n", + "headers":{ + "Content-Type":{ + "description":"The MIME type of the body of the response.", + "type":"string", + "maximum":1, + "minimum":1 + }, + "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.\n", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + }, + "Link":{ + "description":"Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.\n", + "type":"string", + "maximum":1, + "minimum":0 + } + }, + "schema":{ + "type":"array", + "items":{ + "properties":{ + "NsLcmOpOcc":{ + "description":"This type represents a request a NS lifecycle operation occurrence. It shall comply with the provisions defined in Table 6.5.2.3-1.\n", + "type":"object", + "required":[ + "id", + "operationState", + "statusEnteredTime", + "nsInstanceId", + "lcmOperationType", + "startTime", + "isAutomaticInvocation", + "isCancelPending", + "_links" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "operationState":{ + "description":"The enumeration NsLcmOperationStateType shall comply with the provisions defined in Table 6.5.4.4-1. Value | Description ------|------------ PROCESSING | The LCM operation is currently in execution. COMPLETED | The LCM operation has been completed successfully. PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. OLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n", + "type":"string", + "enum":[ + "PROCESSING", + "COMPLETED", + "FAILED_TEMP", + "FAILED", + "ROLLING_BACK", + "ROLLED_BACK" + ] + }, + "statusEnteredTime":{ + "description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n", + "format":"date-time", + "type":"string" + }, + "nsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "lcmOperationType":{ + "description":"The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation occurrence notification. Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate NS\" LCM operation. SCALE | Represents the \"Scale NS\" LCM operation. UPDATE | Represents the \"Update NS\" LCM operation. TERMINATE | Represents the \"Terminate NS\" LCM operation. HEAL | Represents the \"Heal NS\" LCM operation.\n", + "type":"string", + "enum":[ + "INSTANTIATE", + "SCALE", + "UPDATE", + "TERMINATE", + "HEAL" + ] + }, + "startTime":{ + "description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n", + "format":"date-time", + "type":"string" + }, + "isAutomaticInvocation":{ + "description":"Set to true if this NS LCM operation occurrence has been automatically triggered by the NFVO. This occurs in the case of auto-scaling, auto-healing and when a nested NS is modified as a result of an operation on its composite NS. Set to false otherwise.\n", + "type":"boolean" + }, + "operationParams":{ + "description":"Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation. The following mapping between lcmOperationType and the data type of this attribute shall apply: - INSTANTIATE: InstantiateNsRequest - SCALE: ScaleNsRequest - UPDATE: UpdateNsRequest - HEAL: HealNsRequest - TERMINATE: TerminateNsRequest This attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n", + "type":"object" + }, + "isCancelPending":{ + "description":"If the LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state and the operation is being cancelled, this attribute shall be set to true. Otherwise, it shall be set to false.\n", + "type":"boolean" + }, + "cancelMode":{ + "description":"Cancellation mode.\nThe NFVO shall not start any new VNF lifecycle management and resource management operation, and shall wait for the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, to finish execution or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state.\nThe NFVO shall not start any new VNF lifecycle management and resource management operation, shall cancel the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state.\n", + "type":"string", + "enum":[ + "GRACEFUL", + "FORCEFUL" + ] + }, + "error":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + }, + "resourceChanges":{ + "description":"This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the LCM operation since its start, if applicable\n", + "type":"object", + "properties":{ + "affectedVnfs":{ + "description":"Information about the VNF instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified VNFs. It shall comply with the provisions in Table 6.5.3.2-1.\n", + "type":"object", + "required":[ + "vnfInstanceId", + "vnfdId", + "vnfProfileId", + "vnfName", + "changeType", + "changeResult" + ], + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "vnfName":{ + "description":"Name of the VNF Instance.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of change Permitted values: - ADD - REMOVE - INSTANTIATE - TERMINATE - SCALE - CHANGE_FLAVOUR - HEAL - OPERATE - MODIFY_INFORMATION - CHANGE_EXTERNAL_VNF_CONNECTIVITY\n", + "type":"string", + "enum":[ + "ADD", + "REMOVE", + "INSTANTIATE", + "TERMINATE", + "SCALE", + "CHANGE_FLAVOUR", + "HEAL", + "OPERATE", + "MODIFY_INFORMATION", + "CHANGE_EXTERNAL_VNF_CONNECTIVITY" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED" + ] + }, + "changedInfo":{ + "description":"Information about the changed VNF instance information, including VNF configurable properties,if applicable. When the \"changedInfo\" attribute is present, either the \"changedVnfInfo\" attribute or the \"changedExtConnectivity\" attribute or both shall be present.\n", + "type":"object", + "required":[ + "self" + ], + "properties":{ + "changedVnfInfo":{ + "description":"This type represents the information that is requested to be modified for a VNF instance. The information to be modified shall comply with the associated NSD. EXAMPLE. The vnfPkgId attribute value for a particular VNF instance can only be updated with a value that matches the identifier value of a VNF package whose vnfdId is present in the associated profile of the NSD.\n", + "type":"object", + "required":[ + "vnfInstanceId" + ], + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfInstanceName":{ + "description":"New value of the \"vnfInstanceName\" attribute in \"VnfInstance\", or \"null\" to remove the attribute.\n", + "type":"string" + }, + "vnfInstanceDescription":{ + "description":"New value of the \"vnfInstanceDescription\" attribute in \"VnfInstance\", or \"null\" to remove the attribute.\n", + "type":"string" + }, + "vnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfConfigurableProperties":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "extensions":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + }, + "changedExtConnectivity":{ + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "extLinkPorts":{ + "description":"Link ports of this VL.\n", + "type":"array", + "items":{ + "description":"This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n", + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + }, + "affectedPnfs":{ + "description":"Information about the PNF instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified PNFs. It shall comply with the provisions in Table 6.5.3.3-1.\n", + "type":"object", + "required":[ + "pnfId", + "pnfdId", + "pnfProfileId", + "cpInstanceId" + ], + "properties":{ + "pnfId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "pnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "pnfName":{ + "description":"Name of the PNF.\n", + "type":"string" + }, + "cpInstanceId":{ + "description":"Identifier of the CP in the scope of the PNF.\n", + "type":"array", + "items":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + } + }, + "changeType":{ + "description":"Signals the type of change. Permitted values: - ADD - REMOVE - MODIFY\n", + "type":"string", + "enum":[ + "ADD", + "REMOVE", + "MODIFY" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED" + ] + } + } + } + }, + "affectedVls":{ + "description":"Information about the VL instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted, modified and temporary VLs.\n", + "type":"object", + "required":[ + "id", + "virtualLinkDescId", + "changeType", + "networkResource" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "virtualLinkDescId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY * LINK_PORT_ADDED * LINK_PORT_REMOVED For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists.\n", + "type":"string", + "enum":[ + "ADDED", + "REMOVED", + "MODIFIED", + "TEMPORARY", + "LINK_PORT_ADDED", + "LINK_PORT_REMOVED" + ] + }, + "networkResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "affectedVnffgs":{ + "description":"Information about the VNFFG instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified VNFFG instances. It shall comply with the provisions in Table 6.5.3.5-1.\n", + "type":"object", + "required":[ + "vnffgInstanceId", + "vnffgdId" + ], + "properties":{ + "vnffgInstanceId":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + }, + "vnffgdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of change. Permitted values: - ADD - DELETE - MODIFY\n", + "type":"string", + "enum":[ + "ADD", + "DELETE", + "MODIFY" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED" + ] + } + } + } + }, + "affectedNss":{ + "description":"Information about the nested NS instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified nested NSs. It shall comply with the provisions in Table 6.5.3.6-1.\n", + "type":"object", + "required":[ + "nsInstanceId", + "nsdId", + "changeType", + "changeResult" + ], + "properties":{ + "nsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of lifecycle change. Permitted values: - ADD - REMOVE - INSTANTIATE - SCALE - UPDATE - HEAL - TERMINATE\n", + "type":"string", + "enum":[ + "ADD", + "REMOVE", + "INSTANTIATE", + "SCALE", + "UPDATE", + "HEAL", + "TERMINATE" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED - PARTIALLY_COMPLETED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED", + "PARTIALLY_COMPLETED" + ] + } + } + } + }, + "affectedSaps":{ + "description":"Information about the nested NS instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified SAP of a NS. It shall comply with the provisions in Table 6.5.3.7-1.\n", + "type":"object", + "required":[ + "sapInstanceId", + "sapdId" + ], + "properties":{ + "sapInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "sapdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "sapName":{ + "description":"Human readable name for the SAP.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of lifecycle change. Permitted values: - ADD - REMOVE - MODIFY\n", + "type":"string", + "enum":[ + "ADD", + "REMOVE", + "MODIFY" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED" + ] + } + } + } + } + } + }, + "_links":{ + "description":"Links to resources related to this resource.\n", + "type":"object", + "required":[ + "self", + "nsInstance" + ], + "properties":{ + "self":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "nsInstance":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "cancel":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "retry":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "rollback":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "continue":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "fail":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + } + } + } + } + } + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/ns_lcm_op_occs/{nsLcmOpOccId}":{ + "parameters":[ + { + "name":"nsLcmOpOccId", + "description":"Identifier of a NS lifecycle management operation occurrence.\n", + "in":"path", + "type":"string", + "required":true + } + ], + "get":{ + "summary":"Read an individual NS LCM operation occurrence resource.", + "description":"The API consumer can use this method to retrieve status information about a NS lifecycle management operation occurrence by reading an individual \"NS LCM operation occurrence\" resource. This method shall follow the provisions specified in the Tables 6.4.10.3.2-1 and 6.4.10.3.2-2 for URI query parameters, request and response data structures, and response codes.\n", + "parameters":[ + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Content-Type", + "description":"The MIME type of the body of the request. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + } + ], + "responses":{ + "200":{ + "description":"200 OK\nShall be returned when information about an NS LCM operation occurrence has been read successfully. The response body shall contain status information about an NS lifecycle management operation occurrence (see clause 6.5.2.3).\n", + "schema":{ + "description":"This type represents a request a NS lifecycle operation occurrence. It shall comply with the provisions defined in Table 6.5.2.3-1.\n", + "type":"object", + "required":[ + "id", + "operationState", + "statusEnteredTime", + "nsInstanceId", + "lcmOperationType", + "startTime", + "isAutomaticInvocation", + "isCancelPending", + "_links" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "operationState":{ + "description":"The enumeration NsLcmOperationStateType shall comply with the provisions defined in Table 6.5.4.4-1. Value | Description ------|------------ PROCESSING | The LCM operation is currently in execution. COMPLETED | The LCM operation has been completed successfully. PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. OLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n", + "type":"string", + "enum":[ + "PROCESSING", + "COMPLETED", + "FAILED_TEMP", + "FAILED", + "ROLLING_BACK", + "ROLLED_BACK" + ] + }, + "statusEnteredTime":{ + "description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n", + "format":"date-time", + "type":"string" + }, + "nsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "lcmOperationType":{ + "description":"The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation occurrence notification. Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate NS\" LCM operation. SCALE | Represents the \"Scale NS\" LCM operation. UPDATE | Represents the \"Update NS\" LCM operation. TERMINATE | Represents the \"Terminate NS\" LCM operation. HEAL | Represents the \"Heal NS\" LCM operation.\n", + "type":"string", + "enum":[ + "INSTANTIATE", + "SCALE", + "UPDATE", + "TERMINATE", + "HEAL" + ] + }, + "startTime":{ + "description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n", + "format":"date-time", + "type":"string" + }, + "isAutomaticInvocation":{ + "description":"Set to true if this NS LCM operation occurrence has been automatically triggered by the NFVO. This occurs in the case of auto-scaling, auto-healing and when a nested NS is modified as a result of an operation on its composite NS. Set to false otherwise.\n", + "type":"boolean" + }, + "operationParams":{ + "description":"Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation. The following mapping between lcmOperationType and the data type of this attribute shall apply: - INSTANTIATE: InstantiateNsRequest - SCALE: ScaleNsRequest - UPDATE: UpdateNsRequest - HEAL: HealNsRequest - TERMINATE: TerminateNsRequest This attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n", + "type":"object" + }, + "isCancelPending":{ + "description":"If the LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state and the operation is being cancelled, this attribute shall be set to true. Otherwise, it shall be set to false.\n", + "type":"boolean" + }, + "cancelMode":{ + "description":"Cancellation mode.\nThe NFVO shall not start any new VNF lifecycle management and resource management operation, and shall wait for the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, to finish execution or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state.\nThe NFVO shall not start any new VNF lifecycle management and resource management operation, shall cancel the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state.\n", + "type":"string", + "enum":[ + "GRACEFUL", + "FORCEFUL" + ] + }, + "error":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + }, + "resourceChanges":{ + "description":"This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the LCM operation since its start, if applicable\n", + "type":"object", + "properties":{ + "affectedVnfs":{ + "description":"Information about the VNF instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified VNFs. It shall comply with the provisions in Table 6.5.3.2-1.\n", + "type":"object", + "required":[ + "vnfInstanceId", + "vnfdId", + "vnfProfileId", + "vnfName", + "changeType", + "changeResult" + ], + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "vnfName":{ + "description":"Name of the VNF Instance.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of change Permitted values: - ADD - REMOVE - INSTANTIATE - TERMINATE - SCALE - CHANGE_FLAVOUR - HEAL - OPERATE - MODIFY_INFORMATION - CHANGE_EXTERNAL_VNF_CONNECTIVITY\n", + "type":"string", + "enum":[ + "ADD", + "REMOVE", + "INSTANTIATE", + "TERMINATE", + "SCALE", + "CHANGE_FLAVOUR", + "HEAL", + "OPERATE", + "MODIFY_INFORMATION", + "CHANGE_EXTERNAL_VNF_CONNECTIVITY" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED" + ] + }, + "changedInfo":{ + "description":"Information about the changed VNF instance information, including VNF configurable properties,if applicable. When the \"changedInfo\" attribute is present, either the \"changedVnfInfo\" attribute or the \"changedExtConnectivity\" attribute or both shall be present.\n", + "type":"object", + "required":[ + "self" + ], + "properties":{ + "changedVnfInfo":{ + "description":"This type represents the information that is requested to be modified for a VNF instance. The information to be modified shall comply with the associated NSD. EXAMPLE. The vnfPkgId attribute value for a particular VNF instance can only be updated with a value that matches the identifier value of a VNF package whose vnfdId is present in the associated profile of the NSD.\n", + "type":"object", + "required":[ + "vnfInstanceId" + ], + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfInstanceName":{ + "description":"New value of the \"vnfInstanceName\" attribute in \"VnfInstance\", or \"null\" to remove the attribute.\n", + "type":"string" + }, + "vnfInstanceDescription":{ + "description":"New value of the \"vnfInstanceDescription\" attribute in \"VnfInstance\", or \"null\" to remove the attribute.\n", + "type":"string" + }, + "vnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfConfigurableProperties":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "extensions":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + }, + "changedExtConnectivity":{ + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "extLinkPorts":{ + "description":"Link ports of this VL.\n", + "type":"array", + "items":{ + "description":"This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n", + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + }, + "affectedPnfs":{ + "description":"Information about the PNF instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified PNFs. It shall comply with the provisions in Table 6.5.3.3-1.\n", + "type":"object", + "required":[ + "pnfId", + "pnfdId", + "pnfProfileId", + "cpInstanceId" + ], + "properties":{ + "pnfId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "pnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "pnfName":{ + "description":"Name of the PNF.\n", + "type":"string" + }, + "cpInstanceId":{ + "description":"Identifier of the CP in the scope of the PNF.\n", + "type":"array", + "items":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + } + }, + "changeType":{ + "description":"Signals the type of change. Permitted values: - ADD - REMOVE - MODIFY\n", + "type":"string", + "enum":[ + "ADD", + "REMOVE", + "MODIFY" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED" + ] + } + } + } + }, + "affectedVls":{ + "description":"Information about the VL instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted, modified and temporary VLs.\n", + "type":"object", + "required":[ + "id", + "virtualLinkDescId", + "changeType", + "networkResource" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "virtualLinkDescId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY * LINK_PORT_ADDED * LINK_PORT_REMOVED For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists.\n", + "type":"string", + "enum":[ + "ADDED", + "REMOVED", + "MODIFIED", + "TEMPORARY", + "LINK_PORT_ADDED", + "LINK_PORT_REMOVED" + ] + }, + "networkResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "affectedVnffgs":{ + "description":"Information about the VNFFG instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified VNFFG instances. It shall comply with the provisions in Table 6.5.3.5-1.\n", + "type":"object", + "required":[ + "vnffgInstanceId", + "vnffgdId" + ], + "properties":{ + "vnffgInstanceId":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + }, + "vnffgdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of change. Permitted values: - ADD - DELETE - MODIFY\n", + "type":"string", + "enum":[ + "ADD", + "DELETE", + "MODIFY" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED" + ] + } + } + } + }, + "affectedNss":{ + "description":"Information about the nested NS instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified nested NSs. It shall comply with the provisions in Table 6.5.3.6-1.\n", + "type":"object", + "required":[ + "nsInstanceId", + "nsdId", + "changeType", + "changeResult" + ], + "properties":{ + "nsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of lifecycle change. Permitted values: - ADD - REMOVE - INSTANTIATE - SCALE - UPDATE - HEAL - TERMINATE\n", + "type":"string", + "enum":[ + "ADD", + "REMOVE", + "INSTANTIATE", + "SCALE", + "UPDATE", + "HEAL", + "TERMINATE" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED - PARTIALLY_COMPLETED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED", + "PARTIALLY_COMPLETED" + ] + } + } + } + }, + "affectedSaps":{ + "description":"Information about the nested NS instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified SAP of a NS. It shall comply with the provisions in Table 6.5.3.7-1.\n", + "type":"object", + "required":[ + "sapInstanceId", + "sapdId" + ], + "properties":{ + "sapInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "sapdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "sapName":{ + "description":"Human readable name for the SAP.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of lifecycle change. Permitted values: - ADD - REMOVE - MODIFY\n", + "type":"string", + "enum":[ + "ADD", + "REMOVE", + "MODIFY" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED" + ] + } + } + } + } + } + }, + "_links":{ + "description":"Links to resources related to this resource.\n", + "type":"object", + "required":[ + "self", + "nsInstance" + ], + "properties":{ + "self":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "nsInstance":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "cancel":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "retry":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "rollback":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "continue":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "fail":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + } + } + } + } + }, + "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.\n", + "maximum":1, + "minimum":1 + }, + "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.\n", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "416":{ + "description":"416 RANGE NOT SATISFIABLE\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/ns_lcm_op_occs/{nsLcmOpOccId}/retry":{ + "parameters":[ + { + "name":"nsLcmOpOccId", + "description":"Identifier of a NS lifecycle management operation occurrence to be retried.\nThis identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request triggering a NS LCM operation. It can also be retrieved from the \"nsLcmOpOccId\" attribute in the NsLcmOperationOccurrenceNotification.\n", + "in":"path", + "type":"string", + "required":true + } + ], + "post":{ + "summary":"Retry a NS lifecycle management operation occurrence.", + "description":"The POST method initiates retrying a NS lifecycle management operation if that operation has experienced a temporary failure, i.e. the related \"NS LCM operation occurrence\" is in \"FAILED_TEMP\" state. This method shall follow the provisions specified in the Tables 6.4.11.3.1-1 and 6.4.11.3.1-2 for URI query parameters, request and response data structures, and response codes.\n", + "parameters":[ + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + } + ], + "responses":{ + "202":{ + "description":"202 ACCEPTED\n", + "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", + "maximum":1, + "minimum":0 + }, + "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", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "409":{ + "description":"409 CONFLICT\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/ns_lcm_op_occs/{nsLcmOpOccId}/rollback":{ + "parameters":[ + { + "name":"nsLcmOpOccId", + "description":"Identifier of a NS lifecycle management operation occurrence to be rolled back.\nThis identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request triggering a NS LCM operation. It can also be retrieved from the \"nsLcmOpOccId\" attribute in the NsLcmOperationOccurrenceNotification.\n", + "in":"path", + "required":true, + "type":"string" + } + ], + "post":{ + "summary":"Rollback a NS lifecycle management operation occurrence.", + "description":"The POST method initiates rolling back a NS lifecycle operation if that operation has experienced a temporary failure, i.e. the related \"NS LCM operation occurrence\" is in \"FAILED_TEMP\" state. This method shall follow the provisions specified in the Tables 6.4.12.3.1-1 and 6.4.12.3.1-2 for URI query parameters, request and response data structures, and response codes.\n", + "parameters":[ + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + } + ], + "responses":{ + "202":{ + "description":"202 ACCEPTED\n", + "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", + "maximum":1, + "minimum":0 + }, + "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", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "409":{ + "description":"409 CONFLICT\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/ns_lcm_op_occs/{nsLcmOpOccId}/continue":{ + "parameters":[ + { + "name":"nsLcmOpOccId", + "description":"Identifier of a NS lifecycle management operation occurrence to be continued.\nThis identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request triggering an NS LCM operation. It can also be retrieved from the \"nsLcmOpOccId\" attribute in the NsLcmOperationOccurrenceNotification.\n", + "in":"path", + "required":true, + "type":"string" + } + ], + "post":{ + "summary":"Continue a NS lifecycle management operation occurrence.", + "description":"The POST method initiates continuing an NS lifecycle operation if that operation has experienced a temporary failure, i.e. the related \"NS LCM operation occurrence\" is in \"FAILED_TEMP\" state. This method shall follow the provisions specified in the Tables 6.4.13.3.1-1 and 6.4.13.3.1-2 for URI query parameters, request and response data structures, and response codes.\n", + "parameters":[ + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + } + ], + "responses":{ + "202":{ + "description":"202 ACCEPTED\n", + "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", + "maximum":1, + "minimum":0 + }, + "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", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "409":{ + "description":"409 CONFLICT\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/fail":{ + "parameters":[ + { + "name":"nsLcmOpOccId", + "description":"Identifier of a NS lifecycle management operation occurrence to be marked as \"failed\".\nThis identifier can be retrieved from the resource referenced by he \"Location\" HTTP header in the response to a POST request triggering a NS LCM operation. It can also be retrieved from the \"nsLcmOpOccId\" attribute in the NsLcmOperationOccurrenceNotification.\n", + "in":"path", + "required":true, + "type":"string" + } + ], + "post":{ + "summary":"Mark a NS lifecycle management operation occurrence as failed.", + "description":"The POST method marks a NS lifecycle management operation occurrence as \"finally failed\" if that operation occurrence is in \"FAILED_TEMP\" state.\n", + "parameters":[ + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + } + ], + "responses":{ + "200":{ + "description":"200 OK\nShall be returned when the state of the NS lifecycle management operation occurrence has been changed successfully. The response shall include a representation of the \"Individual NS lifecycle management operation occurrence\" resource.\n", + "schema":{ + "description":"This type represents a request a NS lifecycle operation occurrence. It shall comply with the provisions defined in Table 6.5.2.3-1.\n", + "type":"object", + "required":[ + "id", + "operationState", + "statusEnteredTime", + "nsInstanceId", + "lcmOperationType", + "startTime", + "isAutomaticInvocation", + "isCancelPending", + "_links" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "operationState":{ + "description":"The enumeration NsLcmOperationStateType shall comply with the provisions defined in Table 6.5.4.4-1. Value | Description ------|------------ PROCESSING | The LCM operation is currently in execution. COMPLETED | The LCM operation has been completed successfully. PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. OLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n", + "type":"string", + "enum":[ + "PROCESSING", + "COMPLETED", + "FAILED_TEMP", + "FAILED", + "ROLLING_BACK", + "ROLLED_BACK" + ] + }, + "statusEnteredTime":{ + "description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n", + "format":"date-time", + "type":"string" + }, + "nsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "lcmOperationType":{ + "description":"The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation occurrence notification. Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate NS\" LCM operation. SCALE | Represents the \"Scale NS\" LCM operation. UPDATE | Represents the \"Update NS\" LCM operation. TERMINATE | Represents the \"Terminate NS\" LCM operation. HEAL | Represents the \"Heal NS\" LCM operation.\n", + "type":"string", + "enum":[ + "INSTANTIATE", + "SCALE", + "UPDATE", + "TERMINATE", + "HEAL" + ] + }, + "startTime":{ + "description":"Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n", + "format":"date-time", + "type":"string" + }, + "isAutomaticInvocation":{ + "description":"Set to true if this NS LCM operation occurrence has been automatically triggered by the NFVO. This occurs in the case of auto-scaling, auto-healing and when a nested NS is modified as a result of an operation on its composite NS. Set to false otherwise.\n", + "type":"boolean" + }, + "operationParams":{ + "description":"Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation. The following mapping between lcmOperationType and the data type of this attribute shall apply: - INSTANTIATE: InstantiateNsRequest - SCALE: ScaleNsRequest - UPDATE: UpdateNsRequest - HEAL: HealNsRequest - TERMINATE: TerminateNsRequest This attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n", + "type":"object" + }, + "isCancelPending":{ + "description":"If the LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state and the operation is being cancelled, this attribute shall be set to true. Otherwise, it shall be set to false.\n", + "type":"boolean" + }, + "cancelMode":{ + "description":"Cancellation mode.\nThe NFVO shall not start any new VNF lifecycle management and resource management operation, and shall wait for the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, to finish execution or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state.\nThe NFVO shall not start any new VNF lifecycle management and resource management operation, shall cancel the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state.\n", + "type":"string", + "enum":[ + "GRACEFUL", + "FORCEFUL" + ] + }, + "error":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + }, + "resourceChanges":{ + "description":"This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the LCM operation since its start, if applicable\n", + "type":"object", + "properties":{ + "affectedVnfs":{ + "description":"Information about the VNF instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified VNFs. It shall comply with the provisions in Table 6.5.3.2-1.\n", + "type":"object", + "required":[ + "vnfInstanceId", + "vnfdId", + "vnfProfileId", + "vnfName", + "changeType", + "changeResult" + ], + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "vnfName":{ + "description":"Name of the VNF Instance.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of change Permitted values: - ADD - REMOVE - INSTANTIATE - TERMINATE - SCALE - CHANGE_FLAVOUR - HEAL - OPERATE - MODIFY_INFORMATION - CHANGE_EXTERNAL_VNF_CONNECTIVITY\n", + "type":"string", + "enum":[ + "ADD", + "REMOVE", + "INSTANTIATE", + "TERMINATE", + "SCALE", + "CHANGE_FLAVOUR", + "HEAL", + "OPERATE", + "MODIFY_INFORMATION", + "CHANGE_EXTERNAL_VNF_CONNECTIVITY" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED" + ] + }, + "changedInfo":{ + "description":"Information about the changed VNF instance information, including VNF configurable properties,if applicable. When the \"changedInfo\" attribute is present, either the \"changedVnfInfo\" attribute or the \"changedExtConnectivity\" attribute or both shall be present.\n", + "type":"object", + "required":[ + "self" + ], + "properties":{ + "changedVnfInfo":{ + "description":"This type represents the information that is requested to be modified for a VNF instance. The information to be modified shall comply with the associated NSD. EXAMPLE. The vnfPkgId attribute value for a particular VNF instance can only be updated with a value that matches the identifier value of a VNF package whose vnfdId is present in the associated profile of the NSD.\n", + "type":"object", + "required":[ + "vnfInstanceId" + ], + "properties":{ + "vnfInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfInstanceName":{ + "description":"New value of the \"vnfInstanceName\" attribute in \"VnfInstance\", or \"null\" to remove the attribute.\n", + "type":"string" + }, + "vnfInstanceDescription":{ + "description":"New value of the \"vnfInstanceDescription\" attribute in \"VnfInstance\", or \"null\" to remove the attribute.\n", + "type":"string" + }, + "vnfdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "vnfConfigurableProperties":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + }, + "extensions":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + }, + "changedExtConnectivity":{ + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "extLinkPorts":{ + "description":"Link ports of this VL.\n", + "type":"array", + "items":{ + "description":"This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n", + "type":"object", + "required":[ + "id", + "resourceHandle" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceHandle":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "cpInstanceId":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + } + } + } + } + } + } + } + } + } + } + }, + "affectedPnfs":{ + "description":"Information about the PNF instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified PNFs. It shall comply with the provisions in Table 6.5.3.3-1.\n", + "type":"object", + "required":[ + "pnfId", + "pnfdId", + "pnfProfileId", + "cpInstanceId" + ], + "properties":{ + "pnfId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "pnfdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "pnfProfileId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "pnfName":{ + "description":"Name of the PNF.\n", + "type":"string" + }, + "cpInstanceId":{ + "description":"Identifier of the CP in the scope of the PNF.\n", + "type":"array", + "items":{ + "description":"An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n", + "type":"string" + } + }, + "changeType":{ + "description":"Signals the type of change. Permitted values: - ADD - REMOVE - MODIFY\n", + "type":"string", + "enum":[ + "ADD", + "REMOVE", + "MODIFY" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED" + ] + } + } + } + }, + "affectedVls":{ + "description":"Information about the VL instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted, modified and temporary VLs.\n", + "type":"object", + "required":[ + "id", + "virtualLinkDescId", + "changeType", + "networkResource" + ], + "properties":{ + "id":{ + "description":"An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type":"string" + }, + "virtualLinkDescId":{ + "description":"Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY * LINK_PORT_ADDED * LINK_PORT_REMOVED For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists.\n", + "type":"string", + "enum":[ + "ADDED", + "REMOVED", + "MODIFIED", + "TEMPORARY", + "LINK_PORT_ADDED", + "LINK_PORT_REMOVED" + ] + }, + "networkResource":{ + "description":"This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n", + "type":"object", + "required":[ + "resourceId" + ], + "properties":{ + "vimId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceProviderId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "resourceId":{ + "description":"An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n", + "type":"string" + }, + "vimLevelResourceType":{ + "description":"Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n", + "type":"string" + } + } + }, + "metadata":{ + "description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", + "type":"object" + } + } + } + }, + "affectedVnffgs":{ + "description":"Information about the VNFFG instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified VNFFG instances. It shall comply with the provisions in Table 6.5.3.5-1.\n", + "type":"object", + "required":[ + "vnffgInstanceId", + "vnffgdId" + ], + "properties":{ + "vnffgInstanceId":{ + "description":"An identifier that is unique with respect to a NS. Representation: string of variable length.\n", + "type":"string" + }, + "vnffgdId":{ + "description":"An identifier that is unique within a NS descriptor. Representation: string of variable length.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of change. Permitted values: - ADD - DELETE - MODIFY\n", + "type":"string", + "enum":[ + "ADD", + "DELETE", + "MODIFY" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED" + ] + } + } + } + }, + "affectedNss":{ + "description":"Information about the nested NS instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified nested NSs. It shall comply with the provisions in Table 6.5.3.6-1.\n", + "type":"object", + "required":[ + "nsInstanceId", + "nsdId", + "changeType", + "changeResult" + ], + "properties":{ + "nsInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "nsdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of lifecycle change. Permitted values: - ADD - REMOVE - INSTANTIATE - SCALE - UPDATE - HEAL - TERMINATE\n", + "type":"string", + "enum":[ + "ADD", + "REMOVE", + "INSTANTIATE", + "SCALE", + "UPDATE", + "HEAL", + "TERMINATE" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED - PARTIALLY_COMPLETED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED", + "PARTIALLY_COMPLETED" + ] + } + } + } + }, + "affectedSaps":{ + "description":"Information about the nested NS instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note.\n", + "type":"array", + "items":{ + "description":"This type provides information about added, deleted and modified SAP of a NS. It shall comply with the provisions in Table 6.5.3.7-1.\n", + "type":"object", + "required":[ + "sapInstanceId", + "sapdId" + ], + "properties":{ + "sapInstanceId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "sapdId":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "sapName":{ + "description":"Human readable name for the SAP.\n", + "type":"string" + }, + "changeType":{ + "description":"Signals the type of lifecycle change. Permitted values: - ADD - REMOVE - MODIFY\n", + "type":"string", + "enum":[ + "ADD", + "REMOVE", + "MODIFY" + ] + }, + "changeResult":{ + "description":"Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n", + "type":"string", + "enum":[ + "COMPLETED", + "ROLLED_BACK", + "FAILED" + ] + } + } + } + } + } + }, + "_links":{ + "description":"Links to resources related to this resource.\n", + "type":"object", + "required":[ + "self", + "nsInstance" + ], + "properties":{ + "self":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "nsInstance":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "cancel":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "retry":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "rollback":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "continue":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + }, + "fail":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + } + } + } + } + }, + "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.\n", + "maximum":1, + "minimum":1 + }, + "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.\n", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "409":{ + "description":"409 CONFLICT\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel":{ + "parameters":[ + { + "name":"nsLcmOpOccId", + "description":"Identifier of a NS lifecycle management operation occurrence to be canceled.\nThis identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request triggering a NS LCM operation. It can also be retrieved from the \"nsLcmOpOccId\" attribute in the NsLcmOperationOccurrenceNotification.\n", + "in":"path", + "required":true, + "type":"string" + } + ], + "post":{ + "summary":"Cancel a NS lifecycle management operation occurrence.", + "description":"The POST method initiates cancelling an ongoing NS lifecycle management operation while it is being executed or rolled back, i.e. the related \"NS LCM operation occurrence\" is either in \"PROCESSING\" or \"ROLLING_BACK\" state. This method shall follow the provisions specified in the Tables 6.4.15.3.1-1 and 6.4.15.3.1-2 for URI query parameters, request and response data structures, and response codes. Before returning the \"202 Accepted\" response, the NFVO shall update the \"isCancelPending\" and \"cancelMode\" attributes in the representation of the parent resource according to the provisions in clause 6.5.2.3. In case of success of processing the asynchronous request: 1) If the request has been processed in \"PROCESSING\" or \"ROLLING_BACK\" state, the \"operationState\" attribute in the representation of the parent resource shall be changed to \"FAILED_TEMP\". In both cases, the NFVO shall update the \"isCancelPending\" and \"cancelMode\" attributes in the representation of the parent resource according to the provisions in clause 6.5.2.3 to reflect the new status, and the applicable \"result\" notification according to clause 6.6.2.2 shall be emitted to indicate that the execution of the underlying NS LCM operation occurrence has temporarily failed. Due to race conditions, the processing of the actual operation that is to be cancelled may eventually still succeed, in which case the \"operationState\" attribute in the representation of the parent resource shall represent the result of that operation, rather than the result of the cancellation.\n", + "parameters":[ + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Content-Type", + "description":"The MIME type of the body of the request. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"body", + "in":"body", + "required":true, + "schema":{ + "description":"This type represents a parameter to select the mode of canceling an ongoing NS LCM operation occurrence. It shall comply with the provisions defined in Table 6.5.2.16-1.\n", + "type":"object", + "required":[ + "cancelMode" + ], + "properties":{ + "cancelMode":{ + "description":"Cancellation mode.\nThe NFVO shall not start any new VNF lifecycle management and resource management operation, and shall wait for the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, to finish execution or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state.\nThe NFVO shall not start any new VNF lifecycle management and resource management operation, shall cancel the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state.\n", + "type":"string", + "enum":[ + "GRACEFUL", + "FORCEFUL" + ] + } + } + }, + "description":"The POST request to this resource shall include a CancelMode structure in the payload body to choose between \"graceful\" and \"forceful\" cancellation.\n" + } + ], + "responses":{ + "202":{ + "description":"202 ACCEPTED\n", + "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", + "maximum":1, + "minimum":0 + }, + "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", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "409":{ + "description":"409 CONFLICT\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/subscriptions":{ + "parameters":[ + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235.\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + } + ], + "post":{ + "summary":"Subscribe to NS lifecycle 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 6.4.16.3.1-1 and 6.4.16.3.1-2. 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).\n", + "parameters":[ + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"Content-Type", + "description":"The MIME type of the body of the request. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + }, + { + "name":"body", + "in":"body", + "required":true, + "schema":{ + "description":"This type represents a subscription request related to notifications about NS lifecycle changes. It shall comply with the provisions defined in Table 6.5.2.2-1..\n", + "type":"object", + "required":[ + "callbackUri" + ], + "properties":{ + "filter":{ + "description":"This type represents a subscription filter related to notifications about NS lifecycle changes. It shall comply with the provisions defined in Table 6.5.3.8-1. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n", + "type":"object", + "properties":{ + "nsInstanceSubscriptionFilter":{ + "description":"This type represents subscription filter criteria to match NS instances.\nNOTE 1: The attributes \"nsdIds\", \"vnfdIds\" and \"pnfdIds\" are alternatives to reference to NS instances that are created based on certain NSDs, or contain VNF instances that are based on certain VNFDs, or contain PNFs that are based on certain PNFDs in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\nNOTE 2: The attributes \"nsInstanceIds\" and \"nsInstanceNames\" are alternatives to reference to particular NS Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type":"object", + "properties":{ + "nsdIds":{ + "description":"If present, match NS instances that were created based on a NSD identified by one of the nsdId values listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "vnfdIds":{ + "description":"If present, match NS instances that contain VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "pnfdIds":{ + "description":"If present, match NS instances that contain PNFs that are represented by a PNFD identified by one of the pnfdId values listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "nsInstanceIds":{ + "description":"If present, match NS instances with an instance identifier listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "nsInstanceNames":{ + "description":"If present, match NS instances with a NS Instance Name listed in this attribute.\n", + "type":"array", + "items":{ + "description":"A string as defined in IETF RFC 8259.\n", + "type":"string" + } + } + } + }, + "notificationTypes":{ + "description":"Match particular notification types. Permitted values: - NsLcmOperationOccurenceNotification - NsIdentifierCreationNotification - NsIdentifierDeletionNotification - NsChangeNotification\n", + "type":"array", + "items":{ + "type":"string", + "enum":[ + "NsLcmOperationOccurenceNotification", + "NsIdentifierCreationNotification", + "NsIdentifierDeletionNotification", + "NsChangeNotification" + ] + } + }, + "operationTypes":{ + "description":"Match particular NS lifecycle operation types for the notification of type NsLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation occurrence notification. Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate NS\" LCM operation. SCALE | Represents the \"Scale NS\" LCM operation. UPDATE | Represents the \"Update NS\" LCM operation. TERMINATE | Represents the \"Terminate NS\" LCM operation. HEAL | Represents the \"Heal NS\" LCM operation.\n", + "type":"string", + "enum":[ + "INSTANTIATE", + "SCALE", + "UPDATE", + "TERMINATE", + "HEAL" + ] + } + }, + "operationStates":{ + "description":"Match particular LCM operation state values as reported in notifications of type NsLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"Value | Description ------|------------ PROCESSING | The LCM operation is currently in execution. COMPLETED | The LCM operation has been completed successfully. PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action will not succeed. OLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the NS prior to the original operation invocation has been restored as closely as possible.\n", + "type":"string", + "enum":[ + "PROCESSING", + "COMPLETED", + "PARTIALLY_COMPLETED", + "FAILED_TEMP", + "FAILED", + "ROLLING_BACK", + "ROLLED_BACK" + ] + } + }, + "nsComponentTypes":{ + "description":"Match particular NS component types for the notification of type NsChangeNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsChang.\n", + "type":"array", + "items":{ + "description":"The enumeration NsComponentType represents the NS component type. It shall comply with the provisions defined in Table 6.5.4.5-1. Value | Description ------|------------ VNF | Represents the impacted NS component is a VNF. PNF | Represents the impacted NS component is a PNF. NS | Represents the impacted NS component is a nested NS.\n", + "type":"string", + "enum":[ + "VNF", + "PNF", + "NS" + ] + } + }, + "lcmOpNameImpactingNsComponent":{ + "description":"Match particular LCM operation names for the notification of type NsChangeNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsChangeNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"The enumeration LcmOpNameForChangeNotificationType represents the name of the lifecycle operation that impacts the NS component and trigger an NS change notification. It shall comply with the provisions defined in Table 6.5.4.6-1. Value | Description ------|------------ VNF_INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. VNF_SCALE | Represents the \"Scale VNF\" LCM operation. VNF_SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. VNF_CHANGE_FLAVOUR | Represents the \"Change VNF Flavor\" LCM operation. VNF_TERMINATE | Represents the \"Terminate VNF\" LCM operation. VNF_HEAL | Represents the \"Heal VNF\" LCM operation. VNF_OPERATE | Represents the \"Operate VNF\" LCM operation. VNF_CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. VNF_MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. NS_INSTANTIATE | Represents the \"Instantiate NS\" LCM operation NS_SCALE | Represents the \"Scale NS\" LCM operation. NS_UPDATE | Represents the \"Update NS\" LCM operation. NS_TERMINATE | Represents the \"Terminate NS\" LCM operation. NS_HEAL | Represents the \"Heal NS\" LCM operation.\n", + "type":"string", + "enum":[ + "VNF_INSTANTIATE", + "VNF_SCALE", + "VNF_SCALE_TO_LEVEL", + "VNF_CHANGE_FLAVOUR", + "VNF_TERMINATE", + "VNF_HEAL", + "VNF_OPERATE", + "VNF_CHANGE_EXT_CONN", + "VNF_MODIFY_INFO", + "NS_INSTANTIATE", + "NS_SCALE", + "NS_UPDATE", + "NS_TERMINATE", + "NS_HEAL" + ] + } + }, + "lcmOpOccStatusImpactingNsComponent":{ + "description":"Match particular LCM operation status values as reported in notifications of type NsChangeNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsChangeNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"The enumeration LcmOpOccStatusForChangeNotificationType represents the status of the lifecycle management operation occurrence that impacts the NS component and triggers an NS change notification. It shall comply with the provisions defined in Table 6.5.4.7-1. Value | Description ------|------------ START | The impact on the NS component is identified. COMPLETED | The impact on the NS component stops and related lifecycle operation completes successfully. PARTIALLY_COMPLETED | The impact on the NS component stops and related lifecycle operation partially completes. Inconsistency state may exist on the NS component. FAILED | The impact on the NS component stops and related lifecycle operation fails. Inconsistency state may exist for the NS component. ROLLED_BACK | The impact on the NS component stops and related lifecycle operation is rolled back.\n", + "type":"string", + "enum":[ + "START", + "COMPLETED", + "PARTIALLY_COMPLETED", + "FAILED", + "ROLLED_BACK" + ] + } + } + } + }, + "callbackUri":{ + "description":"String formatted according to IETF RFC 3986.\n", + "type":"string", + "format":"uri" + }, + "authentication":{ + "type":"object", + "required":[ + "authType" + ], + "properties":{ + "authType":{ + "description":"Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification. Permitted values: - BASIC: In every HTTP request to the notification endpoint, use HTTP Basic authentication with the client credentials.\n- OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use an OAuth 2.0 Bearer token, obtained\n using the client credentials grant type.\n- TLS_CERT: Every HTTP request to the notification endpoint is sent over a mutually authenticated TLS session, i.e. not only the\n server is authenticated, but also the client is authenticated\n during the TLS tunnel setup.\n", + "type":"array", + "items":{ + "type":"string", + "enum":[ + "BASIC", + "OAUTH2_CLIENT_CREDENTIALS", + "TLS_CERT" + ] + } + }, + "paramsBasic":{ + "description":"Parameters for authentication/authorization using BASIC. Shall be present if authType is \"BASIC\" and the contained information has not been provisioned out of band. Shall be absent otherwise.\n", + "type":"object", + "properties":{ + "userName":{ + "description":"Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n", + "type":"string" + }, + "password":{ + "description":"Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n", + "type":"string" + } + } + }, + "paramsOauth2ClientCredentials":{ + "description":"Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is \"OAUTH2_CLIENT_CREDENTIALS\" and the contained information has not been provisioned out of band. Shall be absent otherwise.\n", + "type":"object", + "properties":{ + "clientId":{ + "description":"Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process.\n", + "type":"string" + }, + "clientPassword":{ + "description":"Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process.\n", + "type":"string" + }, + "tokenEndpoint":{ + "description":"String formatted according to IETF RFC 3986.\n", + "type":"string", + "format":"uri" + } + } + } + } + } + } + }, + "description":"Details of the subscription to be created, as defined in clause 6.5.2.2.\n" + } + ], + "responses":{ + "201":{ + "description":"201 Created\nShall be returned when the subscription has been created successfully. The response body shall contain a representation of the created \"Individual subscription\" resource. The HTTP response shall include a \"Location:\" HTTP header that points to the created \"Individual subscription\" resource.\n", + "schema":{ + "description":"This type represents a subscription related to notifications about NS lifecycle changes. It shall comply with the provisions defined in Table 6.5.2.4-1.\n", + "type":"object", + "required":[ + "id", + "callbackUri", + "_links" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "filter":{ + "description":"This type represents a subscription filter related to notifications about NS lifecycle changes. It shall comply with the provisions defined in Table 6.5.3.8-1. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n", + "type":"object", + "properties":{ + "nsInstanceSubscriptionFilter":{ + "description":"This type represents subscription filter criteria to match NS instances.\nNOTE 1: The attributes \"nsdIds\", \"vnfdIds\" and \"pnfdIds\" are alternatives to reference to NS instances that are created based on certain NSDs, or contain VNF instances that are based on certain VNFDs, or contain PNFs that are based on certain PNFDs in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\nNOTE 2: The attributes \"nsInstanceIds\" and \"nsInstanceNames\" are alternatives to reference to particular NS Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type":"object", + "properties":{ + "nsdIds":{ + "description":"If present, match NS instances that were created based on a NSD identified by one of the nsdId values listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "vnfdIds":{ + "description":"If present, match NS instances that contain VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "pnfdIds":{ + "description":"If present, match NS instances that contain PNFs that are represented by a PNFD identified by one of the pnfdId values listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "nsInstanceIds":{ + "description":"If present, match NS instances with an instance identifier listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "nsInstanceNames":{ + "description":"If present, match NS instances with a NS Instance Name listed in this attribute.\n", + "type":"array", + "items":{ + "description":"A string as defined in IETF RFC 8259.\n", + "type":"string" + } + } + } + }, + "notificationTypes":{ + "description":"Match particular notification types. Permitted values: - NsLcmOperationOccurenceNotification - NsIdentifierCreationNotification - NsIdentifierDeletionNotification - NsChangeNotification\n", + "type":"array", + "items":{ + "type":"string", + "enum":[ + "NsLcmOperationOccurenceNotification", + "NsIdentifierCreationNotification", + "NsIdentifierDeletionNotification", + "NsChangeNotification" + ] + } + }, + "operationTypes":{ + "description":"Match particular NS lifecycle operation types for the notification of type NsLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation occurrence notification. Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate NS\" LCM operation. SCALE | Represents the \"Scale NS\" LCM operation. UPDATE | Represents the \"Update NS\" LCM operation. TERMINATE | Represents the \"Terminate NS\" LCM operation. HEAL | Represents the \"Heal NS\" LCM operation.\n", + "type":"string", + "enum":[ + "INSTANTIATE", + "SCALE", + "UPDATE", + "TERMINATE", + "HEAL" + ] + } + }, + "operationStates":{ + "description":"Match particular LCM operation state values as reported in notifications of type NsLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"Value | Description ------|------------ PROCESSING | The LCM operation is currently in execution. COMPLETED | The LCM operation has been completed successfully. PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action will not succeed. OLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the NS prior to the original operation invocation has been restored as closely as possible.\n", + "type":"string", + "enum":[ + "PROCESSING", + "COMPLETED", + "PARTIALLY_COMPLETED", + "FAILED_TEMP", + "FAILED", + "ROLLING_BACK", + "ROLLED_BACK" + ] + } + }, + "nsComponentTypes":{ + "description":"Match particular NS component types for the notification of type NsChangeNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsChang.\n", + "type":"array", + "items":{ + "description":"The enumeration NsComponentType represents the NS component type. It shall comply with the provisions defined in Table 6.5.4.5-1. Value | Description ------|------------ VNF | Represents the impacted NS component is a VNF. PNF | Represents the impacted NS component is a PNF. NS | Represents the impacted NS component is a nested NS.\n", + "type":"string", + "enum":[ + "VNF", + "PNF", + "NS" + ] + } + }, + "lcmOpNameImpactingNsComponent":{ + "description":"Match particular LCM operation names for the notification of type NsChangeNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsChangeNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"The enumeration LcmOpNameForChangeNotificationType represents the name of the lifecycle operation that impacts the NS component and trigger an NS change notification. It shall comply with the provisions defined in Table 6.5.4.6-1. Value | Description ------|------------ VNF_INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. VNF_SCALE | Represents the \"Scale VNF\" LCM operation. VNF_SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. VNF_CHANGE_FLAVOUR | Represents the \"Change VNF Flavor\" LCM operation. VNF_TERMINATE | Represents the \"Terminate VNF\" LCM operation. VNF_HEAL | Represents the \"Heal VNF\" LCM operation. VNF_OPERATE | Represents the \"Operate VNF\" LCM operation. VNF_CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. VNF_MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. NS_INSTANTIATE | Represents the \"Instantiate NS\" LCM operation NS_SCALE | Represents the \"Scale NS\" LCM operation. NS_UPDATE | Represents the \"Update NS\" LCM operation. NS_TERMINATE | Represents the \"Terminate NS\" LCM operation. NS_HEAL | Represents the \"Heal NS\" LCM operation.\n", + "type":"string", + "enum":[ + "VNF_INSTANTIATE", + "VNF_SCALE", + "VNF_SCALE_TO_LEVEL", + "VNF_CHANGE_FLAVOUR", + "VNF_TERMINATE", + "VNF_HEAL", + "VNF_OPERATE", + "VNF_CHANGE_EXT_CONN", + "VNF_MODIFY_INFO", + "NS_INSTANTIATE", + "NS_SCALE", + "NS_UPDATE", + "NS_TERMINATE", + "NS_HEAL" + ] + } + }, + "lcmOpOccStatusImpactingNsComponent":{ + "description":"Match particular LCM operation status values as reported in notifications of type NsChangeNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsChangeNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"The enumeration LcmOpOccStatusForChangeNotificationType represents the status of the lifecycle management operation occurrence that impacts the NS component and triggers an NS change notification. It shall comply with the provisions defined in Table 6.5.4.7-1. Value | Description ------|------------ START | The impact on the NS component is identified. COMPLETED | The impact on the NS component stops and related lifecycle operation completes successfully. PARTIALLY_COMPLETED | The impact on the NS component stops and related lifecycle operation partially completes. Inconsistency state may exist on the NS component. FAILED | The impact on the NS component stops and related lifecycle operation fails. Inconsistency state may exist for the NS component. ROLLED_BACK | The impact on the NS component stops and related lifecycle operation is rolled back.\n", + "type":"string", + "enum":[ + "START", + "COMPLETED", + "PARTIALLY_COMPLETED", + "FAILED", + "ROLLED_BACK" + ] + } + } + } + }, + "callbackUri":{ + "description":"String formatted according to IETF RFC 3986.\n", + "type":"string", + "format":"uri" + }, + "_links":{ + "description":"Links to resources related to this resource.\n", + "type":"object", + "required":[ + "self" + ], + "properties":{ + "self":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + } + } + } + } + }, + "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.\n" + }, + "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.\n", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "303":{ + "description":"303 SEE OTHER\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + }, + "get":{ + "summary":"Query multiple subscriptions.", + "description":"Query Subscription Information.\nThe 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.\n", + "parameters":[ + { + "name":"filter", + "in":"query", + "required":false, + "type":"string", + "description":"Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. The NFVO shall support receiving this parameter as part of the URI query string. The OSS/BSS may supply this parameter. All attribute names that appear in the LccnSubscription and in data types referenced from it shall be supported by the NFVO in the filter expression.\n" + }, + { + "name":"nextpage_opaque_marker", + "in":"query", + "description":"Marker to obtain the next page of a paged response. Shall be supported by the NFVO if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013 for this resource.\n", + "required":false, + "type":"string" + }, + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + } + ], + "responses":{ + "200":{ + "description":"200 OK\nShall be returned when the list of subscriptions has been queried successfully. The response body shall contain in an array the representations of all active subscriptions of the functional block that invokes the method, i.e. zero or more representations of lifecycle change notification subscriptions as defined in clause 6.5.2.4. If the \"filter\" URI parameter was supplied in the request, the data in the response body shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013 [16]. If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 [16] for this resource, inclusion 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].\n", + "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.\n" + }, + "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.\n", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + }, + "Link":{ + "description":"Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.\n", + "type":"string", + "maximum":1, + "minimum":0 + } + }, + "schema":{ + "type":"array", + "items":{ + "description":"This type represents a subscription related to notifications about NS lifecycle changes. It shall comply with the provisions defined in Table 6.5.2.4-1.\n", + "type":"object", + "required":[ + "id", + "callbackUri", + "_links" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "filter":{ + "description":"This type represents a subscription filter related to notifications about NS lifecycle changes. It shall comply with the provisions defined in Table 6.5.3.8-1. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n", + "type":"object", + "properties":{ + "nsInstanceSubscriptionFilter":{ + "description":"This type represents subscription filter criteria to match NS instances.\nNOTE 1: The attributes \"nsdIds\", \"vnfdIds\" and \"pnfdIds\" are alternatives to reference to NS instances that are created based on certain NSDs, or contain VNF instances that are based on certain VNFDs, or contain PNFs that are based on certain PNFDs in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\nNOTE 2: The attributes \"nsInstanceIds\" and \"nsInstanceNames\" are alternatives to reference to particular NS Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type":"object", + "properties":{ + "nsdIds":{ + "description":"If present, match NS instances that were created based on a NSD identified by one of the nsdId values listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "vnfdIds":{ + "description":"If present, match NS instances that contain VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "pnfdIds":{ + "description":"If present, match NS instances that contain PNFs that are represented by a PNFD identified by one of the pnfdId values listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "nsInstanceIds":{ + "description":"If present, match NS instances with an instance identifier listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "nsInstanceNames":{ + "description":"If present, match NS instances with a NS Instance Name listed in this attribute.\n", + "type":"array", + "items":{ + "description":"A string as defined in IETF RFC 8259.\n", + "type":"string" + } + } + } + }, + "notificationTypes":{ + "description":"Match particular notification types. Permitted values: - NsLcmOperationOccurenceNotification - NsIdentifierCreationNotification - NsIdentifierDeletionNotification - NsChangeNotification\n", + "type":"array", + "items":{ + "type":"string", + "enum":[ + "NsLcmOperationOccurenceNotification", + "NsIdentifierCreationNotification", + "NsIdentifierDeletionNotification", + "NsChangeNotification" + ] + } + }, + "operationTypes":{ + "description":"Match particular NS lifecycle operation types for the notification of type NsLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation occurrence notification. Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate NS\" LCM operation. SCALE | Represents the \"Scale NS\" LCM operation. UPDATE | Represents the \"Update NS\" LCM operation. TERMINATE | Represents the \"Terminate NS\" LCM operation. HEAL | Represents the \"Heal NS\" LCM operation.\n", + "type":"string", + "enum":[ + "INSTANTIATE", + "SCALE", + "UPDATE", + "TERMINATE", + "HEAL" + ] + } + }, + "operationStates":{ + "description":"Match particular LCM operation state values as reported in notifications of type NsLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"Value | Description ------|------------ PROCESSING | The LCM operation is currently in execution. COMPLETED | The LCM operation has been completed successfully. PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action will not succeed. OLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the NS prior to the original operation invocation has been restored as closely as possible.\n", + "type":"string", + "enum":[ + "PROCESSING", + "COMPLETED", + "PARTIALLY_COMPLETED", + "FAILED_TEMP", + "FAILED", + "ROLLING_BACK", + "ROLLED_BACK" + ] + } + }, + "nsComponentTypes":{ + "description":"Match particular NS component types for the notification of type NsChangeNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsChang.\n", + "type":"array", + "items":{ + "description":"The enumeration NsComponentType represents the NS component type. It shall comply with the provisions defined in Table 6.5.4.5-1. Value | Description ------|------------ VNF | Represents the impacted NS component is a VNF. PNF | Represents the impacted NS component is a PNF. NS | Represents the impacted NS component is a nested NS.\n", + "type":"string", + "enum":[ + "VNF", + "PNF", + "NS" + ] + } + }, + "lcmOpNameImpactingNsComponent":{ + "description":"Match particular LCM operation names for the notification of type NsChangeNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsChangeNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"The enumeration LcmOpNameForChangeNotificationType represents the name of the lifecycle operation that impacts the NS component and trigger an NS change notification. It shall comply with the provisions defined in Table 6.5.4.6-1. Value | Description ------|------------ VNF_INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. VNF_SCALE | Represents the \"Scale VNF\" LCM operation. VNF_SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. VNF_CHANGE_FLAVOUR | Represents the \"Change VNF Flavor\" LCM operation. VNF_TERMINATE | Represents the \"Terminate VNF\" LCM operation. VNF_HEAL | Represents the \"Heal VNF\" LCM operation. VNF_OPERATE | Represents the \"Operate VNF\" LCM operation. VNF_CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. VNF_MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. NS_INSTANTIATE | Represents the \"Instantiate NS\" LCM operation NS_SCALE | Represents the \"Scale NS\" LCM operation. NS_UPDATE | Represents the \"Update NS\" LCM operation. NS_TERMINATE | Represents the \"Terminate NS\" LCM operation. NS_HEAL | Represents the \"Heal NS\" LCM operation.\n", + "type":"string", + "enum":[ + "VNF_INSTANTIATE", + "VNF_SCALE", + "VNF_SCALE_TO_LEVEL", + "VNF_CHANGE_FLAVOUR", + "VNF_TERMINATE", + "VNF_HEAL", + "VNF_OPERATE", + "VNF_CHANGE_EXT_CONN", + "VNF_MODIFY_INFO", + "NS_INSTANTIATE", + "NS_SCALE", + "NS_UPDATE", + "NS_TERMINATE", + "NS_HEAL" + ] + } + }, + "lcmOpOccStatusImpactingNsComponent":{ + "description":"Match particular LCM operation status values as reported in notifications of type NsChangeNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsChangeNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"The enumeration LcmOpOccStatusForChangeNotificationType represents the status of the lifecycle management operation occurrence that impacts the NS component and triggers an NS change notification. It shall comply with the provisions defined in Table 6.5.4.7-1. Value | Description ------|------------ START | The impact on the NS component is identified. COMPLETED | The impact on the NS component stops and related lifecycle operation completes successfully. PARTIALLY_COMPLETED | The impact on the NS component stops and related lifecycle operation partially completes. Inconsistency state may exist on the NS component. FAILED | The impact on the NS component stops and related lifecycle operation fails. Inconsistency state may exist for the NS component. ROLLED_BACK | The impact on the NS component stops and related lifecycle operation is rolled back.\n", + "type":"string", + "enum":[ + "START", + "COMPLETED", + "PARTIALLY_COMPLETED", + "FAILED", + "ROLLED_BACK" + ] + } + } + } + }, + "callbackUri":{ + "description":"String formatted according to IETF RFC 3986.\n", + "type":"string", + "format":"uri" + }, + "_links":{ + "description":"Links to resources related to this resource.\n", + "type":"object", + "required":[ + "self" + ], + "properties":{ + "self":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + } + } + } + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}":{ + "parameters":[ + { + "name":"subscriptionId", + "description":"Identifier of this subscription.\n", + "in":"path", + "type":"string", + "required":true + }, + { + "name":"Authorization", + "description":"The authorization token for the request. Reference: IETF RFC 7235.\n", + "in":"header", + "required":false, + "type":"string" + }, + { + "name":"Version", + "description":"Version of the API requested to use when responding to this request.\n", + "in":"header", + "required":true, + "type":"string" + } + ], + "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 6.4.17.3.2-1 and 6.4.17.3.2-2\n", + "parameters":[ + { + "name":"Accept", + "description":"Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n", + "in":"header", + "required":true, + "type":"string" + } + ], + "responses":{ + "200":{ + "description":"200 OK\nShall be returned when information about an individual subscription has been read successfully. The response body shall contain a representation of the \"Individual subscription\" resource.\n", + "schema":{ + "description":"This type represents a subscription related to notifications about NS lifecycle changes. It shall comply with the provisions defined in Table 6.5.2.4-1.\n", + "type":"object", + "required":[ + "id", + "callbackUri", + "_links" + ], + "properties":{ + "id":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + }, + "filter":{ + "description":"This type represents a subscription filter related to notifications about NS lifecycle changes. It shall comply with the provisions defined in Table 6.5.3.8-1. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n", + "type":"object", + "properties":{ + "nsInstanceSubscriptionFilter":{ + "description":"This type represents subscription filter criteria to match NS instances.\nNOTE 1: The attributes \"nsdIds\", \"vnfdIds\" and \"pnfdIds\" are alternatives to reference to NS instances that are created based on certain NSDs, or contain VNF instances that are based on certain VNFDs, or contain PNFs that are based on certain PNFDs in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\nNOTE 2: The attributes \"nsInstanceIds\" and \"nsInstanceNames\" are alternatives to reference to particular NS Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type":"object", + "properties":{ + "nsdIds":{ + "description":"If present, match NS instances that were created based on a NSD identified by one of the nsdId values listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "vnfdIds":{ + "description":"If present, match NS instances that contain VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "pnfdIds":{ + "description":"If present, match NS instances that contain PNFs that are represented by a PNFD identified by one of the pnfdId values listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "nsInstanceIds":{ + "description":"If present, match NS instances with an instance identifier listed in this attribute.\n", + "type":"array", + "items":{ + "description":"An identifier with the intention of being globally unique.\n", + "type":"string" + } + }, + "nsInstanceNames":{ + "description":"If present, match NS instances with a NS Instance Name listed in this attribute.\n", + "type":"array", + "items":{ + "description":"A string as defined in IETF RFC 8259.\n", + "type":"string" + } + } + } + }, + "notificationTypes":{ + "description":"Match particular notification types. Permitted values: - NsLcmOperationOccurenceNotification - NsIdentifierCreationNotification - NsIdentifierDeletionNotification - NsChangeNotification\n", + "type":"array", + "items":{ + "type":"string", + "enum":[ + "NsLcmOperationOccurenceNotification", + "NsIdentifierCreationNotification", + "NsIdentifierDeletionNotification", + "NsChangeNotification" + ] + } + }, + "operationTypes":{ + "description":"Match particular NS lifecycle operation types for the notification of type NsLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation occurrence notification. Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate NS\" LCM operation. SCALE | Represents the \"Scale NS\" LCM operation. UPDATE | Represents the \"Update NS\" LCM operation. TERMINATE | Represents the \"Terminate NS\" LCM operation. HEAL | Represents the \"Heal NS\" LCM operation.\n", + "type":"string", + "enum":[ + "INSTANTIATE", + "SCALE", + "UPDATE", + "TERMINATE", + "HEAL" + ] + } + }, + "operationStates":{ + "description":"Match particular LCM operation state values as reported in notifications of type NsLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"Value | Description ------|------------ PROCESSING | The LCM operation is currently in execution. COMPLETED | The LCM operation has been completed successfully. PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action will not succeed. OLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the NS prior to the original operation invocation has been restored as closely as possible.\n", + "type":"string", + "enum":[ + "PROCESSING", + "COMPLETED", + "PARTIALLY_COMPLETED", + "FAILED_TEMP", + "FAILED", + "ROLLING_BACK", + "ROLLED_BACK" + ] + } + }, + "nsComponentTypes":{ + "description":"Match particular NS component types for the notification of type NsChangeNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsChang.\n", + "type":"array", + "items":{ + "description":"The enumeration NsComponentType represents the NS component type. It shall comply with the provisions defined in Table 6.5.4.5-1. Value | Description ------|------------ VNF | Represents the impacted NS component is a VNF. PNF | Represents the impacted NS component is a PNF. NS | Represents the impacted NS component is a nested NS.\n", + "type":"string", + "enum":[ + "VNF", + "PNF", + "NS" + ] + } + }, + "lcmOpNameImpactingNsComponent":{ + "description":"Match particular LCM operation names for the notification of type NsChangeNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsChangeNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"The enumeration LcmOpNameForChangeNotificationType represents the name of the lifecycle operation that impacts the NS component and trigger an NS change notification. It shall comply with the provisions defined in Table 6.5.4.6-1. Value | Description ------|------------ VNF_INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. VNF_SCALE | Represents the \"Scale VNF\" LCM operation. VNF_SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. VNF_CHANGE_FLAVOUR | Represents the \"Change VNF Flavor\" LCM operation. VNF_TERMINATE | Represents the \"Terminate VNF\" LCM operation. VNF_HEAL | Represents the \"Heal VNF\" LCM operation. VNF_OPERATE | Represents the \"Operate VNF\" LCM operation. VNF_CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. VNF_MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. NS_INSTANTIATE | Represents the \"Instantiate NS\" LCM operation NS_SCALE | Represents the \"Scale NS\" LCM operation. NS_UPDATE | Represents the \"Update NS\" LCM operation. NS_TERMINATE | Represents the \"Terminate NS\" LCM operation. NS_HEAL | Represents the \"Heal NS\" LCM operation.\n", + "type":"string", + "enum":[ + "VNF_INSTANTIATE", + "VNF_SCALE", + "VNF_SCALE_TO_LEVEL", + "VNF_CHANGE_FLAVOUR", + "VNF_TERMINATE", + "VNF_HEAL", + "VNF_OPERATE", + "VNF_CHANGE_EXT_CONN", + "VNF_MODIFY_INFO", + "NS_INSTANTIATE", + "NS_SCALE", + "NS_UPDATE", + "NS_TERMINATE", + "NS_HEAL" + ] + } + }, + "lcmOpOccStatusImpactingNsComponent":{ + "description":"Match particular LCM operation status values as reported in notifications of type NsChangeNotification. May be present if the \"notificationTypes\" attribute contains the value \"NsChangeNotification\", and shall be absent otherwise.\n", + "type":"array", + "items":{ + "description":"The enumeration LcmOpOccStatusForChangeNotificationType represents the status of the lifecycle management operation occurrence that impacts the NS component and triggers an NS change notification. It shall comply with the provisions defined in Table 6.5.4.7-1. Value | Description ------|------------ START | The impact on the NS component is identified. COMPLETED | The impact on the NS component stops and related lifecycle operation completes successfully. PARTIALLY_COMPLETED | The impact on the NS component stops and related lifecycle operation partially completes. Inconsistency state may exist on the NS component. FAILED | The impact on the NS component stops and related lifecycle operation fails. Inconsistency state may exist for the NS component. ROLLED_BACK | The impact on the NS component stops and related lifecycle operation is rolled back.\n", + "type":"string", + "enum":[ + "START", + "COMPLETED", + "PARTIALLY_COMPLETED", + "FAILED", + "ROLLED_BACK" + ] + } + } + } + }, + "callbackUri":{ + "description":"String formatted according to IETF RFC 3986.\n", + "type":"string", + "format":"uri" + }, + "_links":{ + "description":"Links to resources related to this resource.\n", + "type":"object", + "required":[ + "self" + ], + "properties":{ + "self":{ + "description":"This type represents a link to a resource.\n", + "type":"object", + "required":[ + "href" + ], + "properties":{ + "href":{ + "description":"URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n", + "type":"string", + "format":"url" + } + } + } + } + } + } + }, + "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.\n" + }, + "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.\n", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + }, + "delete":{ + "summary":"Terminate a 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 6.4.17.3.5-1 and 6.4.17.3.5-2. As the result of successfully executing this method, the \"Individual subscription\" resource shall not exist any longer. This means that no notifications for that subscription shall be sent to the formerly-subscribed API consumer. NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed API consumer for a certain time period after the deletion.\n", + "responses":{ + "204":{ + "description":"204 NO CONTENT\nShall be returned when the \"Individual subscription\" resource has been deleted successfully. The response body shall be empty.\n", + "headers":{ + "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.\n", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "406":{ + "description":"406 NOT ACCEPTABLE\nIf the \"Accept\" 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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + }, + "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.\n", + "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.\n", + "type":"string", + "maximum":1, + "minimum":0 + }, + "Version":{ + "description":"Version of the API used in the response.\n", + "type":"string", + "maximum":1, + "minimum":1 + } + }, + "schema":{ + "description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n", + "type":"object", + "required":[ + "status", + "detail" + ], + "properties":{ + "type":{ + "description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", + "type":"string", + "format":"URI" + }, + "title":{ + "description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type":"string" + }, + "status":{ + "description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type":"integer" + }, + "detail":{ + "description":"A human-readable explanation specific to this occurrence of the problem.\n", + "type":"string" + }, + "instance":{ + "description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type":"string", + "format":"URI" + } + } + } + } + } + } + } + } +}
\ No newline at end of file |