diff options
Diffstat (limited to 'so-etsi-nfvo')
124 files changed, 0 insertions, 37789 deletions
diff --git a/so-etsi-nfvo/pom.xml b/so-etsi-nfvo/pom.xml deleted file mode 100644 index 159426d2eb..0000000000 --- a/so-etsi-nfvo/pom.xml +++ /dev/null @@ -1,49 +0,0 @@ -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> - <modelVersion>4.0.0</modelVersion> - <parent> - <groupId>org.onap.so</groupId> - <artifactId>so</artifactId> - <version>1.8.0-SNAPSHOT</version> - </parent> - <groupId>org.onap.so.etsi.nfvo</groupId> - <artifactId>so-etsi-nfvo</artifactId> - <packaging>pom</packaging> - <name>SO ETSI NFVO</name> - - <properties> - <java.version>11</java.version> - <version.java.compiler>11</version.java.compiler> - <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> - <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> - <version-swagger-codegen>2.3.1</version-swagger-codegen> - <gson-fire-version>1.8.2</gson-fire-version> - <retrofit-version>2.3.0</retrofit-version> - <threetenbp-version>1.3.5</threetenbp-version> - <oltu-version>1.0.1</oltu-version> - <swagger-core-version>1.5.15</swagger-core-version> - <okhttp3-version>3.14.0</okhttp3-version> - <okhttp-version>2.7.5</okhttp-version> - <okio-version>1.13.0</okio-version> - <jaxb-api>2.3.0</jaxb-api> - <snakeyaml-version>0.11</snakeyaml-version> - <hamcrest-version>2.2</hamcrest-version> - <equalsverifier-version>3.4.1</equalsverifier-version> - </properties> - - <build> - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-compiler-plugin</artifactId> - <configuration> - <source>${version.java.compiler}</source> - <target>${version.java.compiler}</target> - </configuration> - </plugin> - </plugins> - </build> - <modules> - <module>so-etsi-nfvo-ns-lcm</module> - </modules> -</project>
\ No newline at end of file diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/pom.xml b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/pom.xml deleted file mode 100644 index 0d4a965c4d..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/pom.xml +++ /dev/null @@ -1,20 +0,0 @@ -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> - <modelVersion>4.0.0</modelVersion> - <parent> - <groupId>org.onap.so.etsi.nfvo</groupId> - <artifactId>so-etsi-nfvo</artifactId> - <version>1.8.0-SNAPSHOT</version> - </parent> - <artifactId>so-etsi-nfvo-ns-lcm</artifactId> - <packaging>pom</packaging> - <name>SO ETSI NFVO NS LCM Manager</name> - - <modules> - <module>so-etsi-nfvo-ns-lcm-api</module> - <module>so-etsi-nfvo-ns-lcm-database-service</module> - <module>so-etsi-nfvo-ns-lcm-bpmn-flows</module> - <module>so-etsi-nfvo-ns-lcm-service</module> - <module>so-etsi-nfvo-ns-lcm-application</module> - </modules> -</project>
\ No newline at end of file diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/pom.xml b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/pom.xml deleted file mode 100644 index 22304eadef..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/pom.xml +++ /dev/null @@ -1,174 +0,0 @@ -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> - <modelVersion>4.0.0</modelVersion> - <parent> - <groupId>org.onap.so.etsi.nfvo</groupId> - <artifactId>so-etsi-nfvo-ns-lcm</artifactId> - <version>1.8.0-SNAPSHOT</version> - </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/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/src/main/resources/SOL005-NSLifecycleManagement-API.json b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/src/main/resources/SOL005-NSLifecycleManagement-API.json deleted file mode 100644 index 8a7eb9d006..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-api/src/main/resources/SOL005-NSLifecycleManagement-API.json +++ /dev/null @@ -1,24383 +0,0 @@ -{ - "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 diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/pom.xml b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/pom.xml deleted file mode 100644 index 86850330a9..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/pom.xml +++ /dev/null @@ -1,66 +0,0 @@ -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> - <modelVersion>4.0.0</modelVersion> - <parent> - <groupId>org.onap.so.etsi.nfvo</groupId> - <artifactId>so-etsi-nfvo-ns-lcm</artifactId> - <version>1.8.0-SNAPSHOT</version> - </parent> - <artifactId>so-etsi-nfvo-ns-lcm-application</artifactId> - <name>SO ETSI NFVO NS LCM Application</name> - - - <build> - <finalName>${project.artifactId}-${project.version}</finalName> - <plugins> - <plugin> - <groupId>org.springframework.boot</groupId> - <artifactId>spring-boot-maven-plugin</artifactId> - <configuration> - <mainClass>org.onap.so.etsi.nfvo.ns.lcm.app.Application</mainClass> - </configuration> - <executions> - <execution> - <goals> - <goal>repackage</goal> - </goals> - </execution> - </executions> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-jar-plugin</artifactId> - <executions> - <execution> - <id>original</id> - </execution> - </executions> - </plugin> - <plugin> - <groupId>org.jacoco</groupId> - <artifactId>jacoco-maven-plugin</artifactId> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-surefire-plugin</artifactId> - <configuration> - <systemPropertyVariables> - <so.log.level>DEBUG</so.log.level> - </systemPropertyVariables> - <rerunFailingTestsCount>2</rerunFailingTestsCount> - <parallel>suites</parallel> - <useUnlimitedThreads>false</useUnlimitedThreads> - <threadCount>1</threadCount> - </configuration> - </plugin> - </plugins> - </build> - - <dependencies> - <dependency> - <groupId>org.onap.so.etsi.nfvo</groupId> - <artifactId>so-etsi-nfvo-ns-lcm-service</artifactId> - <version>${project.version}</version> - </dependency> - </dependencies> -</project>
\ No newline at end of file diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/app/Application.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/app/Application.java deleted file mode 100644 index 12f3bfc119..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/app/Application.java +++ /dev/null @@ -1,51 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.app; - -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.boot.SpringApplication; -import org.springframework.boot.autoconfigure.SpringBootApplication; -import org.springframework.context.annotation.ComponentScan; -import org.springframework.context.annotation.ComponentScan.Filter; -import org.springframework.context.annotation.FilterType; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@SpringBootApplication(scanBasePackages = {"org.onap.so"}) -@ComponentScan(basePackages = {"org.onap"}, nameGenerator = DefaultToShortClassNameBeanNameGenerator.class, - excludeFilters = {@Filter(type = FilterType.ANNOTATION, classes = SpringBootApplication.class)}) -public class Application { - private static final Logger logger = LoggerFactory.getLogger(Application.class); - - /** - * Entry point for the Spring boot application - * - * @param args arguments for the application - */ - public static void main(final String[] args) { - new SpringApplication(Application.class).run(args); - logger.info("SO ETSI NFVO NS LCM Application started!"); - - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/app/AsyncThreadExecutorConfiguration.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/app/AsyncThreadExecutorConfiguration.java deleted file mode 100644 index 4427e1ac2f..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/app/AsyncThreadExecutorConfiguration.java +++ /dev/null @@ -1,64 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.app; - -import static org.slf4j.LoggerFactory.getLogger; -import java.util.concurrent.Executor; -import org.slf4j.Logger; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.context.annotation.Primary; -import org.springframework.scheduling.annotation.EnableAsync; -import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Configuration -@EnableAsync -public class AsyncThreadExecutorConfiguration { - private static final Logger logger = getLogger(AsyncThreadExecutorConfiguration.class); - - @Value("${mso.async.core-pool-size:20}") - private int corePoolSize; - - @Value("${mso.async.max-pool-size:30}") - private int maxPoolSize; - - @Value("${mso.async.queue-capacity:50}") - private int queueCapacity; - - @Bean - @Primary - public Executor asyncExecutor() { - logger.info("Setting ThreadPoolTaskExecutor for async calls ..."); - final ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); - executor.setCorePoolSize(corePoolSize); - executor.setMaxPoolSize(maxPoolSize); - executor.setQueueCapacity(queueCapacity); - executor.setThreadNamePrefix("Async Process-"); - executor.initialize(); - return executor; - } - - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/app/DefaultToShortClassNameBeanNameGenerator.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/app/DefaultToShortClassNameBeanNameGenerator.java deleted file mode 100644 index 2546c9c23f..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/app/DefaultToShortClassNameBeanNameGenerator.java +++ /dev/null @@ -1,36 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.app; - -import org.springframework.beans.factory.config.BeanDefinition; -import org.springframework.context.annotation.AnnotationBeanNameGenerator; -import org.springframework.util.ClassUtils; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class DefaultToShortClassNameBeanNameGenerator extends AnnotationBeanNameGenerator { - - @Override - protected String buildDefaultBeanName(final BeanDefinition definition) { - return ClassUtils.getShortName(definition.getBeanClassName()); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/resources/application-aaf.yaml b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/resources/application-aaf.yaml deleted file mode 100644 index b2efde56c7..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/resources/application-aaf.yaml +++ /dev/null @@ -1,13 +0,0 @@ -# Copyright © 2020 Nordix Foundation -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License.
\ No newline at end of file diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/resources/application-basic.yaml b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/resources/application-basic.yaml deleted file mode 100644 index b2efde56c7..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/resources/application-basic.yaml +++ /dev/null @@ -1,13 +0,0 @@ -# Copyright © 2020 Nordix Foundation -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License.
\ No newline at end of file diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/resources/application.yaml b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/resources/application.yaml deleted file mode 100644 index 7f0fd93c8d..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-application/src/main/resources/application.yaml +++ /dev/null @@ -1,69 +0,0 @@ -# Copyright © 2020 Nordix Foundation -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -aai: - auth: 2A11B07DB6214A839394AA1EC5844695F5114FC407FF5422625FB00175A3DCB8A1FF745F22867EFA72D5369D599BBD88DA8BED4233CF5586 - version: v19 - endpoint: https://aai.onap:8443 -camunda: - bpm: - admin-user: - id: admin - password: admin - history-level: full - job-execution: - max-pool-size: 30 - core-pool-size: 3 -spring: - security: - usercredentials: - - username: so-etsi-nfvo-ns-lcm - password: $2a$10$Fh9ffgPw2vnmsghsRD3ZauBL1aKXebigbq3BB1RPWtE62UDILsjke - role: BPEL-Client - http: - converters: - preferred-json-mapper: gson - main: - allow-bean-definition-overriding: true - datasource: - hikari: - camunda: - jdbcUrl: jdbc:mariadb://${DB_HOST}:${DB_PORT}/camundabpmn - username: ${DB_USERNAME} - password: ${DB_PASSWORD} - driver-class-name: org.mariadb.jdbc.Driver - pool-name: bpmn-pool - registerMbeans: true - nfvo: - jdbcUrl: jdbc:mariadb://${DB_HOST}:${DB_PORT}/nfvo - username: ${NFVO_USERNAME} - password: ${NFVO_PASSWORD} - driver-class-name: org.mariadb.jdbc.Driver - pool-name: nfvo-pool - registerMbeans: true -server: - port: 9095 - tomcat: - max-threads: 50 -mso: - key: 07a7159d3bf51a0e53be7a8f89699be7 -so: - adapters: - sol003-adapter: - url: https://so-vnfm-adapter.onap:9092/so/vnfm-adapter/v1 - auth: Basic dm5mbTpwYXNzd29yZDEk -etsi-catalog-manager: - base: - endpoint: http://modeling-etsicatalog.onap:8806/api -so-etsi-nfvo-ns-lcm: - endpoint: http://so-etsi-nfvo-ns-lcm.onap:9095
\ No newline at end of file diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/pom.xml b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/pom.xml deleted file mode 100644 index 0160a523ea..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/pom.xml +++ /dev/null @@ -1,117 +0,0 @@ -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> - <modelVersion>4.0.0</modelVersion> - <parent> - <groupId>org.onap.so.etsi.nfvo</groupId> - <artifactId>so-etsi-nfvo-ns-lcm</artifactId> - <version>1.8.0-SNAPSHOT</version> - </parent> - <artifactId>so-etsi-nfvo-ns-lcm-bpmn-flows</artifactId> - <name>SO ETSI NFVO NS LCM BPMN Flows</name> - - <build> - <plugins> - <plugin> - <groupId>org.jacoco</groupId> - <artifactId>jacoco-maven-plugin</artifactId> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-surefire-plugin</artifactId> - <configuration> - <systemPropertyVariables> - <so.log.level>DEBUG</so.log.level> - </systemPropertyVariables> - <rerunFailingTestsCount>2</rerunFailingTestsCount> - <parallel>suites</parallel> - <useUnlimitedThreads>false</useUnlimitedThreads> - <threadCount>1</threadCount> - </configuration> - </plugin> - </plugins> - </build> - - <dependencies> - <dependency> - <groupId>org.onap.so.etsi.nfvo</groupId> - <artifactId>so-etsi-nfvo-ns-lcm-api</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> - <groupId>org.onap.so.etsi.nfvo</groupId> - <artifactId>so-etsi-nfvo-ns-lcm-database-service</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> - <groupId>org.onap.so.adapters</groupId> - <artifactId>etsi-sol003-pkgm-ext-clients</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> - <groupId>org.onap.so.adapters</groupId> - <artifactId>etsi-sol003-lcm-api</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> - <groupId>org.onap.so</groupId> - <artifactId>aai-client</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> - <groupId>org.camunda.bpm.springboot</groupId> - <artifactId>camunda-bpm-spring-boot-starter-rest</artifactId> - <version>${camunda.springboot.version}</version> - <exclusions> - <exclusion> - <groupId>org.camunda.bpmn</groupId> - <artifactId>camunda-engine-rest-core</artifactId> - </exclusion> - </exclusions> - </dependency> - <dependency> - <groupId>org.yaml</groupId> - <artifactId>snakeyaml</artifactId> - </dependency> - <dependency> - <groupId>com.shazam</groupId> - <artifactId>shazamcrest</artifactId> - <version>${snakeyaml-version}</version> - <exclusions> - <exclusion> - <groupId>com.google.guava</groupId> - <artifactId>guava</artifactId> - </exclusion> - <exclusion> - <groupId>org.apache.commons</groupId> - <artifactId>commons-lang3</artifactId> - </exclusion> - <exclusion> - <groupId>com.vaadin.external.google</groupId> - <artifactId>android-json</artifactId> - </exclusion> - </exclusions> - </dependency> - <dependency> - <groupId>com.h2database</groupId> - <artifactId>h2</artifactId> - <scope>test</scope> - </dependency> - <dependency> - <groupId>org.hamcrest</groupId> - <artifactId>hamcrest</artifactId> - <version>${hamcrest-version}</version> - <scope>test</scope> - </dependency> - <dependency> - <groupId>nl.jqno.equalsverifier</groupId> - <artifactId>equalsverifier</artifactId> - <version>${equalsverifier-version}</version> - <scope>test</scope> - </dependency> - <dependency> - <groupId>org.springframework.boot</groupId> - <artifactId>spring-boot-starter-test</artifactId> - <scope>test</scope> - </dependency> - </dependencies> -</project>
\ No newline at end of file diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/CamundaCustomConfiguration.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/CamundaCustomConfiguration.java deleted file mode 100644 index 33923f400e..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/CamundaCustomConfiguration.java +++ /dev/null @@ -1,49 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows; - -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.Constants.NS_WORKFLOW_ENGINE; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.Constants.TENANT_ID; -import static org.slf4j.LoggerFactory.getLogger; -import org.camunda.bpm.engine.spring.SpringProcessEngineConfiguration; -import org.camunda.bpm.spring.boot.starter.configuration.Ordering; -import org.camunda.bpm.spring.boot.starter.configuration.impl.AbstractCamundaConfiguration; -import org.slf4j.Logger; -import org.springframework.core.annotation.Order; -import org.springframework.stereotype.Component; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Component -@Order(Ordering.DEFAULT_ORDER + 1) -public class CamundaCustomConfiguration extends AbstractCamundaConfiguration { - private static final Logger logger = getLogger(CamundaCustomConfiguration.class); - - @Override - public void preInit(final SpringProcessEngineConfiguration processEngineConfiguration) { - logger.info("Setting DeploymentTenantId to {} and DeploymentName to {}", TENANT_ID, NS_WORKFLOW_ENGINE); - processEngineConfiguration.setDeploymentTenantId(TENANT_ID); - processEngineConfiguration.setDeploymentName(NS_WORKFLOW_ENGINE); - super.preInit(processEngineConfiguration); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/CamundaDatabaseConfiguration.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/CamundaDatabaseConfiguration.java deleted file mode 100644 index 770e91c1cb..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/CamundaDatabaseConfiguration.java +++ /dev/null @@ -1,92 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows; - - -import static org.slf4j.LoggerFactory.getLogger; -import javax.sql.DataSource; -import org.camunda.bpm.engine.spring.SpringProcessEngineConfiguration; -import org.camunda.bpm.spring.boot.starter.util.SpringBootProcessEnginePlugin; -import org.slf4j.Logger; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.boot.context.properties.ConfigurationProperties; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.jdbc.datasource.DataSourceTransactionManager; -import org.springframework.jmx.export.MBeanExporter; -import org.springframework.transaction.PlatformTransactionManager; -import org.springframework.transaction.annotation.EnableTransactionManagement; -import com.zaxxer.hikari.HikariConfig; -import com.zaxxer.hikari.HikariDataSource; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Configuration -@EnableTransactionManagement -public class CamundaDatabaseConfiguration { - - private static final String CAMUNDA_TRANSACTION_MANAGER_BEAN_NAME = "camundaTransactionManager"; - - private static final String CAMUNDA_DATA_SOURCE_BEAN_NAME = "camundaBpmDataSource"; - - private static final Logger logger = getLogger(CamundaDatabaseConfiguration.class); - - @Autowired(required = false) - private MBeanExporter mBeanExporter; - - @Bean - @ConfigurationProperties(prefix = "spring.datasource.hikari.camunda") - public HikariConfig camundaDbConfig() { - logger.debug("Creating Camunda HikariConfig bean ... "); - return new HikariConfig(); - } - - @Bean(name = CAMUNDA_DATA_SOURCE_BEAN_NAME) - public DataSource camundaDataSource() { - if (mBeanExporter != null) { - mBeanExporter.addExcludedBean(CAMUNDA_DATA_SOURCE_BEAN_NAME); - } - logger.debug("Creating Camunda HikariDataSource bean ... "); - final HikariConfig hikariConfig = this.camundaDbConfig(); - return new HikariDataSource(hikariConfig); - } - - @Bean(name = CAMUNDA_TRANSACTION_MANAGER_BEAN_NAME) - public PlatformTransactionManager camundaTransactionManager( - @Qualifier(CAMUNDA_DATA_SOURCE_BEAN_NAME) final DataSource dataSource) { - return new DataSourceTransactionManager(dataSource); - } - - @Bean - public SpringBootProcessEnginePlugin transactionManagerProcessEnginePlugin( - @Qualifier(CAMUNDA_TRANSACTION_MANAGER_BEAN_NAME) final PlatformTransactionManager camundaTransactionManager) { - return new SpringBootProcessEnginePlugin() { - @Override - public void preInit(final SpringProcessEngineConfiguration processEngineConfiguration) { - logger.info("Setting Camunda TransactionManager ..."); - processEngineConfiguration.setTransactionManager(camundaTransactionManager); - - } - }; - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/CamundaVariableNameConstants.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/CamundaVariableNameConstants.java deleted file mode 100644 index a7acc3ec25..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/CamundaVariableNameConstants.java +++ /dev/null @@ -1,55 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class CamundaVariableNameConstants { - - public static final String JOB_ID_PARAM_NAME = "jobId"; - public static final String JOB_BUSINESS_KEY_PARAM_NAME = "jobBusinessKey"; - public static final String CREATE_NS_REQUEST_PARAM_NAME = "createNsRequest"; - public static final String GLOBAL_CUSTOMER_ID_PARAM_NAME = "globalCustomerId"; - public static final String SERVICE_TYPE_PARAM_NAME = "serviceType"; - - public static final String NS_PACKAGE_MODEL_PARAM_NAME = "NSPackageModel"; - public static final String NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME = "NsWorkflowProcessingException"; - public static final String CREATE_NS_RESPONSE_PARAM_NAME = "createNsResponse"; - - public static final String INSTANTIATE_NS_REQUEST_PARAM_NAME = "instantiateNsRequest"; - public static final String OCC_ID_PARAM_NAME = "occId"; - public static final String NS_INSTANCE_ID_PARAM_NAME = "NsInstanceId"; - public static final String NETWORK_SERVICE_DESCRIPTOR_PARAM_NAME = "NetworkServiceDescriptor"; - public static final String VNF_CREATE_INSTANTIATE_REQUESTS = "vnfCreateInstantiateRequests"; - - public static final String NF_INST_ID_PARAM_NAME = "NF_INST_ID"; - public static final String CREATE_VNF_RESPONSE_PARAM_NAME = "createVnfResponse"; - public static final String OPERATION_STATUS_PARAM_NAME = "operationStatus"; - - public static final String TERMINATE_NS_REQUEST_PARAM_NAME = "terminateNsRequest"; - public static final String NFVO_NF_INST_IDS_PARAM_NAME = "nfvoNfInstIds"; - public static final String DELETE_VNF_RESPONSE_PARAM_NAME = "deleteVnfResponse"; - public static final String TERMINATE_VNF_VNFID_PARAM_NAME = "vnfId"; - - private CamundaVariableNameConstants() {} - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/Constants.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/Constants.java deleted file mode 100644 index c6c56c9eb3..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/Constants.java +++ /dev/null @@ -1,39 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class Constants { - - public static final String TENANT_ID = "ns-workflow-engine-tenant"; - public static final String NS_WORKFLOW_ENGINE = "NS-WORKFLOW-ENGINE"; - public static final String CREATE_NS_WORKFLOW_NAME = "CreateNs"; - public static final String INSTANTIATE_NS_WORKFLOW_NAME = "InstantiateNs"; - public static final String TERMINATE_NS_WORKFLOW_NAME = "TerminateNs"; - public static final String DELETE_NS_WORKFLOW_NAME = "DeleteNs"; - public static final String GET_NS_OCCURRENCE_OPERATION_STATUS_NAME = "GetNsOccurrenceOperationStatus"; - - - private Constants() {} - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/GsonProvider.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/GsonProvider.java deleted file mode 100644 index 31961d5b86..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/GsonProvider.java +++ /dev/null @@ -1,44 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows; - -import java.time.LocalDateTime; -import org.onap.so.etsi.nfvo.ns.lcm.JSON; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.utils.LocalDateTimeTypeAdapter; -import org.springframework.stereotype.Component; -import org.threeten.bp.OffsetDateTime; -import com.google.gson.Gson; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Component -public class GsonProvider { - - private final JSON.OffsetDateTimeTypeAdapter offsetDateTimeTypeAdapter = new JSON.OffsetDateTimeTypeAdapter(); - - public Gson getGson() { - return JSON.createGson().registerTypeAdapter(OffsetDateTime.class, offsetDateTimeTypeAdapter) - .registerTypeAdapter(LocalDateTime.class, new LocalDateTimeTypeAdapter()).create(); - } - - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/exceptions/EtsiCatalogManagerRequestFailureException.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/exceptions/EtsiCatalogManagerRequestFailureException.java deleted file mode 100644 index 553d2f1cf8..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/exceptions/EtsiCatalogManagerRequestFailureException.java +++ /dev/null @@ -1,41 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.exceptions; - -import org.springframework.http.HttpStatus; -import org.springframework.web.bind.annotation.ResponseStatus; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@ResponseStatus(code = HttpStatus.INTERNAL_SERVER_ERROR) -public class EtsiCatalogManagerRequestFailureException extends RuntimeException { - - private static final long serialVersionUID = 66862444537194516L; - - public EtsiCatalogManagerRequestFailureException(final String message) { - super(message); - } - - public EtsiCatalogManagerRequestFailureException(final String message, final Throwable cause) { - super(message, cause); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/exceptions/NsRequestProcessingException.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/exceptions/NsRequestProcessingException.java deleted file mode 100644 index 0901f077d2..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/exceptions/NsRequestProcessingException.java +++ /dev/null @@ -1,54 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.exceptions; - -import org.onap.so.etsi.nfvo.ns.lcm.model.InlineResponse400; -import org.springframework.http.HttpStatus; -import org.springframework.web.bind.annotation.ResponseStatus; - -/** - * - * @author Waqas Ikram (waqas.ikram@est.tech) - */ -@ResponseStatus(code = HttpStatus.INTERNAL_SERVER_ERROR) -public class NsRequestProcessingException extends RuntimeException { - - private static final long serialVersionUID = 66862444537194516L; - private final InlineResponse400 problemDetails; - - public NsRequestProcessingException(final String message) { - super(message); - problemDetails = null; - } - - public NsRequestProcessingException(final String message, final InlineResponse400 problemDetails) { - super(message); - this.problemDetails = problemDetails; - } - - @Override - public synchronized Throwable fillInStackTrace() { - return this; - } - - public InlineResponse400 getProblemDetails() { - return problemDetails; - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/aai/AaiClientProvider.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/aai/AaiClientProvider.java deleted file mode 100644 index 673662aae8..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/aai/AaiClientProvider.java +++ /dev/null @@ -1,34 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.aai; - -import org.onap.aaiclient.client.aai.AAIResourcesClient; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; - -@Configuration -public class AaiClientProvider { - - @Bean - public AAIResourcesClient getAaiClient() { - return new AAIResourcesClient(); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/aai/AaiPropertiesImpl.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/aai/AaiPropertiesImpl.java deleted file mode 100644 index 25a43a86d0..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/aai/AaiPropertiesImpl.java +++ /dev/null @@ -1,109 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.aai; - -import org.onap.aaiclient.client.aai.AAIProperties; -import org.onap.aaiclient.client.aai.AAIVersion; -import org.onap.so.client.CacheProperties; -import org.onap.so.spring.SpringContextHelper; -import org.springframework.context.ApplicationContext; -import java.net.MalformedURLException; -import java.net.URL; - -public class AaiPropertiesImpl implements AAIProperties { - - private final String endpoint; - private final String encryptedBasicAuth; - private final String encryptionKey; - private final String aaiVersion; - private final Long readTimeout; - private final Long connectionTimeout; - private final boolean enableCaching; - private final Long cacheMaxAge; - - public AaiPropertiesImpl() { - final ApplicationContext context = SpringContextHelper.getAppContext(); - this.endpoint = context.getEnvironment().getProperty("aai.endpoint"); - this.encryptedBasicAuth = context.getEnvironment().getProperty("aai.auth"); - this.encryptionKey = context.getEnvironment().getProperty("mso.key"); - this.aaiVersion = context.getEnvironment().getProperty("aai.version"); - this.readTimeout = context.getEnvironment().getProperty("aai.readTimeout", Long.class, 60000L); - this.connectionTimeout = context.getEnvironment().getProperty("aai.connectionTimeout", Long.class, 60000L); - this.enableCaching = context.getEnvironment().getProperty("aai.caching.enabled", Boolean.class, false); - this.cacheMaxAge = context.getEnvironment().getProperty("aai.caching.maxAge", Long.class, 60000L); - } - - @Override - public URL getEndpoint() throws MalformedURLException { - return new URL(endpoint); - } - - @Override - public String getSystemName() { - return "MSO"; - } - - @Override - public AAIVersion getDefaultVersion() { - for (final AAIVersion version : AAIVersion.values()) { - if (version.toString().equalsIgnoreCase(this.aaiVersion)) { - return version; - } ; - - } - return AAIVersion.LATEST; - } - - @Override - public String getAuth() { - return encryptedBasicAuth; - } - - @Override - public String getKey() { - return encryptionKey; - } - - @Override - public Long getReadTimeout() { - return this.readTimeout; - } - - @Override - public Long getConnectionTimeout() { - return this.connectionTimeout; - } - - @Override - public boolean isCachingEnabled() { - return this.enableCaching; - } - - @Override - public CacheProperties getCacheProperties() { - return new AAICacheProperties() { - @Override - public Long getMaxAge() { - return cacheMaxAge; - } - }; - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/aai/AaiServiceProvider.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/aai/AaiServiceProvider.java deleted file mode 100644 index a54a6f41f9..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/aai/AaiServiceProvider.java +++ /dev/null @@ -1,47 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.aai; - -import org.onap.aai.domain.yang.GenericVnf; -import org.onap.aai.domain.yang.ServiceInstance; -import java.util.Optional; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public interface AaiServiceProvider { - - void createServiceInstance(final String globalCustomerId, final String serviceType, - final ServiceInstance aaiServiceInstance); - - void createGenericVnfAndConnectServiceInstance(final String serviceInstanceId, final String vnfId, - final GenericVnf genericVnf); - - void connectGenericVnfToTenant(final String vnfId, final String cloudOwner, final String cloudRegion, - final String tenantId); - - Optional<GenericVnf> getGenericVnf(final String vnfId); - - void deleteGenericVnf(final String vnfId); - - void deleteServiceInstance(final String globalCustomerId, final String serviceType, final String serviceInstanceId); -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/aai/AaiServiceProviderImpl.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/aai/AaiServiceProviderImpl.java deleted file mode 100644 index a3b3fa9d66..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/aai/AaiServiceProviderImpl.java +++ /dev/null @@ -1,106 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.aai; - -import java.util.Optional; -import org.onap.aai.domain.yang.GenericVnf; -import org.onap.aai.domain.yang.ServiceInstance; -import org.onap.aaiclient.client.aai.entities.uri.AAIResourceUri; -import org.onap.aaiclient.client.aai.entities.uri.AAIUriFactory; -import org.onap.aaiclient.client.generated.fluentbuilders.AAIFluentTypeBuilder; -import org.onap.aaiclient.client.generated.fluentbuilders.AAIFluentTypeBuilder.Types; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Service; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - */ -@Service -public class AaiServiceProviderImpl implements AaiServiceProvider { - private static final Logger logger = LoggerFactory.getLogger(AaiServiceProviderImpl.class); - private final AaiClientProvider aaiClientProvider; - - @Autowired - public AaiServiceProviderImpl(final AaiClientProvider aaiClientProvider) { - this.aaiClientProvider = aaiClientProvider; - } - - @Override - public void createServiceInstance(final String globalCustomerId, final String serviceType, - final ServiceInstance aaiServiceInstance) { - logger.info("Creating service instance in AAI: {}", aaiServiceInstance); - final AAIResourceUri serviceInstanceURI = - AAIUriFactory.createResourceUri(AAIFluentTypeBuilder.business().customer(globalCustomerId) - .serviceSubscription(serviceType).serviceInstance(aaiServiceInstance.getServiceInstanceId())); - aaiClientProvider.getAaiClient().createIfNotExists(serviceInstanceURI, Optional.of(aaiServiceInstance)); - - } - - @Override - public void createGenericVnfAndConnectServiceInstance(final String serviceInstanceId, final String vnfId, - final GenericVnf genericVnf) { - logger.info("Creating GenericVnf in AAI: {}", genericVnf); - final AAIResourceUri genericVnfURI = - AAIUriFactory.createResourceUri(AAIFluentTypeBuilder.network().genericVnf(vnfId)); - final AAIResourceUri serviceInstanceURI = - AAIUriFactory.createResourceUri(Types.SERVICE_INSTANCE.getFragment(serviceInstanceId)); - aaiClientProvider.getAaiClient().createIfNotExists(genericVnfURI, Optional.of(genericVnf)) - .connect(genericVnfURI, serviceInstanceURI); - - } - - @Override - public void connectGenericVnfToTenant(final String vnfId, final String cloudOwner, final String cloudRegion, - final String tenantId) { - logger.info("Connecting GenericVnf {} to {}/{}/{} in AAI", vnfId, cloudOwner, cloudRegion, tenantId); - final AAIResourceUri tenantURI = AAIUriFactory.createResourceUri( - AAIFluentTypeBuilder.cloudInfrastructure().cloudRegion(cloudOwner, cloudRegion).tenant(tenantId)); - final AAIResourceUri genericVnfURI = - AAIUriFactory.createResourceUri(AAIFluentTypeBuilder.network().genericVnf(vnfId)); - aaiClientProvider.getAaiClient().connect(tenantURI, genericVnfURI); - } - - @Override - public Optional<GenericVnf> getGenericVnf(final String vnfId) { - return aaiClientProvider.getAaiClient().get(GenericVnf.class, - AAIUriFactory.createResourceUri(AAIFluentTypeBuilder.network().genericVnf(vnfId))); - } - - @Override - public void deleteGenericVnf(final String vnfId) { - logger.info("Deleting GenericVnf with id: {} from AAI.", vnfId); - final AAIResourceUri aaiResourceUri = - AAIUriFactory.createResourceUri(AAIFluentTypeBuilder.network().genericVnf(vnfId)); - aaiClientProvider.getAaiClient().delete(aaiResourceUri); - } - - @Override - public void deleteServiceInstance(final String globalCustomerId, final String serviceType, - final String serviceInstanceId) { - logger.info( - "Deleting Service Instance with \nGlobal Customer Id: {}, \nService Type: {}, and \nService Instance Id: {} \nfrom AAI.", - globalCustomerId, serviceType, serviceInstanceId); - final AAIResourceUri serviceInstanceUri = AAIUriFactory.createResourceUri(AAIFluentTypeBuilder.business() - .customer(globalCustomerId).serviceSubscription(serviceType).serviceInstance(serviceInstanceId)); - aaiClientProvider.getAaiClient().delete(serviceInstanceUri); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/etsicatalog/EtsiCatalogPackageManagementServiceProvider.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/etsicatalog/EtsiCatalogPackageManagementServiceProvider.java deleted file mode 100644 index 65d982c6cc..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/etsicatalog/EtsiCatalogPackageManagementServiceProvider.java +++ /dev/null @@ -1,39 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.etsicatalog; - -import java.util.Optional; -import org.onap.so.adapters.etsisol003adapter.pkgm.extclients.etsicatalog.model.NsdInfo; -import org.onap.so.adapters.etsisol003adapter.pkgm.extclients.etsicatalog.model.VnfPkgInfo; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.NetworkServiceDescriptor; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public interface EtsiCatalogPackageManagementServiceProvider { - - Optional<NsdInfo> getNSPackageModel(final String nsdId); - - Optional<VnfPkgInfo> getVnfPkgInfo(final String vnfPkgId); - - Optional<NetworkServiceDescriptor> getNetworkServiceDescriptor(final String nsdId); - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/etsicatalog/EtsiCatalogPackageManagementServiceProviderImpl.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/etsicatalog/EtsiCatalogPackageManagementServiceProviderImpl.java deleted file mode 100644 index 749e85e3db..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/etsicatalog/EtsiCatalogPackageManagementServiceProviderImpl.java +++ /dev/null @@ -1,107 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.etsicatalog; - -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.etsicatalog.EtsiCatalogServiceProviderConfiguration.ETSI_CATALOG_SERVICE_PROVIDER_BEAN; -import java.util.Optional; -import org.onap.so.adapters.etsisol003adapter.pkgm.extclients.etsicatalog.model.NsdInfo; -import org.onap.so.adapters.etsisol003adapter.pkgm.extclients.etsicatalog.model.VnfPkgInfo; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.exceptions.EtsiCatalogManagerRequestFailureException; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.NetworkServiceDescriptor; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.parser.NetworkServiceDescriptorParser; -import org.onap.so.rest.service.HttpRestServiceProvider; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.http.ResponseEntity; -import org.springframework.stereotype.Service; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Service -public class EtsiCatalogPackageManagementServiceProviderImpl implements EtsiCatalogPackageManagementServiceProvider { - - private static final Logger logger = LoggerFactory.getLogger(EtsiCatalogPackageManagementServiceProviderImpl.class); - - private final HttpRestServiceProvider httpServiceProvider; - private final EtsiCatalogUrlProvider etsiCatalogUrlProvider; - private final NetworkServiceDescriptorParser networkServiceDescriptorParser; - - @Autowired - public EtsiCatalogPackageManagementServiceProviderImpl(final EtsiCatalogUrlProvider etsiCatalogUrlProvider, - @Qualifier(ETSI_CATALOG_SERVICE_PROVIDER_BEAN) final HttpRestServiceProvider httpServiceProvider, - final NetworkServiceDescriptorParser networkServiceDescriptorParser) { - this.etsiCatalogUrlProvider = etsiCatalogUrlProvider; - this.httpServiceProvider = httpServiceProvider; - this.networkServiceDescriptorParser = networkServiceDescriptorParser; - } - - @Override - public Optional<NsdInfo> getNSPackageModel(final String nsdId) { - try { - final ResponseEntity<NsdInfo> response = - httpServiceProvider.getHttpResponse(etsiCatalogUrlProvider.getNsPackageUrl(nsdId), NsdInfo.class); - if (response.getStatusCode().is2xxSuccessful()) { - return Optional.ofNullable(response.getBody()); - } - return Optional.empty(); - } catch (final Exception restProcessingException) { - final String message = "Caught exception while getting NS package model for: " + nsdId; - throw new EtsiCatalogManagerRequestFailureException(message, restProcessingException); - } - } - - @Override - public Optional<VnfPkgInfo> getVnfPkgInfo(final String vnfPkgId) { - try { - final ResponseEntity<VnfPkgInfo> response = httpServiceProvider - .getHttpResponse(etsiCatalogUrlProvider.getVnfPackageUrl(vnfPkgId), VnfPkgInfo.class); - if (response.getStatusCode().is2xxSuccessful()) { - return Optional.ofNullable(response.getBody()); - } - return Optional.empty(); - } catch (final Exception restProcessingException) { - final String message = "Caught exception while getting VNF package model for: " + vnfPkgId; - throw new EtsiCatalogManagerRequestFailureException(message, restProcessingException); - } - } - - @Override - public Optional<NetworkServiceDescriptor> getNetworkServiceDescriptor(final String nsdId) { - try { - final ResponseEntity<byte[]> response = httpServiceProvider - .getHttpResponse(etsiCatalogUrlProvider.getNsPackageContentUrl(nsdId), byte[].class); - if (response.getStatusCode().is2xxSuccessful()) { - if (response.hasBody()) { - return networkServiceDescriptorParser.parse(response.getBody()); - } - logger.error("Received response without body ..."); - } - return Optional.empty(); - } catch (final Exception restProcessingException) { - final String message = "Caught exception while getting NS package content for: " + nsdId; - throw new EtsiCatalogManagerRequestFailureException(message, restProcessingException); - } - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/etsicatalog/EtsiCatalogServiceProviderConfiguration.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/etsicatalog/EtsiCatalogServiceProviderConfiguration.java deleted file mode 100644 index 7adf87adf4..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/etsicatalog/EtsiCatalogServiceProviderConfiguration.java +++ /dev/null @@ -1,188 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.etsicatalog; - -import java.io.IOException; -import java.security.KeyManagementException; -import java.security.KeyStoreException; -import java.security.NoSuchAlgorithmException; -import java.security.cert.CertificateException; -import java.util.Iterator; -import java.util.concurrent.TimeUnit; -import javax.net.ssl.HostnameVerifier; -import javax.net.ssl.SSLContext; -import javax.net.ssl.SSLSession; -import org.apache.http.client.config.RequestConfig; -import org.apache.http.config.Registry; -import org.apache.http.config.RegistryBuilder; -import org.apache.http.conn.socket.ConnectionSocketFactory; -import org.apache.http.conn.socket.PlainConnectionSocketFactory; -import org.apache.http.conn.ssl.SSLConnectionSocketFactory; -import org.apache.http.impl.client.HttpClientBuilder; -import org.apache.http.impl.conn.PoolingHttpClientConnectionManager; -import org.apache.http.ssl.SSLContextBuilder; -import org.onap.logging.filter.spring.SpringClientPayloadFilter; -import org.onap.so.configuration.rest.BasicHttpHeadersProvider; -import org.onap.so.configuration.rest.HttpClientConnectionConfiguration; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.GsonProvider; -import org.onap.so.logging.jaxrs.filter.SOSpringClientFilter; -import org.onap.so.rest.service.HttpRestServiceProvider; -import org.onap.so.rest.service.HttpRestServiceProviderImpl; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.core.io.Resource; -import org.springframework.http.client.BufferingClientHttpRequestFactory; -import org.springframework.http.client.HttpComponentsClientHttpRequestFactory; -import org.springframework.http.converter.HttpMessageConverter; -import org.springframework.http.converter.json.GsonHttpMessageConverter; -import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter; -import org.springframework.web.client.RestTemplate; - -/** - * Configures the HttpRestServiceProvider to make REST calls to the ETSI Catalog Manager - * - * @author gareth.roper@est.tech - */ - -@Configuration -public class EtsiCatalogServiceProviderConfiguration { - private static final Logger LOGGER = LoggerFactory.getLogger(EtsiCatalogServiceProviderConfiguration.class); - - public static final String ETSI_CATALOG_SERVICE_PROVIDER_BEAN = "etsiCatalogServiceProvider"; - - public static final String ETSI_CATALOG_REST_TEMPLATE_BEAN = "etsiCatalogRestTemplate"; - - private final HttpClientConnectionConfiguration clientConnectionConfiguration; - - @Value("${etsi-catalog-manager.http.client.ssl.trust-store:#{null}}") - private Resource trustStore; - @Value("${etsi-catalog-manager.http.client.ssl.trust-store-password:#{null}}") - private String trustStorePassword; - - private final GsonProvider gsonProvider; - - @Autowired - public EtsiCatalogServiceProviderConfiguration( - final HttpClientConnectionConfiguration clientConnectionConfiguration, final GsonProvider gsonProvider) { - this.clientConnectionConfiguration = clientConnectionConfiguration; - this.gsonProvider = gsonProvider; - } - - @Bean - @Qualifier(ETSI_CATALOG_REST_TEMPLATE_BEAN) - public RestTemplate etsiCatalogRestTemplate() { - final RestTemplate restTemplate = new RestTemplate(); - restTemplate.getInterceptors().add(new SOSpringClientFilter()); - restTemplate.getInterceptors().add((new SpringClientPayloadFilter())); - return restTemplate; - } - - @Bean - @Qualifier(ETSI_CATALOG_SERVICE_PROVIDER_BEAN) - public HttpRestServiceProvider etsiCatalogHttpRestServiceProvider( - @Qualifier(ETSI_CATALOG_REST_TEMPLATE_BEAN) final RestTemplate restTemplate) { - setGsonMessageConverter(restTemplate); - - final HttpClientBuilder httpClientBuilder = getHttpClientBuilder(); - if (trustStore != null) { - try { - LOGGER.debug("Setting up HttpComponentsClientHttpRequestFactory with SSL Context"); - LOGGER.debug("Setting client trust-store: {}", trustStore.getURL()); - LOGGER.debug("Creating SSLConnectionSocketFactory with AllowAllHostsVerifier ... "); - final SSLContext sslContext = new SSLContextBuilder() - .loadTrustMaterial(trustStore.getURL(), trustStorePassword.toCharArray()).build(); - final SSLConnectionSocketFactory sslConnectionSocketFactory = - new SSLConnectionSocketFactory(sslContext, AllowAllHostsVerifier.INSTANCE); - httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory); - final Registry<ConnectionSocketFactory> socketFactoryRegistry = RegistryBuilder - .<ConnectionSocketFactory>create().register("http", PlainConnectionSocketFactory.INSTANCE) - .register("https", sslConnectionSocketFactory).build(); - - httpClientBuilder.setConnectionManager(getConnectionManager(socketFactoryRegistry)); - } catch (final KeyManagementException | NoSuchAlgorithmException | KeyStoreException | CertificateException - | IOException exception) { - LOGGER.error("Error reading truststore, TLS connection will fail.", exception); - } - - } else { - LOGGER.debug("Setting connection manager without SSL ConnectionSocketFactory ..."); - httpClientBuilder.setConnectionManager(getConnectionManager()); - } - - final HttpComponentsClientHttpRequestFactory factory = - new HttpComponentsClientHttpRequestFactory(httpClientBuilder.build()); - restTemplate.setRequestFactory(new BufferingClientHttpRequestFactory(factory)); - - return new HttpRestServiceProviderImpl(restTemplate, new BasicHttpHeadersProvider().getHttpHeaders()); - } - - private PoolingHttpClientConnectionManager getConnectionManager( - final Registry<ConnectionSocketFactory> socketFactoryRegistry) { - return new PoolingHttpClientConnectionManager(socketFactoryRegistry, null, null, null, - clientConnectionConfiguration.getTimeToLiveInMins(), TimeUnit.MINUTES); - } - - private PoolingHttpClientConnectionManager getConnectionManager() { - return new PoolingHttpClientConnectionManager(clientConnectionConfiguration.getTimeToLiveInMins(), - TimeUnit.MINUTES); - } - - private HttpClientBuilder getHttpClientBuilder() { - return HttpClientBuilder.create().setMaxConnPerRoute(clientConnectionConfiguration.getMaxConnectionsPerRoute()) - .setMaxConnTotal(clientConnectionConfiguration.getMaxConnections()) - .setDefaultRequestConfig(getRequestConfig()); - } - - private RequestConfig getRequestConfig() { - return RequestConfig.custom().setSocketTimeout(clientConnectionConfiguration.getSocketTimeOutInMiliSeconds()) - .setConnectTimeout(clientConnectionConfiguration.getConnectionTimeOutInMilliSeconds()).build(); - } - - private static final class AllowAllHostsVerifier implements HostnameVerifier { - - private static final AllowAllHostsVerifier INSTANCE = new AllowAllHostsVerifier(); - - @Override - public boolean verify(final String hostname, final SSLSession session) { - LOGGER.debug("Skipping hostname verification ..."); - return true; - } - - } - - public void setGsonMessageConverter(final RestTemplate restTemplate) { - final Iterator<HttpMessageConverter<?>> iterator = restTemplate.getMessageConverters().iterator(); - while (iterator.hasNext()) { - if (iterator.next() instanceof MappingJackson2HttpMessageConverter) { - iterator.remove(); - } - } - restTemplate.getMessageConverters().add(new GsonHttpMessageConverter(gsonProvider.getGson())); - } - - - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/etsicatalog/EtsiCatalogUrlProvider.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/etsicatalog/EtsiCatalogUrlProvider.java deleted file mode 100644 index 54f6ad6543..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/etsicatalog/EtsiCatalogUrlProvider.java +++ /dev/null @@ -1,49 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.etsicatalog; - -import org.springframework.beans.factory.annotation.Value; -import org.springframework.stereotype.Service; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Service -public class EtsiCatalogUrlProvider { - - @Value("${etsi-catalog-manager.base.endpoint}") - private String etsiCatalogManagerEndpoint; - - public String getNsPackageUrl(final String nsdId) { - return etsiCatalogManagerEndpoint + "/nsd/v1/ns_descriptors/" + nsdId; - } - - public String getNsPackageContentUrl(final String nsdId) { - return etsiCatalogManagerEndpoint + "/nsd/v1/ns_descriptors/" + nsdId + "/nsd_content"; - } - - public String getVnfPackageUrl(final String vnfPkgId) { - return etsiCatalogManagerEndpoint + "/vnfpkgm/v1/vnf_packages/" + vnfPkgId; - } - - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/vnfm/Sol003AdapterConfiguration.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/vnfm/Sol003AdapterConfiguration.java deleted file mode 100644 index 6776d8ba0b..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/vnfm/Sol003AdapterConfiguration.java +++ /dev/null @@ -1,148 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.vnfm; - -import java.io.IOException; -import java.security.KeyManagementException; -import java.security.KeyStoreException; -import java.security.NoSuchAlgorithmException; -import java.security.cert.CertificateException; -import java.util.Iterator; -import javax.net.ssl.SSLContext; -import org.apache.http.client.HttpClient; -import org.apache.http.conn.ssl.SSLConnectionSocketFactory; -import org.apache.http.impl.client.HttpClients; -import org.apache.http.ssl.SSLContextBuilder; -import org.onap.logging.filter.spring.SpringClientPayloadFilter; -import org.onap.so.configuration.rest.BasicHttpHeadersProvider; -import org.onap.so.configuration.rest.HttpComponentsClientConfiguration; -import org.onap.so.configuration.rest.HttpHeadersProvider; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.GsonProvider; -import org.onap.so.logging.jaxrs.filter.SOSpringClientFilter; -import org.onap.so.rest.service.HttpRestServiceProvider; -import org.onap.so.rest.service.HttpRestServiceProviderImpl; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.core.io.Resource; -import org.springframework.http.client.BufferingClientHttpRequestFactory; -import org.springframework.http.client.HttpComponentsClientHttpRequestFactory; -import org.springframework.http.converter.HttpMessageConverter; -import org.springframework.http.converter.json.GsonHttpMessageConverter; -import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter; -import org.springframework.web.client.RestTemplate; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Configuration -public class Sol003AdapterConfiguration { - - private static final Logger logger = LoggerFactory.getLogger(Sol003AdapterConfiguration.class); - - public static final String SOL003_ADAPTER_REST_TEMPLATE_BEAN = "Sol003AdapterRestTemplateBean"; - public static final String SOL003_ADAPTER_HTTP_REST_SERVICE_PROVIDER_BEAN = - "Sol003AdapterHttpRestServiceProviderBean"; - - @Value("${rest.http.client.configuration.ssl.trustStore:#{null}}") - private Resource trustStore; - - @Value("${rest.http.client.configuration.ssl.trustStorePassword:#{null}}") - private String trustStorePassword; - - @Value("${so.adapters.sol003-adapter.auth:Basic dm5mbTpwYXNzd29yZDEk}") - private String sol003AdapterBasicAuth; - - @Autowired - private GsonProvider gsonProvider; - - @Bean - @Qualifier(SOL003_ADAPTER_REST_TEMPLATE_BEAN) - public RestTemplate sol003AdapterRestTemplate( - @Autowired final HttpComponentsClientConfiguration httpComponentsClientConfiguration) { - - final HttpComponentsClientHttpRequestFactory clientHttpRequestFactory = - httpComponentsClientConfiguration.httpComponentsClientHttpRequestFactory(); - - final RestTemplate restTemplate = - new RestTemplate(new BufferingClientHttpRequestFactory(clientHttpRequestFactory)); - restTemplate.getInterceptors().add(new SOSpringClientFilter()); - restTemplate.getInterceptors().add((new SpringClientPayloadFilter())); - return restTemplate; - - } - - @Bean - @Qualifier(SOL003_ADAPTER_HTTP_REST_SERVICE_PROVIDER_BEAN) - public HttpRestServiceProvider sol003AdapaterHttpRestServiceProvider( - @Qualifier(SOL003_ADAPTER_REST_TEMPLATE_BEAN) @Autowired final RestTemplate restTemplate) { - - if (trustStore != null) { - setTrustStore(restTemplate); - } - setGsonMessageConverter(restTemplate); - return getHttpRestServiceProvider(restTemplate, new BasicHttpHeadersProvider(sol003AdapterBasicAuth)); - } - - private void setTrustStore(final RestTemplate restTemplate) { - try { - final SSLConnectionSocketFactory socketFactory = new SSLConnectionSocketFactory(getSSLContext()); - final HttpClient httpClient = HttpClients.custom().setSSLSocketFactory(socketFactory).build(); - final HttpComponentsClientHttpRequestFactory factory = - new HttpComponentsClientHttpRequestFactory(httpClient); - restTemplate.setRequestFactory(new BufferingClientHttpRequestFactory(factory)); - } catch (final Exception exception) { - logger.error("Error reading truststore, TLS connection to VNFM will fail.", exception); - } - } - - private SSLContext getSSLContext() throws KeyManagementException, NoSuchAlgorithmException, KeyStoreException, - CertificateException, IOException { - if (trustStore != null) { - logger.info("Setting truststore: {}", trustStore.getURL()); - return new SSLContextBuilder().loadTrustMaterial(trustStore.getURL(), trustStorePassword.toCharArray()) - .build(); - } - logger.info("Setting Default SSL ..."); - return SSLContext.getDefault(); - - } - - private HttpRestServiceProvider getHttpRestServiceProvider(final RestTemplate restTemplate, - final HttpHeadersProvider httpHeadersProvider) { - return new HttpRestServiceProviderImpl(restTemplate, httpHeadersProvider.getHttpHeaders()); - } - - private void setGsonMessageConverter(final RestTemplate restTemplate) { - final Iterator<HttpMessageConverter<?>> iterator = restTemplate.getMessageConverters().iterator(); - while (iterator.hasNext()) { - if (iterator.next() instanceof MappingJackson2HttpMessageConverter) { - iterator.remove(); - } - } - restTemplate.getMessageConverters().add(new GsonHttpMessageConverter(gsonProvider.getGson())); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/vnfm/Sol003AdapterServiceProvider.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/vnfm/Sol003AdapterServiceProvider.java deleted file mode 100644 index 4f98e2c267..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/vnfm/Sol003AdapterServiceProvider.java +++ /dev/null @@ -1,37 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.vnfm; - -import java.util.Optional; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.CreateVnfRequest; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.CreateVnfResponse; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.DeleteVnfResponse; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.QueryJobResponse; - -public interface Sol003AdapterServiceProvider { - - Optional<CreateVnfResponse> invokeCreateInstantiationRequest(final String vnfId, final CreateVnfRequest request); - - Optional<QueryJobResponse> getInstantiateOperationJobStatus(final String jobId); - - Optional<DeleteVnfResponse> invokeTerminationRequest(final String vnfId); - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/vnfm/Sol003AdapterServiceProviderImpl.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/vnfm/Sol003AdapterServiceProviderImpl.java deleted file mode 100644 index df3a0c2e31..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/vnfm/Sol003AdapterServiceProviderImpl.java +++ /dev/null @@ -1,150 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.vnfm; - -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.vnfm.Sol003AdapterConfiguration.SOL003_ADAPTER_HTTP_REST_SERVICE_PROVIDER_BEAN; -import java.util.Optional; -import org.apache.commons.lang3.StringUtils; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.CreateVnfRequest; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.CreateVnfResponse; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.DeleteVnfResponse; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.QueryJobResponse; -import org.onap.so.rest.exceptions.HttpResouceNotFoundException; -import org.onap.so.rest.exceptions.InvalidRestRequestException; -import org.onap.so.rest.exceptions.RestProcessingException; -import org.onap.so.rest.service.HttpRestServiceProvider; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.http.HttpStatus; -import org.springframework.http.ResponseEntity; -import org.springframework.stereotype.Service; - -@Service -public class Sol003AdapterServiceProviderImpl implements Sol003AdapterServiceProvider { - - private static final Logger LOGGER = LoggerFactory.getLogger(Sol003AdapterServiceProviderImpl.class); - public static final String RECEIVED_RESPONSE_WITHOUT_BODY = "Received response without body: {}"; - - private final Sol003AdapterUrlProvider urlProvider; - private final HttpRestServiceProvider httpServiceProvider; - - @Autowired - public Sol003AdapterServiceProviderImpl(final Sol003AdapterUrlProvider urlProvider, - @Qualifier(SOL003_ADAPTER_HTTP_REST_SERVICE_PROVIDER_BEAN) final HttpRestServiceProvider httpServiceProvider) { - this.urlProvider = urlProvider; - this.httpServiceProvider = httpServiceProvider; - } - - @Override - public Optional<CreateVnfResponse> invokeCreateInstantiationRequest(final String vnfId, - final CreateVnfRequest request) { - try { - final String url = urlProvider.getCreateInstantiateUrl(vnfId); - - final ResponseEntity<CreateVnfResponse> response = - httpServiceProvider.postHttpRequest(request, url, CreateVnfResponse.class); - - final HttpStatus httpStatus = response.getStatusCode(); - if (!(httpStatus.equals(HttpStatus.ACCEPTED)) && !(httpStatus.equals(HttpStatus.OK))) { - LOGGER.error("Unable to invoke HTTP POST using URL: {}, Response Code: {}", url, httpStatus.value()); - return Optional.empty(); - } - - if (!response.hasBody()) { - LOGGER.error(RECEIVED_RESPONSE_WITHOUT_BODY, response); - return Optional.empty(); - } - - final CreateVnfResponse createVnfResponse = response.getBody(); - - if (StringUtils.isBlank(createVnfResponse.getJobId())) { - LOGGER.error("Received invalid instantiation response: {}", response); - return Optional.empty(); - } - - return Optional.of(createVnfResponse); - } catch (final RestProcessingException | InvalidRestRequestException - | HttpResouceNotFoundException httpInvocationException) { - LOGGER.error("Unexpected error while processing create and instantiation request", httpInvocationException); - return Optional.empty(); - } - - } - - @Override - public Optional<QueryJobResponse> getInstantiateOperationJobStatus(final String jobId) { - try { - final String url = urlProvider.getJobStatusUrl(jobId); - - final ResponseEntity<QueryJobResponse> response = - httpServiceProvider.getHttpResponse(url, QueryJobResponse.class); - - final HttpStatus httpStatus = response.getStatusCode(); - - if (!(httpStatus.equals(HttpStatus.ACCEPTED)) && !(httpStatus.equals(HttpStatus.OK))) { - LOGGER.error("Unable to invoke HTTP GET using URL: {}, Response Code: ", url, httpStatus.value()); - return Optional.empty(); - } - - if (!response.hasBody()) { - LOGGER.error(RECEIVED_RESPONSE_WITHOUT_BODY, response); - return Optional.empty(); - } - return Optional.of(response.getBody()); - } catch (final RestProcessingException | InvalidRestRequestException | HttpResouceNotFoundException exception) { - LOGGER.error("Unexpected error while processing job request", exception); - throw exception; - } - } - - @Override - public Optional<DeleteVnfResponse> invokeTerminationRequest(final String vnfId) { - try { - final String url = urlProvider.getTerminateVnfUrl(vnfId); - - final ResponseEntity<DeleteVnfResponse> response = - httpServiceProvider.deleteHttpRequest(url, DeleteVnfResponse.class); - final HttpStatus httpStatus = response.getStatusCode(); - if (!(httpStatus.equals(HttpStatus.ACCEPTED)) && !(httpStatus.equals(HttpStatus.OK))) { - LOGGER.error("Unable to invoke HTTP DELETE using URL: {}, Response Code: {}", url, httpStatus.value()); - return Optional.empty(); - } - if (!response.hasBody()) { - LOGGER.error(RECEIVED_RESPONSE_WITHOUT_BODY, response); - return Optional.empty(); - } - - final DeleteVnfResponse deleteVnfResponse = response.getBody(); - if (StringUtils.isBlank(deleteVnfResponse.getJobId())) { - LOGGER.error("Received invalid terminate response: {}", response); - return Optional.empty(); - } - - return Optional.of(deleteVnfResponse); - } catch (final RestProcessingException | InvalidRestRequestException - | HttpResouceNotFoundException httpInvocationException) { - LOGGER.error("Unexpected error while processing terminate request", httpInvocationException); - return Optional.empty(); - } - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/vnfm/Sol003AdapterUrlProvider.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/vnfm/Sol003AdapterUrlProvider.java deleted file mode 100644 index e3abc059f5..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/extclients/vnfm/Sol003AdapterUrlProvider.java +++ /dev/null @@ -1,74 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.vnfm; - -import java.net.URI; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.stereotype.Service; -import org.springframework.web.util.UriComponentsBuilder; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Service -public class Sol003AdapterUrlProvider { - - private final URI baseUri; - - @Autowired - public Sol003AdapterUrlProvider( - @Value("${so.adapters.sol003-adapter.url:https://so-vnfm-adapter.onap:9092/so/vnfm-adapter/v1/}") final String sol003AdapterUrl) { - this.baseUri = UriComponentsBuilder.fromHttpUrl(sol003AdapterUrl).build().toUri(); - } - - /** - * Get VNFM create and instantiate URL - * - * @param vnfId The identifier of the VNF. This must be the vnf-id of an existing generic-vnf in AAI. - * @return VNFM create and instantiate URL - */ - public String getCreateInstantiateUrl(final String vnfId) { - return UriComponentsBuilder.fromUri(baseUri).pathSegment("vnfs").pathSegment(vnfId).build().toString(); - } - - /** - * Get job status URL - * - * @param jobId The instantiation job identifier - * @return job status URL - */ - public String getJobStatusUrl(final String jobId) { - return UriComponentsBuilder.fromUri(baseUri).pathSegment("jobs").pathSegment(jobId).build().toString(); - } - - /** - * Get VNFM terminate vnf URL - * - * @param vnfId - * @return - */ - public String getTerminateVnfUrl(final String vnfId) { - return UriComponentsBuilder.fromUri(baseUri).pathSegment("vnfs").pathSegment(vnfId).build().toString(); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/FileEntry.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/FileEntry.java deleted file mode 100644 index cfe5b94859..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/FileEntry.java +++ /dev/null @@ -1,112 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd; - -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.utils.Utils.toIndentedString; -import java.io.ByteArrayInputStream; -import java.io.InputStream; -import java.util.Arrays; -import java.util.Objects; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class FileEntry { - - private boolean isDirectory; - private String filePath; - private byte[] fileContent; - - public boolean isDirectory() { - return isDirectory; - } - - public void setDirectory(final boolean isDirectory) { - this.isDirectory = isDirectory; - } - - public FileEntry isDirectory(final boolean isDirectory) { - this.isDirectory = isDirectory; - return this; - } - - public String getFilePath() { - return filePath; - } - - public void setFilename(final String filePath) { - this.filePath = filePath; - } - - public FileEntry filePath(final String filePath) { - this.filePath = filePath; - return this; - } - - public byte[] getFileContent() { - return fileContent; - } - - public void setFileContent(final byte[] fileContent) { - this.fileContent = fileContent; - } - - public FileEntry fileContent(final byte[] fileContent) { - this.fileContent = fileContent; - return this; - } - - public InputStream getFileContentAsStream() { - if (fileContent == null || fileContent.length == 0) { - return null; - } - return new ByteArrayInputStream(fileContent); - } - - @Override - public int hashCode() { - return Objects.hash(isDirectory, filePath) + Arrays.hashCode(fileContent); - } - - @Override - public boolean equals(final Object obj) { - if (obj instanceof FileEntry) { - final FileEntry other = (FileEntry) obj; - return Objects.equals(isDirectory, other.isDirectory) && Objects.equals(filePath, other.filePath) - && Arrays.equals(fileContent, other.fileContent); - } - return false; - } - - @Override - public String toString() { - final StringBuilder sb = new StringBuilder(); - sb.append("class FileEntry {\n"); - sb.append(" isDirectory: ").append(toIndentedString(isDirectory)).append("\n"); - sb.append(" filePath: ").append(toIndentedString(filePath)).append("\n"); - sb.append(" fileContent size: ").append(toIndentedString(fileContent != null ? fileContent.length : 0)) - .append("\n"); - sb.append("}"); - return sb.toString(); - } - - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/NetworkServiceDescriptor.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/NetworkServiceDescriptor.java deleted file mode 100644 index 6b4fee7151..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/NetworkServiceDescriptor.java +++ /dev/null @@ -1,121 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd; - -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.utils.Utils.toIndentedString; -import java.io.Serializable; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Objects; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class NetworkServiceDescriptor implements Serializable { - - private static final long serialVersionUID = -1739293595041180242L; - - private String type; - - private Map<String, Object> properties = new HashMap<>(); - - private List<VirtualNetworkFunction> vnfs = new ArrayList<>(); - - public String getType() { - return type; - } - - public void setType(final String type) { - this.type = type; - } - - public NetworkServiceDescriptor type(final String type) { - this.type = type; - return this; - } - - public Map<String, Object> getProperties() { - return properties; - } - - public void setProperties(final Map<String, Object> properties) { - this.properties = properties; - } - - public NetworkServiceDescriptor properties(final Map<String, Object> properties) { - this.properties = properties; - return this; - } - - public List<VirtualNetworkFunction> getVnfs() { - return vnfs; - } - - public void setVnfs(final List<VirtualNetworkFunction> vnfs) { - if (vnfs != null) { - this.vnfs = vnfs; - } else { - this.vnfs = new ArrayList<>(); - } - } - - public NetworkServiceDescriptor addVnfPkgIdsItem(final VirtualNetworkFunction vnf) { - if (this.vnfs == null) { - this.vnfs = new ArrayList<>(); - } - this.vnfs.add(vnf); - return this; - } - - public NetworkServiceDescriptor vnfs(final List<VirtualNetworkFunction> vnfs) { - this.vnfs = vnfs; - return this; - } - - @Override - public int hashCode() { - return Objects.hash(type, properties, vnfs); - } - - @Override - public boolean equals(final Object obj) { - if (obj instanceof NetworkServiceDescriptor) { - final NetworkServiceDescriptor other = (NetworkServiceDescriptor) obj; - return Objects.equals(type, other.type) && Objects.equals(properties, other.properties) - && Objects.equals(vnfs, other.vnfs); - } - return false; - } - - @Override - public String toString() { - final StringBuilder sb = new StringBuilder(); - sb.append("class NetworkServiceDescriptor {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); - sb.append(" properties: ").append(toIndentedString(properties)).append("\n"); - sb.append(" vnfs: ").append(toIndentedString(vnfs)).append("\n"); - sb.append("}"); - return sb.toString(); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/ToscaMetadata.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/ToscaMetadata.java deleted file mode 100644 index c07a55c459..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/ToscaMetadata.java +++ /dev/null @@ -1,75 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd; - -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.utils.Utils.toIndentedString; -import java.util.HashMap; -import java.util.Map; -import java.util.Objects; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class ToscaMetadata { - - private Map<String, String> entries = new HashMap<>(); - - public Map<String, String> getEntries() { - return entries; - } - - public void addEntry(final String name, final String value) { - this.entries.put(name, value); - } - - public boolean hasEntry(final String name) { - return this.entries.containsKey(name); - } - - public String getEntry(final String name) { - return this.entries.get(name); - } - - @Override - public int hashCode() { - return Objects.hash(entries); - } - - @Override - public boolean equals(final Object obj) { - if (obj instanceof ToscaMetadata) { - final ToscaMetadata other = (ToscaMetadata) obj; - return Objects.equals(entries, other.entries); - } - return false; - } - - @Override - public String toString() { - final StringBuilder sb = new StringBuilder(); - sb.append("class ToscaMetadata {\n"); - sb.append(" entries: ").append(toIndentedString(entries)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/VirtualNetworkFunction.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/VirtualNetworkFunction.java deleted file mode 100644 index f4c3632589..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/VirtualNetworkFunction.java +++ /dev/null @@ -1,123 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd; - -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.utils.Utils.toIndentedString; -import java.io.Serializable; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Objects; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class VirtualNetworkFunction implements Serializable { - - private static final long serialVersionUID = 3164293220359211834L; - - private String vnfdId; - private String vnfName; - private List<String> vnfmInfoList; - private Map<String, Object> properties = new HashMap<>(); - - public String getVnfdId() { - return vnfdId; - } - - public void setVnfdId(final String vnfdId) { - this.vnfdId = vnfdId; - } - - public VirtualNetworkFunction vnfdId(final String vnfdId) { - this.vnfdId = vnfdId; - return this; - } - - public String getVnfName() { - return vnfName; - } - - public void setVnfName(final String vnfName) { - this.vnfName = vnfName; - } - - public VirtualNetworkFunction vnfName(final String vnfName) { - this.vnfName = vnfName; - return this; - } - - public List<String> getVnfmInfoList() { - return vnfmInfoList; - } - - public void setVnfmInfoList(final List<String> vnfmInfoList) { - this.vnfmInfoList = vnfmInfoList; - } - - public VirtualNetworkFunction vnfmInfoList(final List<String> vnfmInfoList) { - this.vnfmInfoList = vnfmInfoList; - return this; - } - - public Map<String, Object> getProperties() { - return properties; - } - - public void setProperties(final Map<String, Object> properties) { - this.properties = properties; - } - - public VirtualNetworkFunction properties(final Map<String, Object> properties) { - this.properties = properties; - return this; - } - - @Override - public int hashCode() { - return Objects.hash(vnfdId, vnfName, vnfmInfoList, properties); - } - - @Override - public boolean equals(final Object obj) { - if (obj instanceof VirtualNetworkFunction) { - final VirtualNetworkFunction other = (VirtualNetworkFunction) obj; - return Objects.equals(vnfdId, other.vnfdId) && Objects.equals(vnfName, other.vnfName) - && Objects.equals(vnfmInfoList, other.vnfmInfoList) && Objects.equals(properties, other.properties); - } - return false; - } - - @Override - public String toString() { - final StringBuilder sb = new StringBuilder(); - sb.append("class VirtualNetworkFunction {\n"); - sb.append(" vnfdId: ").append(toIndentedString(vnfdId)).append("\n"); - sb.append(" vnfName: ").append(toIndentedString(vnfName)).append("\n"); - sb.append(" vnfmInfo: ").append(toIndentedString(vnfmInfoList)).append("\n"); - sb.append(" properties: ").append(toIndentedString(properties)).append("\n"); - - sb.append("}"); - return sb.toString(); - } - - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/FileParser.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/FileParser.java deleted file mode 100644 index 2a37922e9b..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/FileParser.java +++ /dev/null @@ -1,33 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.parser; - -import java.util.Map; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.FileEntry; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public interface FileParser { - - Map<String, Object> getFileContent(final FileEntry entryDefinitionFileEntry); - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/NetworkServiceDescriptorParser.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/NetworkServiceDescriptorParser.java deleted file mode 100644 index cc92234750..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/NetworkServiceDescriptorParser.java +++ /dev/null @@ -1,213 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.parser; - -import java.io.ByteArrayInputStream; -import java.io.IOException; -import java.util.ArrayList; -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Map.Entry; -import java.util.Optional; -import java.util.zip.ZipEntry; -import java.util.zip.ZipInputStream; -import org.apache.commons.io.IOUtils; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.FileEntry; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.NetworkServiceDescriptor; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.ToscaMetadata; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.VirtualNetworkFunction; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Service; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Service -public class NetworkServiceDescriptorParser { - public static final String NS_NODE_TYPE = "tosca.nodes.nfv.NS"; - private static final String NODE_TYPE = "node_type"; - private static final String SUBSTITUTION_MAPPINGS = "substitution_mappings"; - private static final Logger logger = LoggerFactory.getLogger(NetworkServiceDescriptorParser.class); - private static final String VNF_TYPE = "tosca.nodes.nfv.VNF"; - private static final String PROPERTIES = "properties"; - private static final String TYPE = "type"; - private static final String NODE_TEMPLATES = "node_templates"; - private static final String TOPOLOGY_TEMPLATE = "topology_template"; - private static final String ENTRY_DEFINITIONS = "Entry-Definitions"; - private static final String TOSCA_META_PATH_FILE_NAME = "TOSCA-Metadata/TOSCA.meta"; - private final ToscaMetadataParser toscaMetadataParser; - private final FileParser fileParser; - - @Autowired - public NetworkServiceDescriptorParser(final ToscaMetadataParser toscaMetadataParser, final FileParser fileParser) { - this.toscaMetadataParser = toscaMetadataParser; - this.fileParser = fileParser; - } - - public Optional<NetworkServiceDescriptor> parse(final byte[] zipBytes) { - try { - final Map<String, FileEntry> files = getZipContent(zipBytes); - if (isMetaFilePresent(files)) { - final Optional<ToscaMetadata> optional = - toscaMetadataParser.parse(files.get(TOSCA_META_PATH_FILE_NAME)); - if (optional.isPresent()) { - final ToscaMetadata toscaMetadata = optional.get(); - logger.info("Parsed ToscaMetadata {}", toscaMetadata); - final String entryDefinitionFile = toscaMetadata.getEntry(ENTRY_DEFINITIONS); - if (entryDefinitionFile != null && files.containsKey(entryDefinitionFile)) { - final Map<String, Object> fileContent = - fileParser.getFileContent(files.get(entryDefinitionFile)); - final Map<String, Object> topologyTemplates = getTopologyTemplates(fileContent); - final Map<String, Object> nodeTemplates = getNodeTemplates(topologyTemplates); - - final Optional<NetworkServiceDescriptor> nsdOptional = - getNetworkServiceDescriptor(topologyTemplates); - if (nsdOptional.isPresent()) { - final NetworkServiceDescriptor networkServiceDescriptor = nsdOptional.get(); - networkServiceDescriptor.setVnfs(getVirtualNetworkFunctions(nodeTemplates)); - return Optional.of(networkServiceDescriptor); - } - - } - } - - } - - logger.error("Unable to find {} file in {}", TOSCA_META_PATH_FILE_NAME, files); - } catch (final Exception exception) { - logger.error("Unable to parse nsd zip content", exception); - } - return Optional.empty(); - } - - @SuppressWarnings("unchecked") - private Optional<NetworkServiceDescriptor> getNetworkServiceDescriptor( - final Map<String, Object> topologyTemplates) { - final Map<String, Object> substitutionMappings = - (Map<String, Object>) topologyTemplates.get(SUBSTITUTION_MAPPINGS); - final Object nodeType = substitutionMappings.get(NODE_TYPE); - if (substitutionMappings != null && NS_NODE_TYPE.equals(nodeType)) { - final NetworkServiceDescriptor networkServiceDescriptor = new NetworkServiceDescriptor(); - networkServiceDescriptor.setType(nodeType.toString()); - networkServiceDescriptor.setProperties((Map<String, Object>) substitutionMappings.get(PROPERTIES)); - return Optional.of(networkServiceDescriptor); - } - logger.error("No {} found in fileContent: {}", SUBSTITUTION_MAPPINGS, topologyTemplates); - - return Optional.empty(); - } - - private List<VirtualNetworkFunction> getVirtualNetworkFunctions(final Map<String, Object> nodeTemplates) { - final List<VirtualNetworkFunction> vnfs = new ArrayList<>(); - for (final Entry<String, Object> entry : nodeTemplates.entrySet()) { - @SuppressWarnings("unchecked") - final Map<String, Object> entryValue = (Map<String, Object>) entry.getValue(); - final Object type = entryValue.get(TYPE); - if (type != null && type.equals(VNF_TYPE)) { - @SuppressWarnings("unchecked") - final Map<String, Object> vnfProperties = (Map<String, Object>) entryValue.get(PROPERTIES); - final VirtualNetworkFunction vnf = new VirtualNetworkFunction(); - vnf.setVnfName(entry.getKey()); - - if (vnfProperties != null && !vnfProperties.isEmpty()) { - final Object vnfDescriptorId = vnfProperties.get("descriptor_id"); - @SuppressWarnings("unchecked") - final List<String> vnfmInfoList = (List<String>) vnfProperties.get("vnfm_info"); - if (vnfDescriptorId != null && vnfmInfoList != null) { - vnf.setVnfmInfoList(vnfmInfoList); - vnf.setVnfdId(vnfDescriptorId.toString()); - vnf.setProperties(vnfProperties); - vnfs.add(vnf); - } else { - logger.warn("descriptor_id missing {}", entryValue); - } - } - } - - } - return vnfs; - } - - private Map<String, Object> getNodeTemplates(final Map<String, Object> topologyTemplates) { - @SuppressWarnings("unchecked") - final Map<String, Object> nodeTemplates = (Map<String, Object>) topologyTemplates.get(NODE_TEMPLATES); - if (nodeTemplates != null) { - logger.debug("Found nodeTemplates: {}", topologyTemplates); - return nodeTemplates; - } - logger.error("No {} found in fileContent: {}", NODE_TEMPLATES, topologyTemplates); - return Collections.emptyMap(); - } - - private Map<String, Object> getTopologyTemplates(final Map<String, Object> fileContent) { - @SuppressWarnings("unchecked") - final Map<String, Object> topologyTemplates = (Map<String, Object>) fileContent.get(TOPOLOGY_TEMPLATE); - if (topologyTemplates != null) { - logger.debug("Found {}: {}", TOPOLOGY_TEMPLATE, topologyTemplates); - - return topologyTemplates; - } - logger.error("No {} found in fileContent: {}", TOPOLOGY_TEMPLATE, fileContent); - return Collections.emptyMap(); - } - - private boolean isMetaFilePresent(final Map<String, FileEntry> files) { - return files.containsKey(TOSCA_META_PATH_FILE_NAME); - } - - private Map<String, FileEntry> getZipContent(final byte[] zipBytes) { - final Map<String, FileEntry> files = new HashMap<>(); - try (final ZipInputStream inputZipStream = new ZipInputStream(new ByteArrayInputStream(zipBytes));) { - ZipEntry zipEntry; - while ((zipEntry = inputZipStream.getNextEntry()) != null) { - logger.info("{} : {}", zipEntry.getName(), zipEntry.isDirectory()); - if (files.get(zipEntry.getName()) != null) { - logger.warn("{} File entry already exists ...", zipEntry.getName()); - } else { - final FileEntry fileEntry = new FileEntry().filePath(zipEntry.getName()) - .fileContent(getBytes(inputZipStream)).isDirectory(zipEntry.isDirectory()); - files.put(zipEntry.getName(), fileEntry); - - } - - } - return files; - } catch (final Exception exception) { - logger.error("Unable to parse nsd zip content", exception); - return Collections.emptyMap(); - } - } - - private byte[] getBytes(final ZipInputStream inputZipStream) throws IOException { - try { - return IOUtils.toByteArray(inputZipStream); - } catch (final IOException exception) { - logger.error("Could not read bytes from file", exception); - throw exception; - } - } - - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/ToscaMetadataParser.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/ToscaMetadataParser.java deleted file mode 100644 index 746416c8e4..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/ToscaMetadataParser.java +++ /dev/null @@ -1,70 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.parser; - -import static java.nio.charset.StandardCharsets.UTF_8; -import static org.apache.commons.lang3.StringUtils.isNotBlank; -import java.util.List; -import java.util.Optional; -import org.apache.commons.io.IOUtils; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.FileEntry; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.ToscaMetadata; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.stereotype.Service; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Service -public class ToscaMetadataParser { - private static final String ATTRIBUTE_VALUE_SEPARATOR = ":"; - private static final Logger logger = LoggerFactory.getLogger(ToscaMetadataParser.class); - - public Optional<ToscaMetadata> parse(final FileEntry toscaMetaFile) { - try { - final ToscaMetadata toscaMetadata = new ToscaMetadata(); - final List<String> lines = IOUtils.readLines(toscaMetaFile.getFileContentAsStream(), UTF_8); - for (final String line : lines) { - final String trimmedLine = line.trim(); - if (!trimmedLine.isEmpty() && trimmedLine.contains(ATTRIBUTE_VALUE_SEPARATOR)) { - final String[] entry = trimmedLine.split(ATTRIBUTE_VALUE_SEPARATOR); - if (entry.length >= 2 && isNotBlank(entry[0]) && isNotBlank(entry[1])) { - toscaMetadata.addEntry(entry[0].trim(), entry[1].trim()); - } else { - logger.warn("Unexpected line in metadata file: {}", line); - } - } else { - logger.warn("Unexpected line does not contain valid separator {} in metadata file: {}", - ATTRIBUTE_VALUE_SEPARATOR, line); - } - - } - return Optional.of(toscaMetadata); - - } catch (final Exception exception) { - logger.error("Unable to parser metadata file content", exception); - } - return Optional.empty(); - } - - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/YamlFileParser.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/YamlFileParser.java deleted file mode 100644 index eab6974252..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/YamlFileParser.java +++ /dev/null @@ -1,40 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.parser; - -import java.util.Map; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.FileEntry; -import org.springframework.stereotype.Service; -import org.yaml.snakeyaml.Yaml; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Service -public class YamlFileParser implements FileParser { - - @Override - public Map<String, Object> getFileContent(final FileEntry entryDefinitionFileEntry) { - final Yaml yaml = new Yaml(); - return yaml.load(entryDefinitionFileEntry.getFileContentAsStream()); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/service/JobExecutorService.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/service/JobExecutorService.java deleted file mode 100644 index 14d4fa2f07..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/service/JobExecutorService.java +++ /dev/null @@ -1,399 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.service; - -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.CREATE_NS_REQUEST_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.GLOBAL_CUSTOMER_ID_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.INSTANTIATE_NS_REQUEST_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.JOB_ID_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NS_INSTANCE_ID_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.OCC_ID_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.SERVICE_TYPE_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.TERMINATE_NS_REQUEST_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.Constants.CREATE_NS_WORKFLOW_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.Constants.DELETE_NS_WORKFLOW_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.Constants.INSTANTIATE_NS_WORKFLOW_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.Constants.TERMINATE_NS_WORKFLOW_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobAction.DELETE; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobAction.INSTANTIATE; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobAction.TERMINATE; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.ERROR; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.FINISHED; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.FINISHED_WITH_ERROR; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.IN_PROGRESS; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.STARTING; -import static org.slf4j.LoggerFactory.getLogger; -import java.time.Instant; -import java.time.LocalDateTime; -import java.util.HashMap; -import java.util.Map; -import java.util.Optional; -import java.util.concurrent.TimeUnit; -import org.apache.commons.lang3.tuple.ImmutablePair; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.GsonProvider; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.exceptions.NsRequestProcessingException; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobAction; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJob; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NsLcmOpOcc; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NsLcmOpType; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.OperationStateEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.model.CreateNsRequest; -import org.onap.so.etsi.nfvo.ns.lcm.model.InlineResponse400; -import org.onap.so.etsi.nfvo.ns.lcm.model.InstantiateNsRequest; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsInstancesNsInstance; -import org.onap.so.etsi.nfvo.ns.lcm.model.TerminateNsRequest; -import org.slf4j.Logger; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.stereotype.Service; -import com.google.common.collect.ImmutableSet; -import com.google.gson.Gson; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Service -public class JobExecutorService { - - private static final Logger logger = getLogger(JobExecutorService.class); - - private static final ImmutableSet<JobStatusEnum> JOB_FINISHED_STATES = - ImmutableSet.of(FINISHED, ERROR, FINISHED_WITH_ERROR); - - private static final int SLEEP_TIME_IN_SECONDS = 5; - - @Value("${so-etsi-ns-lcm-workflow-engine.requesttimeout.timeoutInSeconds:300}") - private int timeOutInSeconds; - - private final DatabaseServiceProvider databaseServiceProvider; - private final WorkflowExecutorService workflowExecutorService; - private final WorkflowQueryService workflowQueryService; - private Gson gson; - - @Autowired - public JobExecutorService(final DatabaseServiceProvider databaseServiceProvider, - final WorkflowExecutorService workflowExecutorService, final WorkflowQueryService workflowQueryService, - final GsonProvider gsonProvider) { - this.databaseServiceProvider = databaseServiceProvider; - this.workflowExecutorService = workflowExecutorService; - this.workflowQueryService = workflowQueryService; - gson = gsonProvider.getGson(); - } - - public NsInstancesNsInstance runCreateNsJob(final CreateNsRequest createNsRequest, final String globalCustomerId, - final String serviceType) { - logger.info("Starting 'Create NS' workflow job for request:\n{}", createNsRequest); - final NfvoJob newJob = new NfvoJob().startTime(LocalDateTime.now()).jobType("NS").jobAction(JobAction.CREATE) - .resourceId(createNsRequest.getNsdId()).resourceName(createNsRequest.getNsName()) - .status(JobStatusEnum.STARTING).progress(5); - databaseServiceProvider.addJob(newJob); - - logger.info("New job created in database :\n{}", newJob); - - workflowExecutorService.executeWorkflow(newJob.getJobId(), CREATE_NS_WORKFLOW_NAME, - getVariables(newJob.getJobId(), createNsRequest, globalCustomerId, serviceType)); - - final ImmutablePair<String, JobStatusEnum> immutablePair = - waitForJobToFinish(newJob.getJobId(), JOB_FINISHED_STATES); - - if (immutablePair.getRight() == null) { - final String message = "Failed to create NS for request: \n" + createNsRequest; - logger.error(message); - throw new NsRequestProcessingException(message); - } - final JobStatusEnum finalJobStatus = immutablePair.getRight(); - final String processInstanceId = immutablePair.getLeft(); - - if (!FINISHED.equals(finalJobStatus)) { - - final Optional<InlineResponse400> optional = workflowQueryService.getProblemDetails(processInstanceId); - if (optional.isPresent()) { - final InlineResponse400 problemDetails = optional.get(); - final String message = - "Failed to create NS for request: \n" + createNsRequest + " due to \n" + problemDetails; - logger.error(message); - throw new NsRequestProcessingException(message, problemDetails); - } - - final String message = "Received unexpected Job Status: " + finalJobStatus - + " Failed to Create NS for request: \n" + createNsRequest; - logger.error(message); - throw new NsRequestProcessingException(message); - } - - logger.debug("Will query for CreateNsResponse using processInstanceId:{}", processInstanceId); - final Optional<NsInstancesNsInstance> optional = workflowQueryService.getCreateNsResponse(processInstanceId); - if (optional.isEmpty()) { - final String message = - "Unable to find CreateNsReponse in Camunda History for process instance: " + processInstanceId; - logger.error(message); - throw new NsRequestProcessingException(message); - } - return optional.get(); - } - - public String runInstantiateNsJob(final String nsInstanceId, final InstantiateNsRequest instantiateNsRequest) { - - final NfvoJob newJob = new NfvoJob().startTime(LocalDateTime.now()).jobType("NS").jobAction(INSTANTIATE) - .resourceId(nsInstanceId).status(STARTING).progress(0); - databaseServiceProvider.addJob(newJob); - logger.info("New job created in database :\n{}", newJob); - - final LocalDateTime currentDateTime = LocalDateTime.now(); - final NsLcmOpOcc newNsLcmOpOcc = new NsLcmOpOcc().id(nsInstanceId).operation(NsLcmOpType.INSTANTIATE) - .operationState(OperationStateEnum.PROCESSING).stateEnteredTime(currentDateTime) - .startTime(currentDateTime).nfvoNsInst(getNfvoNsInst(nsInstanceId)).isAutoInvocation(false) - .isCancelPending(false).operationParams(gson.toJson(instantiateNsRequest)); - databaseServiceProvider.addNSLcmOpOcc(newNsLcmOpOcc); - logger.info("New NSLcmOpOcc created in database :\n{}", newNsLcmOpOcc); - - workflowExecutorService.executeWorkflow(newJob.getJobId(), INSTANTIATE_NS_WORKFLOW_NAME, - getVariables(nsInstanceId, newJob.getJobId(), newNsLcmOpOcc.getId(), instantiateNsRequest)); - - final ImmutableSet<JobStatusEnum> jobFinishedStates = - ImmutableSet.of(FINISHED, ERROR, FINISHED_WITH_ERROR, IN_PROGRESS); - final ImmutablePair<String, JobStatusEnum> immutablePair = - waitForJobToFinish(newJob.getJobId(), jobFinishedStates); - - if (immutablePair.getRight() == null) { - final String message = "Failed to Instantiate NS for request: \n" + instantiateNsRequest; - logger.error(message); - throw new NsRequestProcessingException(message); - } - - final JobStatusEnum finalJobStatus = immutablePair.getRight(); - - if (IN_PROGRESS.equals(finalJobStatus) || FINISHED.equals(finalJobStatus)) { - logger.info("Instantiation Job status: {}", finalJobStatus); - - - return newNsLcmOpOcc.getId(); - } - - final String message = "Received unexpected Job Status: " + finalJobStatus - + " Failed to instantiate NS for request: \n" + instantiateNsRequest; - logger.error(message); - throw new NsRequestProcessingException(message); - } - - public String runTerminateNsJob(final String nsInstanceId, final TerminateNsRequest terminateNsRequest) { - doInitialTerminateChecks(nsInstanceId, terminateNsRequest); - - final NfvoJob nfvoJob = new NfvoJob().startTime(LocalDateTime.now()).jobType("NS").jobAction(TERMINATE) - .resourceId(nsInstanceId).status(STARTING).progress(0); - databaseServiceProvider.addJob(nfvoJob); - logger.info("New job created in database :\n{}", nfvoJob); - - final LocalDateTime currentDateTime = LocalDateTime.now(); - final NsLcmOpOcc nsLcmOpOcc = new NsLcmOpOcc().id(nsInstanceId).operation(NsLcmOpType.TERMINATE) - .operationState(OperationStateEnum.PROCESSING).stateEnteredTime(currentDateTime) - .startTime(currentDateTime).nfvoNsInst(getNfvoNsInst(nsInstanceId)).isAutoInvocation(false) - .isCancelPending(false).operationParams(gson.toJson(terminateNsRequest)); - databaseServiceProvider.addNSLcmOpOcc(nsLcmOpOcc); - logger.info("New NSLcmOpOcc created in database :\n{}", nsLcmOpOcc); - - workflowExecutorService.executeWorkflow(nfvoJob.getJobId(), TERMINATE_NS_WORKFLOW_NAME, - getVariables(nsInstanceId, nfvoJob.getJobId(), nsLcmOpOcc.getId(), terminateNsRequest)); - - final ImmutableSet<JobStatusEnum> jobFinishedStates = - ImmutableSet.of(FINISHED, ERROR, FINISHED_WITH_ERROR, IN_PROGRESS); - final ImmutablePair<String, JobStatusEnum> immutablePair = - waitForJobToFinish(nfvoJob.getJobId(), jobFinishedStates); - - if (immutablePair.getRight() == null) { - final String message = - "Failed to Terminate NS with id: " + nsInstanceId + " for request: \n" + terminateNsRequest; - logger.error(message); - throw new NsRequestProcessingException(message); - } - - final JobStatusEnum finalJobStatus = immutablePair.getRight(); - - if (IN_PROGRESS.equals(finalJobStatus) || FINISHED.equals(finalJobStatus)) { - logger.info("Termination Job status: {}", finalJobStatus); - return nsLcmOpOcc.getId(); - } - - final String message = "Received unexpected Job Status: " + finalJobStatus + " Failed to Terminate NS with id: " - + nsInstanceId + " for request: \n" + terminateNsRequest; - logger.error(message); - throw new NsRequestProcessingException(message); - } - - public void runDeleteNsJob(final String nsInstanceId) { - final NfvoJob nfvoJob = new NfvoJob().startTime(LocalDateTime.now()).jobType("NS").jobAction(DELETE) - .resourceId(nsInstanceId).status(STARTING).progress(0); - databaseServiceProvider.addJob(nfvoJob); - logger.info("New job created in database :\n{}", nfvoJob); - - workflowExecutorService.executeWorkflow(nfvoJob.getJobId(), DELETE_NS_WORKFLOW_NAME, - getVariables(nsInstanceId, nfvoJob.getJobId())); - - final ImmutablePair<String, JobStatusEnum> immutablePair = - waitForJobToFinish(nfvoJob.getJobId(), JOB_FINISHED_STATES); - - if (immutablePair.getRight() == null) { - final String message = "Failed to Delete NS with id: " + nsInstanceId; - logger.error(message); - throw new NsRequestProcessingException(message); - } - - final JobStatusEnum finalJobStatus = immutablePair.getRight(); - final String processInstanceId = immutablePair.getLeft(); - - if (FINISHED.equals(finalJobStatus)) { - logger.info("Delete Job status: {}", finalJobStatus); - return; - } - - final Optional<InlineResponse400> optional = workflowQueryService.getProblemDetails(processInstanceId); - if (optional.isPresent()) { - final InlineResponse400 problemDetails = optional.get(); - final String message = "Failed to Delete NS with id: " + nsInstanceId + " due to:\n" + problemDetails; - logger.error(message); - throw new NsRequestProcessingException(message, problemDetails); - } - - final String message = - "Received unexpected Job Status: " + finalJobStatus + " Failed to Delete NS with id: " + nsInstanceId; - logger.error(message); - throw new NsRequestProcessingException(message); - } - - private void doInitialTerminateChecks(final String nsInstanceId, final TerminateNsRequest terminateNsRequest) { - if (isNotImmediateTerminateRequest(terminateNsRequest)) { - final String message = "TerminateNsRequest received with terminateTime: " - + terminateNsRequest.getTerminationTime() - + "\nOnly immediate Terminate requests are currently supported \n(i.e., terminateTime field must not be set)."; - logger.error(message); - throw new NsRequestProcessingException(message); - } - - final NfvoNsInst nfvoNsInst = getNfvoNsInst(nsInstanceId); - if (isNotInstantiated(nfvoNsInst)) { - final String message = "TerminateNsRequest received: " + terminateNsRequest + " for nsInstanceId: " - + nsInstanceId + "\nUnable to terminate. NS Instance is already in NOT_INSTANTIATED state." - + "\nThis method can only be used with an NS instance in the INSTANTIATED state."; - logger.error(message); - throw new NsRequestProcessingException(message); - } - } - - private boolean isNotImmediateTerminateRequest(final TerminateNsRequest terminateNsRequest) { - return terminateNsRequest != null && terminateNsRequest.getTerminationTime() != null; - } - - private boolean isNotInstantiated(final NfvoNsInst nfvoNsInst) { - return State.NOT_INSTANTIATED.equals(nfvoNsInst.getStatus()); - } - - private NfvoNsInst getNfvoNsInst(final String nsInstId) { - logger.info("Getting NfvoNsInst with nsInstId: {}", nsInstId); - final Optional<NfvoNsInst> optionalNfvoNsInst = databaseServiceProvider.getNfvoNsInst(nsInstId); - - if (optionalNfvoNsInst.isEmpty()) { - final String message = "No matching NS Instance for id: " + nsInstId + " found in database."; - throw new NsRequestProcessingException(message); - } - - return optionalNfvoNsInst.get(); - } - - private ImmutablePair<String, JobStatusEnum> waitForJobToFinish(final String jobId, - final ImmutableSet<JobStatusEnum> jobFinishedStates) { - try { - final long startTimeInMillis = System.currentTimeMillis(); - final long timeOutTime = startTimeInMillis + TimeUnit.SECONDS.toMillis(timeOutInSeconds); - - logger.info("Will wait till {} for {} job to finish", Instant.ofEpochMilli(timeOutTime).toString(), jobId); - JobStatusEnum currentJobStatus = null; - while (timeOutTime > System.currentTimeMillis()) { - - final Optional<NfvoJob> optional = databaseServiceProvider.getRefreshedJob(jobId); - - if (optional.isEmpty()) { - logger.error("Unable to find Job using jobId: {}", jobId); - return ImmutablePair.nullPair(); - } - - final NfvoJob nfvoJob = optional.get(); - currentJobStatus = nfvoJob.getStatus(); - logger.debug("Received job status response: \n {}", nfvoJob); - if (jobFinishedStates.contains(currentJobStatus)) { - logger.info("Job finished \n {}", currentJobStatus); - return ImmutablePair.of(nfvoJob.getProcessInstanceId(), currentJobStatus); - } - - logger.info("Haven't received one of finish state {} yet, will try again in {} seconds", - jobFinishedStates, SLEEP_TIME_IN_SECONDS); - TimeUnit.SECONDS.sleep(SLEEP_TIME_IN_SECONDS); - - } - logger.warn("Timeout current job status: {}", currentJobStatus); - return ImmutablePair.nullPair(); - } catch (final InterruptedException interruptedException) { - Thread.currentThread().interrupt(); - logger.error("Sleep was interrupted", interruptedException); - return ImmutablePair.nullPair(); - } - } - - private Map<String, Object> getVariables(final String jobId, final CreateNsRequest createNsRequest, - final String globalCustomerId, final String serviceType) { - final Map<String, Object> variables = new HashMap<>(); - variables.put(JOB_ID_PARAM_NAME, jobId); - variables.put(CREATE_NS_REQUEST_PARAM_NAME, createNsRequest); - variables.put(GLOBAL_CUSTOMER_ID_PARAM_NAME, globalCustomerId); - variables.put(SERVICE_TYPE_PARAM_NAME, serviceType); - return variables; - } - - private Map<String, Object> getVariables(final String nsInstanceId, final String jobId, final String occId, - final InstantiateNsRequest instantiateNsRequest) { - final Map<String, Object> variables = new HashMap<>(); - variables.put(NS_INSTANCE_ID_PARAM_NAME, nsInstanceId); - variables.put(JOB_ID_PARAM_NAME, jobId); - variables.put(OCC_ID_PARAM_NAME, occId); - variables.put(INSTANTIATE_NS_REQUEST_PARAM_NAME, instantiateNsRequest); - return variables; - } - - private Map<String, Object> getVariables(final String nsInstanceId, final String jobId, final String occId, - final TerminateNsRequest terminateNsRequest) { - final Map<String, Object> variables = new HashMap<>(); - variables.put(NS_INSTANCE_ID_PARAM_NAME, nsInstanceId); - variables.put(JOB_ID_PARAM_NAME, jobId); - variables.put(OCC_ID_PARAM_NAME, occId); - variables.put(TERMINATE_NS_REQUEST_PARAM_NAME, terminateNsRequest); - return variables; - } - - private Map<String, Object> getVariables(final String nsInstanceId, final String jobId) { - final Map<String, Object> variables = new HashMap<>(); - variables.put(NS_INSTANCE_ID_PARAM_NAME, nsInstanceId); - variables.put(JOB_ID_PARAM_NAME, jobId); - return variables; - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/service/WorkflowExecutorService.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/service/WorkflowExecutorService.java deleted file mode 100644 index fa2b8d5507..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/service/WorkflowExecutorService.java +++ /dev/null @@ -1,59 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.service; - -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.Constants.TENANT_ID; -import static org.slf4j.LoggerFactory.getLogger; -import java.util.Map; -import org.camunda.bpm.engine.RuntimeService; -import org.camunda.bpm.engine.runtime.ProcessInstance; -import org.slf4j.Logger; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.scheduling.annotation.Async; -import org.springframework.stereotype.Service; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Service -public class WorkflowExecutorService { - - private static final Logger logger = getLogger(WorkflowExecutorService.class); - - private final RuntimeService runtimeService; - - @Autowired - public WorkflowExecutorService(final RuntimeService runtimeService) { - this.runtimeService = runtimeService; - } - - @Async - public void executeWorkflow(final String jobId, final String processDefinitionKey, - final Map<String, Object> variables) { - logger.info("Executing {} workflow with business key: {}", processDefinitionKey, jobId); - final ProcessInstance processInstance = runtimeService.createProcessInstanceByKey(processDefinitionKey) - .businessKey(jobId).setVariables(variables).processDefinitionTenantId(TENANT_ID).execute(); - - logger.info("Workflow running with processInstanceId: {} and business key: {}", - processInstance.getProcessInstanceId(), processInstance.getBusinessKey()); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/service/WorkflowQueryService.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/service/WorkflowQueryService.java deleted file mode 100644 index a6180b0e52..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/service/WorkflowQueryService.java +++ /dev/null @@ -1,108 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.service; - -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.CREATE_NS_RESPONSE_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.Constants.TENANT_ID; -import static org.slf4j.LoggerFactory.getLogger; -import java.util.Optional; -import org.camunda.bpm.engine.HistoryService; -import org.camunda.bpm.engine.ProcessEngineException; -import org.camunda.bpm.engine.history.HistoricVariableInstance; -import org.onap.so.etsi.nfvo.ns.lcm.model.InlineResponse400; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsInstancesNsInstance; -import org.slf4j.Logger; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Service; -import com.google.common.base.Strings; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Service -public class WorkflowQueryService { - - private static final Logger logger = getLogger(WorkflowQueryService.class); - - private final HistoryService camundaHistoryService; - - @Autowired - public WorkflowQueryService(final HistoryService camundaHistoryService) { - this.camundaHistoryService = camundaHistoryService; - } - - public Optional<NsInstancesNsInstance> getCreateNsResponse(final String processInstanceId) { - try { - - if (Strings.isNullOrEmpty(processInstanceId)) { - logger.error("Invalid processInstanceId: {}", processInstanceId); - return Optional.empty(); - } - - final HistoricVariableInstance historicVariableInstance = - getVariable(processInstanceId, CREATE_NS_RESPONSE_PARAM_NAME); - - if (historicVariableInstance != null) { - logger.info("Found HistoricVariableInstance : {}", historicVariableInstance); - final Object variableValue = historicVariableInstance.getValue(); - if (variableValue instanceof NsInstancesNsInstance) { - return Optional.ofNullable((NsInstancesNsInstance) variableValue); - } - logger.error("Unknown CreateNsResponse object type {} received value: {}", - historicVariableInstance.getValue() != null ? variableValue.getClass() : null, variableValue); - } - } catch (final ProcessEngineException processEngineException) { - logger.error("Unable to find {} variable using processInstanceId: {}", CREATE_NS_RESPONSE_PARAM_NAME, - processInstanceId, processEngineException); - } - logger.error("Unable to find {} variable using processInstanceId: {}", CREATE_NS_RESPONSE_PARAM_NAME, - processInstanceId); - return Optional.empty(); - - } - - public Optional<InlineResponse400> getProblemDetails(final String processInstanceId) { - try { - final HistoricVariableInstance historicVariableInstance = - getVariable(processInstanceId, NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME); - - logger.info("Found HistoricVariableInstance : {}", historicVariableInstance); - final Object variableValue = historicVariableInstance.getValue(); - if (variableValue instanceof InlineResponse400) { - return Optional.ofNullable((InlineResponse400) variableValue); - } - logger.error("Unknown ProblemDetails object type {} received value: {}", - historicVariableInstance.getValue() != null ? variableValue.getClass() : null, variableValue); - } catch (final ProcessEngineException processEngineException) { - logger.error("Unable to find {} variable using processInstanceId: {}", - NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME, processInstanceId, processEngineException); - } - return Optional.empty(); - } - - - private HistoricVariableInstance getVariable(final String processInstanceId, final String name) { - return camundaHistoryService.createHistoricVariableInstanceQuery().processInstanceId(processInstanceId) - .variableName(name).tenantIdIn(TENANT_ID).singleResult(); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/AbstractNetworkServiceTask.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/AbstractNetworkServiceTask.java deleted file mode 100644 index a785a5199b..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/AbstractNetworkServiceTask.java +++ /dev/null @@ -1,188 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks; - -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.JOB_ID_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NS_INSTANCE_ID_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.OCC_ID_PARAM_NAME; -import java.time.LocalDateTime; -import java.util.Optional; -import org.camunda.bpm.engine.delegate.BpmnError; -import org.camunda.bpm.engine.delegate.DelegateExecution; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJob; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJobStatus; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.OperationStateEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.model.InlineResponse400; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * @author Andrew Lamb (andrew.a.lamb@est.tech) - * - */ -public abstract class AbstractNetworkServiceTask { - private final Logger logger = LoggerFactory.getLogger(getClass()); - protected final DatabaseServiceProvider databaseServiceProvider; - - protected AbstractNetworkServiceTask(final DatabaseServiceProvider jobServiceProvider) { - this.databaseServiceProvider = jobServiceProvider; - } - - public void addJobStatus(final DelegateExecution execution, final JobStatusEnum jobStatus, - final String description) { - final NfvoJobStatus nfvoJobStatus = - new NfvoJobStatus().status(jobStatus).description(description).updatedTime(LocalDateTime.now()); - logger.info("Adding NfvoJobStatus {}", nfvoJobStatus); - final NfvoJob nfvoJob = getNfvoJob(execution); - nfvoJob.nfvoJobStatus(nfvoJobStatus); - databaseServiceProvider.addJob(nfvoJob); - } - - public void setJobStatus(final DelegateExecution execution, final JobStatusEnum jobStatus, - final String description) { - logger.info("Setting Job Status to {}", jobStatus); - final NfvoJob nfvoJob = getNfvoJob(execution); - nfvoJob.status(jobStatus); - if (JobStatusEnum.STARTED.equals(jobStatus)) { - nfvoJob.processInstanceId(execution.getProcessInstanceId()); - } - - if (JobStatusEnum.FINISHED.equals(jobStatus)) { - nfvoJob.endTime(LocalDateTime.now()); - } - - nfvoJob.nfvoJobStatus( - new NfvoJobStatus().status(jobStatus).description(description).updatedTime(LocalDateTime.now())); - databaseServiceProvider.addJob(nfvoJob); - - } - - public void setJobStatusToError(final DelegateExecution execution, final String description) { - logger.info("Setting Job Status to {}", JobStatusEnum.ERROR); - - final String jobId = (String) execution.getVariable(JOB_ID_PARAM_NAME); - final Optional<NfvoJob> optional = databaseServiceProvider.getJob(jobId); - if (optional.isPresent()) { - final InlineResponse400 problemDetails = - (InlineResponse400) execution.getVariable(NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME); - - final NfvoJob nfvoJob = optional.get(); - nfvoJob.status(JobStatusEnum.ERROR).endTime(LocalDateTime.now()); - - if (problemDetails != null) { - logger.error("Found failed reason: {}", problemDetails); - nfvoJob.nfvoJobStatus(new NfvoJobStatus().status(JobStatusEnum.ERROR) - .description(problemDetails.getDetail()).updatedTime(LocalDateTime.now())); - } - nfvoJob.nfvoJobStatus(new NfvoJobStatus().status(JobStatusEnum.ERROR).description(description) - .updatedTime(LocalDateTime.now())); - - databaseServiceProvider.addJob(nfvoJob); - } - logger.info("Finished setting Job Status to {}", JobStatusEnum.ERROR); - - } - - public void updateNsLcmOpOccStatusToCompleted(final DelegateExecution execution) { - logger.info("Executing updateNsLcmOpOccStatusToCompleted ..."); - - updateNsLcmOpOccOperationState(execution, OperationStateEnum.COMPLETED); - - logger.info("Finished executing updateNsLcmOpOccStatusToCompleted ..."); - - } - - public void updateNsLcmOpOccStatusToFailed(final DelegateExecution execution) { - logger.info("Executing updateNsLcmOpOccStatusToFailed ..."); - - updateNsLcmOpOccOperationState(execution, OperationStateEnum.FAILED); - - logger.info("Finished executing updateNsLcmOpOccStatusToFailed ..."); - - } - - protected void abortOperation(final DelegateExecution execution, final String message) { - abortOperation(execution, message, new InlineResponse400().detail(message)); - } - - private void updateNsLcmOpOccOperationState(final DelegateExecution execution, - final OperationStateEnum operationState) { - final String occId = (String) execution.getVariable(OCC_ID_PARAM_NAME); - - final boolean isSuccessful = databaseServiceProvider.updateNsLcmOpOccOperationState(occId, operationState); - if (!isSuccessful) { - final String message = - "Unable to update NsLcmOpOcc " + occId + " operationState to" + operationState + " in database"; - logger.error(message); - abortOperation(execution, message); - } - } - - protected void abortOperation(final DelegateExecution execution, final String message, - final InlineResponse400 problemDetails) { - logger.error(message); - execution.setVariable(NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME, problemDetails); - throw new BpmnError("WORKFLOW_FAILED"); - } - - private NfvoJob getNfvoJob(final DelegateExecution execution) { - final String jobId = (String) execution.getVariable(JOB_ID_PARAM_NAME); - final Optional<NfvoJob> optional = databaseServiceProvider.getJob(jobId); - if (optional.isEmpty()) { - final String message = "Unable to find job using job id: " + jobId; - logger.error(message); - execution.setVariable(NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME, new InlineResponse400().detail(message)); - throw new BpmnError("WORKFLOW_FAILED"); - - } - return optional.get(); - } - - protected void updateNsInstanceStatus(final DelegateExecution execution, final State nsStatus) { - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - - logger.info("Updating NfvoNsInst Status to {} and saving to DB", nsStatus); - databaseServiceProvider.updateNsInstState(nsInstId, nsStatus); - } - - protected NfvoNsInst getNfvoNsInst(final DelegateExecution execution) { - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - return getNfvoNsInst(execution, nsInstId); - } - - protected NfvoNsInst getNfvoNsInst(final DelegateExecution execution, final String nsInstId) { - logger.info("Getting NfvoNsInst to update with nsInstId: {}", nsInstId); - final Optional<NfvoNsInst> optionalNfvoNsInst = databaseServiceProvider.getNfvoNsInst(nsInstId); - - if (optionalNfvoNsInst.isEmpty()) { - final String message = "Unable to find NS Instance in database using id: " + nsInstId; - abortOperation(execution, message); - } - - return optionalNfvoNsInst.get(); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/CreateInstantiateRequest.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/CreateInstantiateRequest.java deleted file mode 100644 index 569d9b3352..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/CreateInstantiateRequest.java +++ /dev/null @@ -1,167 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks; - -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.utils.Utils.toIndentedString; -import java.io.Serializable; -import java.util.Map; -import java.util.Objects; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.Tenant; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class CreateInstantiateRequest implements Serializable { - private static final long serialVersionUID = -4371264952509580468L; - private String nsInstId; - private String vnfdId; - private String vnfName; - private String vnfPkgId; - private String nfType; - private Tenant tenant; - private Map<String, String> additionalParams; - - public String getNsInstId() { - return nsInstId; - } - - public void setNsInstId(final String nsInstId) { - this.nsInstId = nsInstId; - } - - public CreateInstantiateRequest nsInstId(final String nsInstId) { - this.nsInstId = nsInstId; - return this; - } - - public final String getVnfdId() { - return vnfdId; - } - - public final void setVnfdId(final String vnfdId) { - this.vnfdId = vnfdId; - } - - public CreateInstantiateRequest vnfdId(final String vnfdId) { - this.vnfdId = vnfdId; - return this; - } - - public final String getVnfName() { - return vnfName; - } - - public final void setVnfName(final String vnfName) { - this.vnfName = vnfName; - } - - public CreateInstantiateRequest vnfName(final String vnfName) { - this.vnfName = vnfName; - return this; - } - - public final String getVnfPkgId() { - return vnfPkgId; - } - - public final void setVnfPkgId(final String vnfPkgId) { - this.vnfPkgId = vnfPkgId; - } - - public CreateInstantiateRequest vnfPkgId(final String vnfPkgId) { - this.vnfPkgId = vnfPkgId; - return this; - } - - public final String getNfType() { - return nfType; - } - - public final void setNfType(final String nfType) { - this.nfType = nfType; - } - - public CreateInstantiateRequest nfType(final String nfType) { - this.nfType = nfType; - return this; - } - - public final Tenant getTenant() { - return tenant; - } - - public final void setTenant(final Tenant tenant) { - this.tenant = tenant; - } - - public CreateInstantiateRequest tenant(final Tenant tenant) { - this.tenant = tenant; - return this; - } - - public final Map<String, String> getAdditionalParams() { - return additionalParams; - } - - public final void setAdditionalParams(final Map<String, String> additionalParams) { - this.additionalParams = additionalParams; - } - - public CreateInstantiateRequest additionalParams(final Map<String, String> additionalParams) { - this.additionalParams = additionalParams; - return this; - } - - @Override - public int hashCode() { - return Objects.hash(nsInstId, vnfdId, vnfName, vnfPkgId, nfType, tenant, additionalParams); - } - - @Override - public boolean equals(final Object obj) { - if (obj instanceof CreateInstantiateRequest) { - final CreateInstantiateRequest other = (CreateInstantiateRequest) obj; - return Objects.equals(nsInstId, other.nsInstId) && Objects.equals(vnfdId, other.vnfdId) - && Objects.equals(vnfName, other.vnfName) && Objects.equals(vnfPkgId, other.vnfPkgId) - && Objects.equals(nfType, other.nfType) && Objects.equals(tenant, other.tenant) - && Objects.equals(additionalParams, other.additionalParams); - } - return false; - } - - @Override - public String toString() { - final StringBuilder sb = new StringBuilder(); - sb.append("class CreateInstantiateRequest {\n"); - sb.append(" nsInstId: ").append(toIndentedString(nsInstId)).append("\n"); - sb.append(" vnfdId: ").append(toIndentedString(vnfdId)).append("\n"); - sb.append(" vnfName: ").append(toIndentedString(vnfName)).append("\n"); - sb.append(" vnfPkgId: ").append(toIndentedString(vnfPkgId)).append("\n"); - sb.append(" nfType: ").append(toIndentedString(nfType)).append("\n"); - sb.append(" tenant: ").append(toIndentedString(tenant)).append("\n"); - sb.append(" additionalParams: ").append(toIndentedString(additionalParams)).append("\n"); - - sb.append("}"); - return sb.toString(); - } - - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/CreateInstantiateVnfTask.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/CreateInstantiateVnfTask.java deleted file mode 100644 index 0d4cbbe24f..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/CreateInstantiateVnfTask.java +++ /dev/null @@ -1,221 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks; - -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NS_INSTANCE_ID_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.ERROR; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.FINISHED; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.IN_PROGRESS; -import java.time.LocalDateTime; -import java.util.Optional; -import org.camunda.bpm.engine.delegate.DelegateExecution; -import org.onap.aai.domain.yang.GenericVnf; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.CreateVnfRequest; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.CreateVnfResponse; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.Tenant; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.aai.AaiServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.vnfm.Sol003AdapterServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNfInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - */ -@Component -public class CreateInstantiateVnfTask extends AbstractNetworkServiceTask { - private static final String CREATE_INSTANTIATE_REQUEST_PARAM_NAME = "request"; - private static final Logger logger = LoggerFactory.getLogger(CreateInstantiateVnfTask.class); - private static final String NF_INST_ID_PARAM_NAME = "NF_INST_ID"; - public static final String CREATE_VNF_RESPONSE_PARAM_NAME = "createVnfResponse"; - private final AaiServiceProvider aaiServiceProvider; - private final Sol003AdapterServiceProvider sol003AdapterServiceProvider; - - @Autowired - public CreateInstantiateVnfTask(final DatabaseServiceProvider databaseServiceProvider, - final AaiServiceProvider aaiServiceProvider, - final Sol003AdapterServiceProvider sol003AdapterServiceProvider) { - super(databaseServiceProvider); - this.aaiServiceProvider = aaiServiceProvider; - this.sol003AdapterServiceProvider = sol003AdapterServiceProvider; - } - - public void checkIfNfInstanceExistsInDb(final DelegateExecution execution) { - logger.info("Executing checkIfNfInstanceInDb"); - final CreateInstantiateRequest request = - (CreateInstantiateRequest) execution.getVariable(CREATE_INSTANTIATE_REQUEST_PARAM_NAME); - logger.info("request: {}", request); - - addJobStatus(execution, JobStatusEnum.IN_PROGRESS, "Checking if NF Instance record exists in database for " - + request.getNsInstId() + " and " + request.getVnfName()); - if (!databaseServiceProvider.isNsInstExists(request.getNsInstId(), request.getVnfName())) { - abortOperation(execution, - request.getNsInstId() + " " + request.getVnfName() + " VNF instance already exists"); - } - logger.info("Finished executing checkIfNfInstanceInDb ..."); - - } - - public void createNfInstanceInDb(final DelegateExecution execution) { - logger.info("Executing createNfInstanceInDb"); - final CreateInstantiateRequest request = - (CreateInstantiateRequest) execution.getVariable(CREATE_INSTANTIATE_REQUEST_PARAM_NAME); - logger.info("request: {}", request); - - addJobStatus(execution, IN_PROGRESS, "Creating NF Instance record in database for " + request.getVnfName()); - - final Optional<NfvoNsInst> optional = databaseServiceProvider.getNfvoNsInst(request.getNsInstId()); - - if (optional.isEmpty()) { - abortOperation(execution, "NfvoNsInst: " + request.getNsInstId() + "not founda"); - } - - final NfvoNsInst nfvoNsInst = optional.get(); - final LocalDateTime now = LocalDateTime.now(); - final NfvoNfInst nfvoNfInst = new NfvoNfInst().status(State.NOT_INSTANTIATED).createTime(now) - .lastUpdateTime(now).name(request.getVnfName()).vnfdId(request.getVnfdId()) - .packageId(request.getVnfPkgId()).nfvoNsInst(nfvoNsInst); - databaseServiceProvider.saveNfvoNfInst(nfvoNfInst); - execution.setVariable(NF_INST_ID_PARAM_NAME, nfvoNfInst.getNfInstId()); - logger.info("Finished executing createNfInstanceInDb ..."); - - } - - public void createGenericVnfInAai(final DelegateExecution execution) { - logger.info("Executing createGenericVnfInAai"); - try { - final CreateInstantiateRequest request = - (CreateInstantiateRequest) execution.getVariable(CREATE_INSTANTIATE_REQUEST_PARAM_NAME); - - addJobStatus(execution, IN_PROGRESS, "Creating GenericVnf record in AAI for " + request.getVnfName()); - - final String nfInstId = (String) execution.getVariable(NF_INST_ID_PARAM_NAME); - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - final NfvoNsInst nfvoNsInst = getNfvoNsInst(execution, nsInstId); - - final GenericVnf genericVnf = new GenericVnf(); - genericVnf.setVnfId(nfInstId); - genericVnf.setVnfName(request.getVnfName()); - genericVnf.setVnfType(nfvoNsInst.getName() + "/" + request.getVnfName()); - genericVnf.setServiceId(request.getNsInstId()); - genericVnf.setNfType(request.getNfType()); - genericVnf.setOperationalStatus("Created"); - genericVnf.setIsClosedLoopDisabled(false); - - aaiServiceProvider.createGenericVnfAndConnectServiceInstance(nsInstId, nfInstId, genericVnf); - - final Tenant tenant = request.getTenant(); - aaiServiceProvider.connectGenericVnfToTenant(nfInstId, tenant.getCloudOwner(), tenant.getRegionName(), - tenant.getTenantId()); - - } catch (final Exception exception) { - final String message = "Unable to Create GenericVnf in AAI"; - logger.error(message, exception); - abortOperation(execution, message); - } - - logger.info("Finished executing createGenericVnfInAai ..."); - } - - public void invokeCreateInstantiationRequest(final DelegateExecution execution) { - logger.info("Executing invokeCreateInstantiationRequest"); - - try { - final CreateInstantiateRequest request = - (CreateInstantiateRequest) execution.getVariable(CREATE_INSTANTIATE_REQUEST_PARAM_NAME); - logger.info("request: {}", request); - - addJobStatus(execution, IN_PROGRESS, - "Invoking SOL003 adapter for creating and instantiating VNF: " + request.getVnfName()); - - final CreateVnfRequest vnfRequest = new CreateVnfRequest(); - vnfRequest.setTenant(request.getTenant()); - vnfRequest.setName(request.getVnfName()); - vnfRequest.setPkgId(request.getVnfPkgId()); - vnfRequest.setAdditionalParams(request.getAdditionalParams()); - final String vnfId = (String) execution.getVariable(NF_INST_ID_PARAM_NAME); - final Optional<CreateVnfResponse> optional = - sol003AdapterServiceProvider.invokeCreateInstantiationRequest(vnfId, vnfRequest); - - if (!optional.isPresent()) { - final String errorMessage = "Unexpected error while processing create and instantiation request"; - logger.error(errorMessage); - abortOperation(execution, errorMessage); - } - - final CreateVnfResponse vnfResponse = optional.get(); - - logger.info("Vnf instantiation response: {}", vnfResponse); - execution.setVariable(CREATE_VNF_RESPONSE_PARAM_NAME, vnfResponse); - addJobStatus(execution, IN_PROGRESS, "Successfully invoked SOL003 adapater creating and instantiating VNF: " - + request.getVnfName() + " CreaetVnfResponse Job Id: " + vnfResponse.getJobId()); - logger.debug("Finished executing invokeCreateInstantiationRequest ..."); - } catch (final Exception exception) { - final String message = "Unable to invoke create and instantiation request"; - logger.error(message, exception); - abortOperation(execution, message); - } - - } - - public void updateNfInstanceStatusToInstantiated(final DelegateExecution execution) { - logger.info("Executing updateNfInstanceStatusToInstantiated"); - - updateNfInstanceStatus(execution, State.INSTANTIATED); - final CreateInstantiateRequest request = - (CreateInstantiateRequest) execution.getVariable(CREATE_INSTANTIATE_REQUEST_PARAM_NAME); - addJobStatus(execution, FINISHED, "Successfully created and Instantiated VNF: " + request.getVnfName() - + " will set status to " + State.INSTANTIATED); - - logger.info("Finished executing updateNfInstanceStatusToInstantiated ..."); - - } - - public void updateNfInstanceStatusToFailed(final DelegateExecution execution) { - logger.info("Executing updateNfInstanceStatusToFailed"); - - updateNfInstanceStatus(execution, State.FAILED); - final CreateInstantiateRequest request = - (CreateInstantiateRequest) execution.getVariable(CREATE_INSTANTIATE_REQUEST_PARAM_NAME); - addJobStatus(execution, ERROR, "Failed to create and instantiate VNF: " + request.getVnfName() - + " will set status to " + State.FAILED); - - logger.info("Finished executing updateNfInstanceStatusToFailed ..."); - - } - - private void updateNfInstanceStatus(final DelegateExecution execution, final State vnfStatus) { - final String nfInstId = (String) execution.getVariable(NF_INST_ID_PARAM_NAME); - final boolean isSuccessful = databaseServiceProvider.updateNfInstState(nfInstId, vnfStatus); - if (!isSuccessful) { - final String message = - "Unable to update NfvoNfInst " + nfInstId + " status to" + vnfStatus + " in database"; - logger.error(message); - abortOperation(execution, message); - } - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/CreateNsTask.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/CreateNsTask.java deleted file mode 100644 index 2cf68bee14..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/CreateNsTask.java +++ /dev/null @@ -1,221 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks; - -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.CREATE_NS_REQUEST_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.CREATE_NS_RESPONSE_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.GLOBAL_CUSTOMER_ID_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NS_INSTANCE_ID_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NS_PACKAGE_MODEL_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.SERVICE_TYPE_PARAM_NAME; -import java.time.LocalDateTime; -import java.util.Optional; -import java.util.UUID; -import org.camunda.bpm.engine.delegate.DelegateExecution; -import org.onap.aai.domain.yang.ServiceInstance; -import org.onap.so.adapters.etsisol003adapter.pkgm.extclients.etsicatalog.model.NsdInfo; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.exceptions.EtsiCatalogManagerRequestFailureException; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.aai.AaiServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.etsicatalog.EtsiCatalogPackageManagementServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.model.CreateNsRequest; -import org.onap.so.etsi.nfvo.ns.lcm.model.InlineResponse400; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsInstancesNsInstance; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsInstancesNsInstance.NsStateEnum; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Component -public class CreateNsTask extends AbstractNetworkServiceTask { - private static final String NETWORK_SERVICE_NAME = "NetworkService"; - private static final String NETWORK_SERVICE_ROLE = "NetworkService"; - private static final String DOES_NS_PACKAGE_EXISTS_PARAM_NAME = "doesNsPackageExists"; - private static final String DOES_NS_INSTANCE_EXISTS_PARAM_NAME = "doesNsInstanceExists"; - private static final Logger logger = LoggerFactory.getLogger(CreateNsTask.class); - private final EtsiCatalogPackageManagementServiceProvider etsiCatalogPackageManagementServiceProvider; - private final AaiServiceProvider aaiServiceProvider; - - @Autowired - public CreateNsTask(final DatabaseServiceProvider databaseServiceProvider, - final AaiServiceProvider aaiServiceProvider, - final EtsiCatalogPackageManagementServiceProvider etsiCatalogPackageManagementServiceProvider) { - super(databaseServiceProvider); - this.aaiServiceProvider = aaiServiceProvider; - this.etsiCatalogPackageManagementServiceProvider = etsiCatalogPackageManagementServiceProvider; - } - - public void setJobStatusToStarted(final DelegateExecution execution) { - setJobStatus(execution, JobStatusEnum.STARTED, "Create NS workflow process started"); - } - - public void setJobStatusToFinished(final DelegateExecution execution) { - setJobStatus(execution, JobStatusEnum.FINISHED, "Create NS workflow process finished"); - } - - public void setJobStatusToError(final DelegateExecution execution) { - setJobStatusToError(execution, "Create NS workflow process failed"); - } - - public void getNsPackage(final DelegateExecution execution) { - logger.info("Retrieving NS package from ETSI Catalog Manager ..."); - setJobStatus(execution, JobStatusEnum.IN_PROGRESS, "Retrieving NS package from ETSI Catalog Manager"); - - final CreateNsRequest createNsRequest = (CreateNsRequest) execution.getVariable(CREATE_NS_REQUEST_PARAM_NAME); - - try { - final Optional<NsdInfo> optional = - etsiCatalogPackageManagementServiceProvider.getNSPackageModel(createNsRequest.getNsdId()); - - if (optional.isPresent()) { - final NsdInfo packageModel = optional.get(); - logger.info("NS Package exists {}", packageModel); - execution.setVariable(NS_PACKAGE_MODEL_PARAM_NAME, packageModel); - execution.setVariable(DOES_NS_PACKAGE_EXISTS_PARAM_NAME, true); - } else { - final String message = "Unable to find NS package using NsdId: " + createNsRequest.getNsdId(); - logger.error(message); - execution.setVariable(DOES_NS_PACKAGE_EXISTS_PARAM_NAME, false); - execution.setVariable(NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME, - new InlineResponse400().detail(message)); - } - - } catch (final EtsiCatalogManagerRequestFailureException failureException) { - final String message = - "Unexpected exception occured while getting ns package using nsdId: " + createNsRequest.getNsdId(); - logger.error(message, failureException); - - execution.setVariable(DOES_NS_PACKAGE_EXISTS_PARAM_NAME, false); - - execution.setVariable(NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME, - new InlineResponse400().title(message).detail(message)); - } - - } - - public void doesNsInstanceExistsInDb(final DelegateExecution execution) { - logger.info("Executing doesNsInstanceExistsInDb ..."); - - setJobStatus(execution, JobStatusEnum.IN_PROGRESS, "Checking if NS package exists in database"); - - final CreateNsRequest createNsRequest = - (CreateNsRequest) execution.getVariables().get(CREATE_NS_REQUEST_PARAM_NAME); - - final boolean exists = databaseServiceProvider.isNsInstExists(createNsRequest.getNsName()); - logger.info("Ns Instance entry {} exists in database", exists ? "does" : "doesn't"); - execution.setVariable(DOES_NS_INSTANCE_EXISTS_PARAM_NAME, exists); - - if (exists) { - final Optional<NfvoNsInst> optional = - databaseServiceProvider.getNfvoNsInstByName(createNsRequest.getNsName()); - final NfvoNsInst nfvoNsInst = optional.get(); - execution.setVariable(NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME, new InlineResponse400() - .detail("Ns Instance already exists in database : " + nfvoNsInst.toString())); - } - - logger.info("Finished executing doesNsInstanceExistsInDb ..."); - - } - - public void createNsInstanceInDb(final DelegateExecution execution) { - logger.info("Executing createNsInstanceInDb ..."); - - setJobStatus(execution, JobStatusEnum.IN_PROGRESS, "Checking if NS package exists"); - - final CreateNsRequest createNsRequest = (CreateNsRequest) execution.getVariable(CREATE_NS_REQUEST_PARAM_NAME); - final NsdInfo packageMode = (NsdInfo) execution.getVariable(NS_PACKAGE_MODEL_PARAM_NAME); - - final String globalCustomerId = (String) execution.getVariable(GLOBAL_CUSTOMER_ID_PARAM_NAME); - final String serviceType = (String) execution.getVariable(SERVICE_TYPE_PARAM_NAME); - - final String nsInstId = UUID.randomUUID().toString(); - execution.setVariable(NS_INSTANCE_ID_PARAM_NAME, nsInstId); - - databaseServiceProvider.saveNfvoNsInst(new NfvoNsInst().nsInstId(nsInstId).name(createNsRequest.getNsName()) - .nsPackageId(packageMode.getId()).nsdId(packageMode.getNsdId()) - .nsdInvariantId(packageMode.getNsdInvariantId()).description(createNsRequest.getNsDescription()) - .status(State.NOT_INSTANTIATED).statusUpdatedTime(LocalDateTime.now()) - .globalCustomerId(globalCustomerId).serviceType(serviceType)); - logger.info("Finished executing createNsInstanceInDb ..."); - - } - - - public void createNsInstanceInAai(final DelegateExecution execution) { - logger.info("Executing createNsInstanceInAai ..."); - try { - setJobStatus(execution, JobStatusEnum.IN_PROGRESS, "Creating NS Instance in AAI"); - - final CreateNsRequest createNsRequest = - (CreateNsRequest) execution.getVariable(CREATE_NS_REQUEST_PARAM_NAME); - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - - final String globalCustomerId = (String) execution.getVariable(GLOBAL_CUSTOMER_ID_PARAM_NAME); - final String serviceType = (String) execution.getVariable(SERVICE_TYPE_PARAM_NAME); - - final ServiceInstance aaiServiceInstance = new ServiceInstance(); - aaiServiceInstance.setServiceInstanceId(nsInstId); - aaiServiceInstance.setServiceInstanceName(createNsRequest.getNsName()); - aaiServiceInstance.setServiceType(NETWORK_SERVICE_NAME); - aaiServiceInstance.setServiceRole(NETWORK_SERVICE_ROLE); - - aaiServiceProvider.createServiceInstance(globalCustomerId, serviceType, aaiServiceInstance); - } catch (final Exception exception) { - final String message = "Unable to Create Service Instance in AAI"; - logger.error(message, exception); - abortOperation(execution, message, new InlineResponse400().detail(message)); - } - logger.info("Finished executing createNsInstanceInAai ..."); - - } - - public void setCreateNsResponse(final DelegateExecution execution) { - logger.info("Executing setCreateNsResponse ..."); - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - final Optional<NfvoNsInst> optional = databaseServiceProvider.getNfvoNsInst(nsInstId); - - if (optional.isPresent()) { - final NfvoNsInst nfvoNsInst = optional.get(); - final NsInstancesNsInstance response = new NsInstancesNsInstance().id(nfvoNsInst.getNsInstId()) - .nsInstanceName(nfvoNsInst.getName()).nsdId(nfvoNsInst.getNsdId()) - .nsdInfoId(nfvoNsInst.getNsPackageId()).nsInstanceDescription(nfvoNsInst.getDescription()) - .nsState(NsStateEnum.fromValue(nfvoNsInst.getStatus().toString())); - logger.info("Saving CreateNsResponse: {} in Execution ...", response); - execution.setVariable(CREATE_NS_RESPONSE_PARAM_NAME, response); - } else { - final String message = "Unable to find NS Instance in datababse using id: " + nsInstId; - logger.error(message); - abortOperation(execution, message); - } - - logger.info("Finished executing setCreateNsResponse ..."); - - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/DeleteNsTask.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/DeleteNsTask.java deleted file mode 100644 index cd711fb3e8..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/DeleteNsTask.java +++ /dev/null @@ -1,140 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks; - -import org.camunda.bpm.engine.delegate.DelegateExecution; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.aai.AaiServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.model.InlineResponse400; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import java.util.Optional; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NS_INSTANCE_ID_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.FINISHED; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.IN_PROGRESS; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.STARTED; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.State.NOT_INSTANTIATED; - -/** - * @author Andrew Lamb (andrew.a.lamb@est.tech) - * - */ -@Component -public class DeleteNsTask extends AbstractNetworkServiceTask { - - private static final String NS_INSTANCE_EXISTS_PARAM_NAME = "nsInstanceExists"; - private static final String NS_INSTANCE_IS_IN_NOT_INSTANTIATED_STATE_PARAM_NAME = "isInNotInstantiatedState"; - private static final Logger logger = LoggerFactory.getLogger(DeleteNsTask.class); - private final AaiServiceProvider aaiServiceProvider; - - @Autowired - public DeleteNsTask(final DatabaseServiceProvider databaseServiceProvider, - final AaiServiceProvider aaiServiceProvider) { - super(databaseServiceProvider); - this.aaiServiceProvider = aaiServiceProvider; - } - - public void setJobStatusToStarted(final DelegateExecution execution) { - setJobStatus(execution, STARTED, "Delete NS workflow process started"); - } - - public void setJobStatusToFinished(final DelegateExecution execution) { - setJobStatus(execution, FINISHED, "Delete NS workflow process finished"); - } - - public void setJobStatusInProgress(final DelegateExecution execution, final String message) { - setJobStatus(execution, IN_PROGRESS, message); - } - - public void setJobStatusToError(final DelegateExecution execution) { - setJobStatusToError(execution, "Delete NS workflow process failed"); - } - - public void checkIfNsInstanceExistsInDb(final DelegateExecution execution) { - logger.info("Executing checkIfNsInstanceExistsInDb ..."); - setJobStatusInProgress(execution, "Checking that NS Instance Exists in DB"); - - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - final Optional<NfvoNsInst> optionalNfvoNsInst = databaseServiceProvider.getNfvoNsInst(nsInstId); - final boolean nsInstanceExists = optionalNfvoNsInst.isPresent(); - logger.info("NS Instance entry with id: {} {} exist in database", nsInstId, - nsInstanceExists ? "does" : "doesn't"); - execution.setVariable(NS_INSTANCE_EXISTS_PARAM_NAME, nsInstanceExists); - - if (!nsInstanceExists) { - final String message = - "NS Instance with id: " + nsInstId + " does not exist in database, so will not be deleted."; - logger.info(message); - execution.setVariable(NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME, new InlineResponse400().detail(message)); - } - - logger.info("Finished executing checkIfNsInstanceExistsInDb ..."); - } - - public void checkthatNsInstanceInDbIsInNotInstantiatedState(final DelegateExecution execution) { - logger.info("Executing checkthatNsInstanceInDbIsInNotInstantiatedState ..."); - setJobStatusInProgress(execution, "Checking that NS Instance is in NOT_INSTANTIATED state in Db"); - - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - final NfvoNsInst nfvoNsInst = getNfvoNsInst(execution, nsInstId); - final State nfvoNsInstState = nfvoNsInst.getStatus(); - final boolean nsInstanceIsNotInstantiated = NOT_INSTANTIATED.equals(nfvoNsInstState); - logger.info("Ns Instance entry with nsInstId: {} is in state: {}", nsInstId, nfvoNsInstState); - execution.setVariable(NS_INSTANCE_IS_IN_NOT_INSTANTIATED_STATE_PARAM_NAME, nsInstanceIsNotInstantiated); - - if (!nsInstanceIsNotInstantiated) { - final String message = - "Cannot Delete NS Instance with id: " + nsInstId + " in the state: " + nfvoNsInstState; - logger.info(message); - execution.setVariable(NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME, new InlineResponse400().detail(message)); - } - - logger.info("Finished executing checkthatNsInstanceInDbIsInNotInstantiatedState ..."); - } - - public void deleteNsInstanceFromAai(final DelegateExecution execution) { - logger.info("Executing deleteNsInstanceFromAAI ..."); - setJobStatusInProgress(execution, "Deleting NS Instance from AAI"); - - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - final NfvoNsInst nfvoNsInst = getNfvoNsInst(execution, nsInstId); - final String globalCustomerId = nfvoNsInst.getGlobalCustomerId(); - final String serviceType = nfvoNsInst.getServiceType(); - - aaiServiceProvider.deleteServiceInstance(globalCustomerId, serviceType, nsInstId); - - logger.info("Finished executing deleteNsInstanceFromAAI ..."); - } - - public void deleteNsInstanceFromDb(final DelegateExecution execution) { - logger.info("Executing deleteNsInstanceFromDb ..."); - setJobStatusInProgress(execution, "Deleting NS Instance from Db"); - - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - databaseServiceProvider.deleteNfvoNsInst(nsInstId); - - logger.info("Finished executing deleteNsInstanceFromDb ..."); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/InstantiateNsTask.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/InstantiateNsTask.java deleted file mode 100644 index aeb2d11934..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/InstantiateNsTask.java +++ /dev/null @@ -1,328 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks; - -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.INSTANTIATE_NS_REQUEST_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NETWORK_SERVICE_DESCRIPTOR_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NS_INSTANCE_ID_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.VNF_CREATE_INSTANTIATE_REQUESTS; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.FINISHED; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.IN_PROGRESS; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.STARTED; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Optional; -import org.apache.commons.lang3.StringUtils; -import org.camunda.bpm.engine.delegate.DelegateExecution; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.Tenant; -import org.onap.so.adapters.etsisol003adapter.pkgm.extclients.etsicatalog.model.NsdInfo; -import org.onap.so.adapters.etsisol003adapter.pkgm.extclients.etsicatalog.model.VnfPkgInfo; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.exceptions.EtsiCatalogManagerRequestFailureException; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.etsicatalog.EtsiCatalogPackageManagementServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.NetworkServiceDescriptor; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.VirtualNetworkFunction; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNfInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.model.InstantiateNsRequest; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsInstancesnsInstanceIdinstantiateAdditionalParamsForVnf; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * @author Andrew Lamb (andrew.a.lamb@est.tech) - * - */ -@Component -public class InstantiateNsTask extends AbstractNetworkServiceTask { - - private static final String IS_NS_INSTANTIATION_SUCCESSFUL_PARAM_NAME = "isNsInstantiationSuccessful"; - private static final String VNFD_ID_TO_VNF_PKG_ID_MAPPING_PARAM_NAME = "vnfdIdToVnfPkgIdMapping"; - private static final Logger logger = LoggerFactory.getLogger(InstantiateNsTask.class); - private final EtsiCatalogPackageManagementServiceProvider etsiCatalogPackageManagementServiceProvider; - - @Autowired - public InstantiateNsTask(final DatabaseServiceProvider databaseServiceProvider, - final EtsiCatalogPackageManagementServiceProvider etsiCatalogPackageManagementServiceProvider) { - super(databaseServiceProvider); - this.etsiCatalogPackageManagementServiceProvider = etsiCatalogPackageManagementServiceProvider; - - } - - public void setJobStatusToStarted(final DelegateExecution execution) { - setJobStatus(execution, STARTED, "Instantiate NS workflow process started"); - } - - public void setJobStatusToFinished(final DelegateExecution execution) { - setJobStatus(execution, FINISHED, "Instantiate NS workflow process finished"); - } - - public void updateNsInstanceStatusToInstantiating(final DelegateExecution execution) { - logger.info("Executing updateNsInstanceStatusToInstantiating"); - setJobStatus(execution, IN_PROGRESS, "Updating NfvoNsInst Status to " + State.INSTANTIATING); - updateNsInstanceStatus(execution, State.INSTANTIATING); - - logger.info("Finished executing updateNsInstanceStatusToInstantiating ..."); - } - - - public void checkIfVnfInstantiationWasSuccessful(final DelegateExecution execution) { - logger.info("Executing checkIfVnfInstantiationWasSuccessful"); - - @SuppressWarnings("unchecked") - final List<CreateInstantiateRequest> requests = - (List<CreateInstantiateRequest>) execution.getVariable(VNF_CREATE_INSTANTIATE_REQUESTS); - - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - final List<NfvoNfInst> nfInstances = databaseServiceProvider.getNfvoNfInstByNsInstId(nsInstId); - - if (nfInstances == null || nfInstances.isEmpty()) { - final String message = "Found empty nf instances"; - abortOperation(execution, message); - } - - if (requests.size() != nfInstances.size()) { - final String message = "Missing nf Instance. Request triggered: " + requests.size() - + " Nf Instace reqeust found in database " + nfInstances.size(); - abortOperation(execution, message); - } - - execution.setVariable(IS_NS_INSTANTIATION_SUCCESSFUL_PARAM_NAME, true); - - nfInstances.stream().forEach(instance -> { - if (!State.INSTANTIATED.equals(instance.getStatus())) { - logger.error("VNF : {} {} instantiation failed", instance.getNfInstId(), instance.getName()); - execution.setVariable(IS_NS_INSTANTIATION_SUCCESSFUL_PARAM_NAME, false); - } - }); - - logger.info("Finished executing checkIfVnfInstantiationWasSuccessful ..."); - } - - public void updateNsInstanceStatusToInstantiated(final DelegateExecution execution) { - logger.info("Executing updateNsInstanceStatusToInstantiated"); - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - setJobStatus(execution, FINISHED, "Successfully " + State.INSTANTIATED + " NS: " + nsInstId); - - updateNsInstanceStatus(execution, State.INSTANTIATED); - logger.info("Finished executing updateNsInstanceStatusToInstantiated ..."); - } - - public void getAndParseNsdFromEtsiCatalog(final DelegateExecution execution) { - logger.info("Executing getAndParseNsdFromEtsiCatalog"); - setJobStatus(execution, IN_PROGRESS, "Retrieving and parsing NSD from ETSI Catalog Manager"); - final NfvoNsInst nfvoNsInst = getNfvoNsInst(execution); - final String nsPackageId = nfvoNsInst.getNsPackageId(); - - try { - final Optional<NetworkServiceDescriptor> optional = - etsiCatalogPackageManagementServiceProvider.getNetworkServiceDescriptor(nsPackageId); - - if (optional.isEmpty()) { - final String message = "Unable to parse NSD " + nsPackageId; - logger.error(message); - abortOperation(execution, message); - } - - final NetworkServiceDescriptor networkServiceDescriptor = optional.get(); - logger.info("Found {}", networkServiceDescriptor); - execution.setVariable(NETWORK_SERVICE_DESCRIPTOR_PARAM_NAME, networkServiceDescriptor); - - } catch (final EtsiCatalogManagerRequestFailureException failureException) { - final String message = - "Unexpected exception occured while getting nsd content using nsPackageId: " + nsPackageId; - logger.error(message, failureException); - - abortOperation(execution, message); - } - - logger.info("Finished executing getAndParseNsdFromEtsiCatalog ..."); - - } - - public void prepareCreateInstantiateRequests(final DelegateExecution execution) { - logger.info("Executing prepareCreateInstantiateRequests ..."); - setJobStatus(execution, IN_PROGRESS, "Preparing VNF CreateInstantiate requests"); - final NetworkServiceDescriptor networkServiceDescriptor = - (NetworkServiceDescriptor) execution.getVariable(NETWORK_SERVICE_DESCRIPTOR_PARAM_NAME); - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - final NfvoNsInst nfvoNsInst = getNfvoNsInst(execution, nsInstId); - - final InstantiateNsRequest instantiateNsRequest = - (InstantiateNsRequest) execution.getVariable(INSTANTIATE_NS_REQUEST_PARAM_NAME); - - final List<NsInstancesnsInstanceIdinstantiateAdditionalParamsForVnf> additionalParamsForVnfList = - instantiateNsRequest.getAdditionalParamsForVnf(); - - @SuppressWarnings("unchecked") - final Map<String, String> vnfdIdToVnfPkgIdMapping = - (Map<String, String>) execution.getVariable(VNFD_ID_TO_VNF_PKG_ID_MAPPING_PARAM_NAME); - - final List<CreateInstantiateRequest> requests = new ArrayList<>(); - - for (final VirtualNetworkFunction vnf : networkServiceDescriptor.getVnfs()) { - final List<String> vnfmInfoList = vnf.getVnfmInfoList(); - - final String vnfdId = vnf.getVnfdId(); - final String vnfPkgId = vnfdIdToVnfPkgIdMapping.get(vnfdId); - if (vnfdId == null || vnfmInfoList.isEmpty() || vnfPkgId == null) { - final String message = "Unable to find VnfdId/vnfmInfo/VnfPkgId for vnf: " + vnf; - abortOperation(execution, message); - } - - final Optional<NsInstancesnsInstanceIdinstantiateAdditionalParamsForVnf> additionalParamsForVnfOptional = - getAdditionalParamsForVnf(vnfdId, additionalParamsForVnfList); - - if (additionalParamsForVnfOptional.isEmpty()) { - final String message = "Unable to find AdditionalParamsForVnf for " + vnfdId - + " in instantiateNsRequest : " + instantiateNsRequest; - abortOperation(execution, message); - } - - final NsInstancesnsInstanceIdinstantiateAdditionalParamsForVnf additionalParamsForVnf = - additionalParamsForVnfOptional.get(); - - @SuppressWarnings("unchecked") - final Map<String, String> additionalParams = - (Map<String, String>) additionalParamsForVnf.getAdditionalParams(); - - final Optional<Tenant> optional = getTenant(additionalParams); - if (optional.isEmpty()) { - final String message = "Unable to find Tenant information for " + vnfdId + " in instantiateNsRequest : " - + instantiateNsRequest; - abortOperation(execution, message); - } - - final String vnfInstanceName = additionalParamsForVnf.getVnfInstanceName(); - final String vnfName = StringUtils.isNotBlank(vnfInstanceName) ? vnfInstanceName - : nfvoNsInst.getName() + "." + vnf.getVnfName(); - - final CreateInstantiateRequest createInstantiateRequest = - new CreateInstantiateRequest().nsInstId(nsInstId).vnfdId(vnfdId).vnfName(vnfName).vnfPkgId(vnfPkgId) - .nfType(vnfmInfoList.get(0)).tenant(optional.get()).additionalParams(additionalParams); - - logger.info("Adding request to list: {}", createInstantiateRequest); - requests.add(createInstantiateRequest); - - } - execution.setVariable(VNF_CREATE_INSTANTIATE_REQUESTS, requests); - - logger.info("Finished executing prepareCreateInstantiateRequests ..."); - } - - public void getVnfPkgIdForEachVnfdId(final DelegateExecution execution) { - logger.info("Executing getVnfPkgIdForEachVnfdId ..."); - - setJobStatus(execution, IN_PROGRESS, "Getting VnfPkgId for each VnfdId"); - - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - final NfvoNsInst nfvoNsInst = getNfvoNsInst(execution, nsInstId); - final String nsPackageId = nfvoNsInst.getNsPackageId(); - - final Map<String, String> vnfdIdToVnfPkgIdMapping = new HashMap<>(); - try { - final Optional<NsdInfo> nsdInfoOptional = - etsiCatalogPackageManagementServiceProvider.getNSPackageModel(nsPackageId); - - if (nsdInfoOptional.isEmpty()) { - final String message = "Unable to find NS package using NS package id: " + nsPackageId; - logger.error(message); - abortOperation(execution, message); - } - - final NsdInfo nsdInfo = nsdInfoOptional.get(); - for (final String vnfPkgId : nsdInfo.getVnfPkgIds()) { - final Optional<VnfPkgInfo> optional = - etsiCatalogPackageManagementServiceProvider.getVnfPkgInfo(vnfPkgId); - - if (optional.isEmpty()) { - final String message = "Unable to find VNF package using NS vnfPkgId: " + vnfPkgId; - logger.error(message); - abortOperation(execution, message); - } - final VnfPkgInfo vnfPkgInfo = optional.get(); - vnfdIdToVnfPkgIdMapping.put(vnfPkgInfo.getVnfdId(), vnfPkgId); - - } - logger.info("vnfdIdToVnfPkgIdMapping: {}", vnfdIdToVnfPkgIdMapping); - execution.setVariable(VNFD_ID_TO_VNF_PKG_ID_MAPPING_PARAM_NAME, vnfdIdToVnfPkgIdMapping); - - } catch (final EtsiCatalogManagerRequestFailureException failureException) { - final String message = - "Unexpected exception occured while getting VNF package using nsPackageId: " + nsPackageId; - logger.error(message, failureException); - - abortOperation(execution, message); - } - - logger.info("Finished executing getVnfPkgIdForEachVnfdId ..."); - - } - - public void logTimeOut(final DelegateExecution execution) { - logger.error("Vnf instantiation timedOut ..."); - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - final List<NfvoNfInst> nfInstances = databaseServiceProvider.getNfvoNfInstByNsInstId(nsInstId); - if (nfInstances != null) { - nfInstances.stream().forEach(instance -> { - logger.info("Current status {} of vnf: {}", instance.getStatus(), instance.getName()); - }); - } - } - - public void setJobStatusToError(final DelegateExecution execution) { - updateNsInstanceStatus(execution, State.FAILED); - setJobStatusToError(execution, "Instantiate NS workflow process failed"); - } - - private Optional<Tenant> getTenant(final Map<String, String> additionalParams) { - final String vimId = additionalParams.get("vim_id"); - if (vimId != null) { - final String[] splitString = vimId.split("_"); - if (splitString.length == 3) { - logger.info("Found Tenant in additionalParams: {}", additionalParams); - return Optional.of( - new Tenant().cloudOwner(splitString[0]).regionName(splitString[1]).tenantId(splitString[2])); - } - - } - logger.error("Unable to find Tenant in additionalParams: {}", additionalParams); - return Optional.empty(); - } - - private Optional<NsInstancesnsInstanceIdinstantiateAdditionalParamsForVnf> getAdditionalParamsForVnf( - final String vnfdId, - final List<NsInstancesnsInstanceIdinstantiateAdditionalParamsForVnf> additionalParamsForVnfList) { - final Optional<NsInstancesnsInstanceIdinstantiateAdditionalParamsForVnf> optional = - additionalParamsForVnfList.stream().filter(entry -> vnfdId.equals(entry.getVnfProfileId())).findFirst(); - if (optional.isPresent()) { - logger.info("Found AdditionalParamsForVnf in instantiateNsRequest using vnfdId: {}", vnfdId); - - } - return optional; - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorInstantiateSol003AdapterNodeTask.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorInstantiateSol003AdapterNodeTask.java deleted file mode 100644 index 51fa6b9381..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorInstantiateSol003AdapterNodeTask.java +++ /dev/null @@ -1,52 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks; - -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.aai.AaiServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Component -public class MonitorInstantiateSol003AdapterNodeTask extends MonitorSol003AdapterNodeTask { - public static final String CREATE_VNF_NODE_STATUS = "createVnfNodeStatus"; - public static final String VNF_CREATED = "Created"; - - @Autowired - public MonitorInstantiateSol003AdapterNodeTask(final DatabaseServiceProvider databaseServiceProvider, - final AaiServiceProvider aaiServiceProvider) { - super(databaseServiceProvider, aaiServiceProvider); - } - - @Override - public String getNodeStatusVariableName() { - return CREATE_VNF_NODE_STATUS; - } - - @Override - public boolean isOrchestrationStatusValid(final String orchestrationStatus) { - return VNF_CREATED.equalsIgnoreCase(orchestrationStatus); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterCreateJobTask.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterCreateJobTask.java deleted file mode 100644 index 3c91598dfb..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterCreateJobTask.java +++ /dev/null @@ -1,105 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks; - -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.CREATE_VNF_RESPONSE_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.OPERATION_STATUS_PARAM_NAME; -import org.camunda.bpm.engine.delegate.DelegateExecution; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.CreateVnfResponse; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.OperationStateEnum; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.vnfm.Sol003AdapterServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Component -public class MonitorSol003AdapterCreateJobTask extends MonitorSol003AdapterJobTask { - - private static final Logger LOGGER = LoggerFactory.getLogger(MonitorSol003AdapterCreateJobTask.class); - - @Autowired - public MonitorSol003AdapterCreateJobTask(final Sol003AdapterServiceProvider sol003AdapterServiceProvider, - final DatabaseServiceProvider databaseServiceProvider) { - super(sol003AdapterServiceProvider, databaseServiceProvider); - } - - public void getCurrentOperationStatus(final DelegateExecution execution) { - try { - LOGGER.debug("Executing getCurrentOperationStatus ..."); - final CreateVnfResponse vnfInstantiateResponse = - (CreateVnfResponse) execution.getVariable(CREATE_VNF_RESPONSE_PARAM_NAME); - execution.setVariable(OPERATION_STATUS_PARAM_NAME, - getOperationStatus(execution, vnfInstantiateResponse.getJobId())); - LOGGER.debug("Finished executing getCurrentOperationStatus ..."); - } catch (final Exception exception) { - final String message = "Unable to invoke get current Operation status"; - LOGGER.error(message, exception); - abortOperation(execution, message); - - } - } - - /** - * Log and throw exception on timeout for job status - * - * @param execution {@link org.onap.so.bpmn.common.DelegateExecutionImpl} - */ - public void timeOutLogFailue(final DelegateExecution execution) { - final String message = "Instantiation operation time out"; - LOGGER.error(message); - abortOperation(execution, message); - } - - /** - * Check the final status of instantiation throw exception if not completed successfully - * - * @param execution {@link org.onap.so.bpmn.common.DelegateExecutionImpl} - */ - public void checkIfOperationWasSuccessful(final DelegateExecution execution) { - LOGGER.debug("Executing checkIfOperationWasSuccessful ..."); - final OperationStateEnum operationStatus = - (OperationStateEnum) execution.getVariable(OPERATION_STATUS_PARAM_NAME); - final CreateVnfResponse vnfInstantiateResponse = - (CreateVnfResponse) execution.getVariable(CREATE_VNF_RESPONSE_PARAM_NAME); - - if (operationStatus == null) { - final String message = "Unable to instantiate jobId: " - + (vnfInstantiateResponse != null ? vnfInstantiateResponse.getJobId() : "null") - + "Unable to retrieve OperationStatus"; - LOGGER.error(message); - abortOperation(execution, message); - } - if (operationStatus != OperationStateEnum.COMPLETED) { - final String message = "Unable to instantiate jobId: " - + (vnfInstantiateResponse != null ? vnfInstantiateResponse.getJobId() : "null") - + " OperationStatus: " + operationStatus; - LOGGER.error(message); - abortOperation(execution, message); - } - - LOGGER.debug("Successfully completed instatiation of job {}", vnfInstantiateResponse); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterJobTask.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterJobTask.java deleted file mode 100644 index bac79dfa3e..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterJobTask.java +++ /dev/null @@ -1,96 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks; - -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.OPERATION_STATUS_PARAM_NAME; -import java.util.Optional; -import org.camunda.bpm.engine.delegate.DelegateExecution; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.OperationStateEnum; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.OperationStatusRetrievalStatusEnum; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.QueryJobResponse; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.vnfm.Sol003AdapterServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import com.google.common.collect.ImmutableSet; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Component -public class MonitorSol003AdapterJobTask extends AbstractNetworkServiceTask { - - private static final Logger LOGGER = LoggerFactory.getLogger(MonitorSol003AdapterJobTask.class); - public static final ImmutableSet<OperationStateEnum> OPERATION_FINISHED_STATES = - ImmutableSet.of(OperationStateEnum.COMPLETED, OperationStateEnum.FAILED, OperationStateEnum.ROLLED_BACK); - public static final ImmutableSet<OperationStatusRetrievalStatusEnum> OPERATION_RETRIEVAL_STATES = ImmutableSet - .of(OperationStatusRetrievalStatusEnum.STATUS_FOUND, OperationStatusRetrievalStatusEnum.WAITING_FOR_STATUS); - protected final Sol003AdapterServiceProvider sol003AdapterServiceProvider; - - @Autowired - public MonitorSol003AdapterJobTask(final Sol003AdapterServiceProvider sol003AdapterServiceProvider, - final DatabaseServiceProvider databaseServiceProvider) { - super(databaseServiceProvider); - this.sol003AdapterServiceProvider = sol003AdapterServiceProvider; - } - - public boolean hasOperationFinished(final DelegateExecution execution) { - LOGGER.debug("Executing hasOperationFinished ..."); - - final OperationStateEnum operationStatus = - (OperationStateEnum) execution.getVariable(OPERATION_STATUS_PARAM_NAME); - if (operationStatus != null) { - return OPERATION_FINISHED_STATES.contains(operationStatus); - } - LOGGER.debug("OperationStatus is not present yet... "); - LOGGER.debug("Finished executing hasOperationFinished ..."); - return false; - } - - protected OperationStateEnum getOperationStatus(final DelegateExecution execution, final String jobId) { - - final Optional<QueryJobResponse> instantiateOperationJobStatus = - sol003AdapterServiceProvider.getInstantiateOperationJobStatus(jobId); - - if (instantiateOperationJobStatus.isPresent()) { - final QueryJobResponse queryJobResponse = instantiateOperationJobStatus.get(); - - if (!OPERATION_RETRIEVAL_STATES.contains(queryJobResponse.getOperationStatusRetrievalStatus())) { - final String message = "Received invalid operation retrieval state: " - + queryJobResponse.getOperationStatusRetrievalStatus(); - LOGGER.error(message); - abortOperation(execution, message); - } - if (queryJobResponse.getOperationState() != null) { - final OperationStateEnum operationStatus = queryJobResponse.getOperationState(); - LOGGER.debug("Operation {} with {} and operation retrieval status : {}", queryJobResponse.getId(), - operationStatus, queryJobResponse.getOperationStatusRetrievalStatus()); - return queryJobResponse.getOperationState(); - } - - LOGGER.debug("Operation {} without operationStatus and operation retrieval status :{}", - queryJobResponse.getId(), queryJobResponse.getOperationStatusRetrievalStatus()); - } - return null; - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterNodeTask.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterNodeTask.java deleted file mode 100644 index 001c369801..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterNodeTask.java +++ /dev/null @@ -1,96 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks; - -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NF_INST_ID_PARAM_NAME; -import java.util.Optional; -import org.camunda.bpm.engine.delegate.DelegateExecution; -import org.onap.aai.domain.yang.GenericVnf; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.aai.AaiServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public abstract class MonitorSol003AdapterNodeTask extends AbstractNetworkServiceTask { - - private static final Logger LOGGER = LoggerFactory.getLogger(MonitorSol003AdapterNodeTask.class); - private final AaiServiceProvider aaiServiceProvider; - - protected MonitorSol003AdapterNodeTask(final DatabaseServiceProvider databaseServiceProvider, - final AaiServiceProvider aaiServiceProvider) { - super(databaseServiceProvider); - this.aaiServiceProvider = aaiServiceProvider; - } - - /** - * Check the final status of vnf in A&AI - * - * @param execution {@link org.onap.so.bpmn.common.DelegateExecutionImpl} - */ - public void getNodeStatus(final DelegateExecution execution) { - try { - LOGGER.debug("Executing getNodeStatus ..."); - final String vnfId = (String) execution.getVariable(NF_INST_ID_PARAM_NAME); - - LOGGER.debug("Query A&AI for generic VNF using vnfID: {}", vnfId); - final Optional<GenericVnf> aaiGenericVnfOptional = aaiServiceProvider.getGenericVnf(vnfId); - - if (aaiGenericVnfOptional.isEmpty()) { - abortOperation(execution, "Unable to find generic vnf in A&AI using vnfId" + vnfId); - } - final GenericVnf genericVnf = aaiGenericVnfOptional.get(); - final String orchestrationStatus = genericVnf.getOrchestrationStatus(); - LOGGER.debug("Found generic vnf with orchestration status : {}", orchestrationStatus); - - execution.setVariable(getNodeStatusVariableName(), isOrchestrationStatusValid(orchestrationStatus)); - - } catch (final Exception exception) { - LOGGER.error("Unable to get vnf from AAI", exception); - abortOperation(execution, "Unable to get vnf from AAI"); - } - } - - /** - * Get variable to store in execution context - * - * @return the variable name - */ - public abstract String getNodeStatusVariableName(); - - /** - * @param orchestrationStatus the orchestration status from A&AI - * @return true if valid - */ - public abstract boolean isOrchestrationStatusValid(final String orchestrationStatus); - - public void timeOutLogFailue(final DelegateExecution execution) { - final String message = "Node operation time out"; - LOGGER.error(message); - abortOperation(execution, message); - } - - AaiServiceProvider getAaiServiceProvider() { - return aaiServiceProvider; - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterTerminateJobTask.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterTerminateJobTask.java deleted file mode 100644 index d85444497d..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterTerminateJobTask.java +++ /dev/null @@ -1,106 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks; - -import org.camunda.bpm.engine.delegate.DelegateExecution; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.DeleteVnfResponse; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.OperationStateEnum; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.vnfm.Sol003AdapterServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.OPERATION_STATUS_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.DELETE_VNF_RESPONSE_PARAM_NAME; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * @author Andrew Lamb (andrew.a.lamb@est.tech) - * - */ -@Component -public class MonitorSol003AdapterTerminateJobTask extends MonitorSol003AdapterJobTask { - - private static final Logger LOGGER = LoggerFactory.getLogger(MonitorSol003AdapterTerminateJobTask.class); - - @Autowired - public MonitorSol003AdapterTerminateJobTask(final Sol003AdapterServiceProvider sol003AdapterServiceProvider, - final DatabaseServiceProvider databaseServiceProvider) { - super(sol003AdapterServiceProvider, databaseServiceProvider); - } - - public void getCurrentOperationStatus(final DelegateExecution execution) { - try { - LOGGER.debug("Executing getCurrentOperationStatus ..."); - final DeleteVnfResponse deleteVnfResponse = - (DeleteVnfResponse) execution.getVariable(DELETE_VNF_RESPONSE_PARAM_NAME); - execution.setVariable(OPERATION_STATUS_PARAM_NAME, - getOperationStatus(execution, deleteVnfResponse.getJobId())); - LOGGER.debug("Finished executing getCurrentOperationStatus ..."); - } catch (final Exception exception) { - final String message = "Unable to invoke get current Operation status"; - LOGGER.error(message, exception); - abortOperation(execution, message); - - } - } - - /** - * Log and throw exception on timeout for job status - * - * @param execution {@link org.onap.so.bpmn.common.DelegateExecutionImpl} - */ - public void timeOutLogFailure(final DelegateExecution execution) { - final String message = "Termination operation time out"; - LOGGER.error(message); - abortOperation(execution, message); - } - - /** - * Check the final status of termination throw exception if not completed successfully - * - * @param execution {@link org.onap.so.bpmn.common.DelegateExecutionImpl} - */ - public void checkIfOperationWasSuccessful(final DelegateExecution execution) { - LOGGER.debug("Executing checkIfOperationWasSuccessful ..."); - final OperationStateEnum operationStatus = - (OperationStateEnum) execution.getVariable(OPERATION_STATUS_PARAM_NAME); - final DeleteVnfResponse deleteVnfResponse = - (DeleteVnfResponse) execution.getVariable(DELETE_VNF_RESPONSE_PARAM_NAME); - - if (operationStatus == null) { - final String message = - "Unable to terminate, jobId: " + (deleteVnfResponse != null ? deleteVnfResponse.getJobId() : "null") - + "Unable to retrieve OperationStatus"; - LOGGER.error(message); - abortOperation(execution, message); - } - if (operationStatus != OperationStateEnum.COMPLETED) { - final String message = - "Unable to terminate, jobId: " + (deleteVnfResponse != null ? deleteVnfResponse.getJobId() : "null") - + " OperationStatus: " + operationStatus; - LOGGER.error(message); - abortOperation(execution, message); - } - - LOGGER.debug("Successfully completed termination of job {}", deleteVnfResponse); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterTerminateNodeTask.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterTerminateNodeTask.java deleted file mode 100644 index f38bdba71b..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/MonitorSol003AdapterTerminateNodeTask.java +++ /dev/null @@ -1,55 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks; - -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.aai.AaiServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; - - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * @author Andrew Lamb (andrew.a.lamb@est.tech) - * - */ -@Component -public class MonitorSol003AdapterTerminateNodeTask extends MonitorSol003AdapterNodeTask { - - public static final String DELETE_VNF_NODE_STATUS = "deleteVnfNodeStatus"; - public static final String VNF_ASSIGNED = "Assigned"; - - @Autowired - public MonitorSol003AdapterTerminateNodeTask(final DatabaseServiceProvider databaseServiceProvider, - final AaiServiceProvider aaiServiceProvider) { - super(databaseServiceProvider, aaiServiceProvider); - } - - @Override - public String getNodeStatusVariableName() { - return DELETE_VNF_NODE_STATUS; - } - - @Override - public boolean isOrchestrationStatusValid(final String orchestrationStatus) { - return VNF_ASSIGNED.equalsIgnoreCase(orchestrationStatus); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/TerminateNsTask.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/TerminateNsTask.java deleted file mode 100644 index c0d1df8c50..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/TerminateNsTask.java +++ /dev/null @@ -1,134 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks; - -import org.camunda.bpm.engine.delegate.DelegateExecution; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNfInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import java.util.ArrayList; -import java.util.List; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NS_INSTANCE_ID_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.FINISHED; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.IN_PROGRESS; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.STARTED; - -/** - * @author Andrew Lamb (andrew.a.lamb@est.tech) - * - */ -@Component -public class TerminateNsTask extends AbstractNetworkServiceTask { - - private static final String IS_NS_TERMINATION_SUCCESSFUL_PARAM_NAME = "isNsTerminationSuccessful"; - private static final Logger logger = LoggerFactory.getLogger(TerminateNsTask.class); - - @Autowired - public TerminateNsTask(final DatabaseServiceProvider databaseServiceProvider) { - super(databaseServiceProvider); - } - - public void setJobStatusToStarted(final DelegateExecution execution) { - setJobStatus(execution, STARTED, "Terminate NS workflow process started"); - } - - public void setJobStatusToFinished(final DelegateExecution execution) { - setJobStatus(execution, FINISHED, "Terminate NS workflow process finished"); - } - - public void setJobStatusToError(final DelegateExecution execution) { - updateNsInstanceStatus(execution, State.FAILED); - setJobStatusToError(execution, "Terminate NS workflow process failed"); - } - - public void updateNsInstanceStatusToTerminating(final DelegateExecution execution) { - logger.info("Executing updateNsInstanceStatusToTerminating"); - setJobStatus(execution, IN_PROGRESS, "Updating NfvoNsInst Status to " + State.TERMINATING); - updateNsInstanceStatus(execution, State.TERMINATING); - logger.info("Finished executing updateNsInstanceStatusToTerminating ..."); - } - - public void updateNsInstanceStatusToNotInstantiated(final DelegateExecution execution) { - logger.info("Executing updateNsInstanceStatusToNotInstantiated"); - setJobStatus(execution, IN_PROGRESS, "Updating NfvoNsInst Status to " + State.NOT_INSTANTIATED); - updateNsInstanceStatus(execution, State.NOT_INSTANTIATED); - logger.info("Finished executing updateNsInstanceStatusToNotInstantiated ..."); - } - - public void getVnfIdsInNs(final DelegateExecution execution) { - logger.info("Executing getVnfIdsInNs ..."); - setJobStatus(execution, IN_PROGRESS, "Getting Each VnfId In Ns"); - final List<String> nfvoNfInstIds = getNfvoNfInstIds(execution); - execution.setVariable(CamundaVariableNameConstants.NFVO_NF_INST_IDS_PARAM_NAME, nfvoNfInstIds); - logger.info("Finished executing getVnfIdsInNs ..."); - } - - public void checkIfVnfTerminationWasSuccessful(final DelegateExecution execution) { - logger.info("Executing checkIfVnfTerminationWasSuccessful"); - - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - final List<NfvoNfInst> nfInstances = databaseServiceProvider.getNfvoNfInstByNsInstId(nsInstId); - - if ((nfInstances != null) && !(nfInstances.isEmpty())) { - final String message = "Found NF Instances"; - nfInstances.stream().forEach(instance -> { - logger.error("VNF : {} {} termination failed", instance.getNfInstId(), instance.getName()); - execution.setVariable(IS_NS_TERMINATION_SUCCESSFUL_PARAM_NAME, false); - }); - abortOperation(execution, message); - } - - execution.setVariable(IS_NS_TERMINATION_SUCCESSFUL_PARAM_NAME, true); - logger.info("Finished executing checkIfVnfTerminationWasSuccessful"); - } - - public void logTimeOut(final DelegateExecution execution) { - logger.error("Vnf termination timedOut ..."); - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - final List<NfvoNfInst> nfInstances = databaseServiceProvider.getNfvoNfInstByNsInstId(nsInstId); - if (nfInstances != null) { - nfInstances.stream().forEach( - instance -> logger.info("Current status {} of vnf: {}", instance.getStatus(), instance.getName())); - } - } - - private List<String> getNfvoNfInstIds(final DelegateExecution execution) { - final String nsInstId = (String) execution.getVariable(NS_INSTANCE_ID_PARAM_NAME); - logger.info("Getting NfvoNfInstList using nsInstId: {}", nsInstId); - final List<NfvoNfInst> nfvoNfInstList = databaseServiceProvider.getNfvoNfInstByNsInstId(nsInstId); - - if (nfvoNfInstList == null || nfvoNfInstList.isEmpty()) { - final String message = "Unable to find NF Instances in database using id: " + nsInstId; - abortOperation(execution, message); - } - - final List<String> vnfIdsList = new ArrayList<>(); - - nfvoNfInstList.stream().forEach(nfvoNfInst -> vnfIdsList.add(nfvoNfInst.getNfInstId())); - - return vnfIdsList; - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/TerminateVnfTask.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/TerminateVnfTask.java deleted file mode 100644 index f3e7eea212..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/tasks/TerminateVnfTask.java +++ /dev/null @@ -1,180 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks; - -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.DELETE_VNF_RESPONSE_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NF_INST_ID_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.TERMINATE_VNF_VNFID_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.ERROR; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.FINISHED; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum.IN_PROGRESS; -import java.util.Optional; -import org.camunda.bpm.engine.delegate.DelegateExecution; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.DeleteVnfResponse; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.aai.AaiServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.vnfm.Sol003AdapterServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; - -/** - * @author Andrew Lamb (andrew.a.lamb@est.tech) - */ -@Component -public class TerminateVnfTask extends AbstractNetworkServiceTask { - private static final Logger logger = LoggerFactory.getLogger(TerminateVnfTask.class); - private final AaiServiceProvider aaiServiceProvider; - private final Sol003AdapterServiceProvider sol003AdapterServiceProvider; - - @Autowired - public TerminateVnfTask(final DatabaseServiceProvider databaseServiceProvider, - final AaiServiceProvider aaiServiceProvider, - final Sol003AdapterServiceProvider sol003AdapterServiceProvider) { - super(databaseServiceProvider); - this.aaiServiceProvider = aaiServiceProvider; - this.sol003AdapterServiceProvider = sol003AdapterServiceProvider; - } - - public void checkIfNfInstanceExistsInDb(final DelegateExecution execution) { - logger.info("Executing checkIfNfInstanceInDb"); - final String vnfId = (String) execution.getVariable(TERMINATE_VNF_VNFID_PARAM_NAME); - logger.info("vnfId: {}", vnfId); - execution.setVariable(NF_INST_ID_PARAM_NAME, vnfId); - - addJobStatus(execution, JobStatusEnum.IN_PROGRESS, - "Checking if VNF Instance with id: " + vnfId + " exists in database."); - if (!databaseServiceProvider.isNfInstExists(vnfId)) { - abortOperation(execution, - "VNF instance with id: " + vnfId + " does not exist in database, so will not be terminated."); - } - logger.info("Finished executing checkIfNfInstanceInDb ..."); - - } - - public void invokeTerminateRequest(final DelegateExecution execution) { - logger.info("Executing invokeTerminateRequest"); - final String vnfId = (String) execution.getVariable(TERMINATE_VNF_VNFID_PARAM_NAME); - - try { - addJobStatus(execution, IN_PROGRESS, "Invoking SOL003 adapter for terminating VNF with vnfId: " + vnfId); - - final Optional<DeleteVnfResponse> optional = sol003AdapterServiceProvider.invokeTerminationRequest(vnfId); - - if (optional.isEmpty()) { - final String errorMessage = "Unexpected error while processing terminate request for vnfId: " + vnfId; - logger.error(errorMessage); - abortOperation(execution, errorMessage); - } - - final DeleteVnfResponse vnfResponse = optional.get(); - - logger.info("Vnf delete response: {}", vnfResponse); - execution.setVariable(DELETE_VNF_RESPONSE_PARAM_NAME, vnfResponse); - addJobStatus(execution, IN_PROGRESS, "Successfully invoked SOL003 adapter terminate VNF with vnfId: " - + vnfId + " DeleteVnfResponse Job Id: " + vnfResponse.getJobId()); - logger.debug("Finished executing invokeTerminateRequest ..."); - } catch (final Exception exception) { - final String message = "Unable to invoke terminate request for vnfId: " + vnfId; - logger.error(message, exception); - abortOperation(execution, message); - } - - } - - public void deleteGenericVnfFromAai(final DelegateExecution execution) { - logger.info("Executing deleteGenericVnfFromAai"); - final String vnfId = (String) execution.getVariable(TERMINATE_VNF_VNFID_PARAM_NAME); - - try { - addJobStatus(execution, IN_PROGRESS, "Deleting GenericVnf record from AAI for vnfId: " + vnfId); - aaiServiceProvider.deleteGenericVnf(vnfId); - - } catch (final Exception exception) { - final String message = "Unable to Delete GenericVnf from AAI for vnfId: " + vnfId; - logger.error(message, exception); - abortOperation(execution, message); - } - - logger.info("Finished executing deleteGenericVnfFromAai ..."); - } - - public void deleteNfInstanceFromDb(final DelegateExecution execution) { - logger.info("Executing deleteNfInstanceFromDb"); - final String vnfId = (String) execution.getVariable(TERMINATE_VNF_VNFID_PARAM_NAME); - - addJobStatus(execution, IN_PROGRESS, "Deleting NF Instance record from Database for vnfId: " + vnfId); - databaseServiceProvider.deleteNfvoNfInst(vnfId); - - addJobStatus(execution, FINISHED, "Successfully finished terminating VNF with vnfId: " + vnfId); - logger.info("Finished executing deleteNfInstanceFromDb ..."); - } - - public void updateNfInstanceStatusToTerminating(final DelegateExecution execution) { - logger.info("Executing updateNfInstanceStatusToTerminating"); - - updateNfInstanceStatus(execution, State.TERMINATING); - final String vnfId = (String) execution.getVariable(TERMINATE_VNF_VNFID_PARAM_NAME); - addJobStatus(execution, IN_PROGRESS, - "Terminating VNF with vnfId: " + vnfId + " will set status to " + State.TERMINATING); - - logger.info("Finished executing updateNfInstanceStatusToTerminating ..."); - - } - - public void updateNfInstanceStatusToNotInstantiated(final DelegateExecution execution) { - logger.info("Executing updateNfInstanceStatusToNotInstantiated"); - - updateNfInstanceStatus(execution, State.NOT_INSTANTIATED); - final String vnfId = (String) execution.getVariable(TERMINATE_VNF_VNFID_PARAM_NAME); - addJobStatus(execution, IN_PROGRESS, - "Successfully terminated VNF with vnfId: " + vnfId + " will set status to " + State.NOT_INSTANTIATED); - - logger.info("Finished executing updateNfInstanceStatusToInstantiated ..."); - - } - - public void updateNfInstanceStatusToFailed(final DelegateExecution execution) { - logger.info("Executing updateNfInstanceStatusToFailed"); - - updateNfInstanceStatus(execution, State.FAILED); - final String vnfId = (String) execution.getVariable(TERMINATE_VNF_VNFID_PARAM_NAME); - addJobStatus(execution, ERROR, - "Failed to terminate VNF with vnfId: " + vnfId + " will set status to " + State.FAILED); - - logger.info("Finished executing updateNfInstanceStatusToFailed ..."); - - } - - private void updateNfInstanceStatus(final DelegateExecution execution, final State vnfStatus) { - final String vnfId = (String) execution.getVariable(TERMINATE_VNF_VNFID_PARAM_NAME); - - final boolean isSuccessful = databaseServiceProvider.updateNfInstState(vnfId, vnfStatus); - if (!isSuccessful) { - final String message = "Unable to update NfvoNfInst " + vnfId + " status to" + vnfStatus + " in database"; - logger.error(message); - abortOperation(execution, message); - } - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/utils/LocalDateTimeTypeAdapter.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/utils/LocalDateTimeTypeAdapter.java deleted file mode 100644 index 9f21d2b449..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/utils/LocalDateTimeTypeAdapter.java +++ /dev/null @@ -1,59 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.utils; - -import java.io.IOException; -import java.time.LocalDateTime; -import java.time.format.DateTimeFormatter; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonToken; -import com.google.gson.stream.JsonWriter; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class LocalDateTimeTypeAdapter extends TypeAdapter<LocalDateTime> { - - private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"); - - @Override - public void write(final JsonWriter out, final LocalDateTime localDateTime) throws IOException { - if (localDateTime == null) { - out.nullValue(); - } else { - out.value(FORMATTER.format(localDateTime)); - } - } - - @Override - public LocalDateTime read(final JsonReader in) throws IOException { - if (JsonToken.NULL == in.peek()) { - in.nextNull(); - return null; - - } - final String dateTime = in.nextString(); - return LocalDateTime.parse(dateTime, FORMATTER); - - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/CreateInstantiateVnf.bpmn b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/CreateInstantiateVnf.bpmn deleted file mode 100644 index 025faa4128..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/CreateInstantiateVnf.bpmn +++ /dev/null @@ -1,159 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:camunda="http://camunda.org/schema/1.0/bpmn" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" id="Definitions_1uf6nd9" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="4.0.0"> - <bpmn:process id="CreateInstantiateVnf" name="CreateInstantiateVnf" isExecutable="true"> - <bpmn:startEvent id="StartEvent_1"> - <bpmn:outgoing>Flow_02bjz2v</bpmn:outgoing> - </bpmn:startEvent> - <bpmn:serviceTask id="Activity_19rmtjr" name="Create NF Instance (VNF) record in DB" camunda:expression="${CreateInstantiateVnfTask.createNfInstanceInDb(execution)}"> - <bpmn:incoming>Flow_123uagz</bpmn:incoming> - <bpmn:outgoing>Flow_03p6ifi</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_02bjz2v" sourceRef="StartEvent_1" targetRef="Activity_1cluqgp" /> - <bpmn:endEvent id="Event_14qdixj"> - <bpmn:incoming>Flow_0srinh7</bpmn:incoming> - </bpmn:endEvent> - <bpmn:sequenceFlow id="Flow_03p6ifi" sourceRef="Activity_19rmtjr" targetRef="Activity_0rto3n3" /> - <bpmn:serviceTask id="Activity_0rto3n3" name="Create Generic VNF and Connect to Service Instance in AAI" camunda:expression="${CreateInstantiateVnfTask.createGenericVnfInAai(execution)}"> - <bpmn:incoming>Flow_03p6ifi</bpmn:incoming> - <bpmn:outgoing>Flow_1c3kc4e</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_1c3kc4e" sourceRef="Activity_0rto3n3" targetRef="ServiceTask_0iry5yw" /> - <bpmn:serviceTask id="Activity_1cluqgp" name="Check If NF Instance (VNF) exists in DB" camunda:expression="${CreateInstantiateVnfTask.checkIfNfInstanceExistsInDb(execution)}"> - <bpmn:incoming>Flow_02bjz2v</bpmn:incoming> - <bpmn:outgoing>Flow_123uagz</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_123uagz" sourceRef="Activity_1cluqgp" targetRef="Activity_19rmtjr" /> - <bpmn:serviceTask id="ServiceTask_0iry5yw" name=" Invoke VNFM Adaptor " camunda:asyncAfter="true" camunda:expression="${CreateInstantiateVnfTask.invokeCreateInstantiationRequest(execution)}"> - <bpmn:incoming>Flow_1c3kc4e</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_0xzptc2</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:callActivity id="CallActivity_1yilxx3" name="Monitor Sol003 adapter Instantiation Job" calledElement="MonitorSol003AdapterCreateJob"> - <bpmn:extensionElements> - <camunda:in source="createVnfResponse" target="createVnfResponse" /> - <camunda:in source="jobId" target="jobId" /> - </bpmn:extensionElements> - <bpmn:incoming>SequenceFlow_0xzptc2</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_053tvct</bpmn:outgoing> - </bpmn:callActivity> - <bpmn:callActivity id="CallActivity_0p84lpt" name="Monitor Sol003 adapter Create Node Status" calledElement="MonitorSol003AdapterCreateNodeStatus"> - <bpmn:extensionElements> - <camunda:in source="NF_INST_ID" target="NF_INST_ID" /> - <camunda:in source="createVnfResponse" target="createVnfResponse" /> - </bpmn:extensionElements> - <bpmn:incoming>SequenceFlow_053tvct</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_0h7yluk</bpmn:outgoing> - </bpmn:callActivity> - <bpmn:sequenceFlow id="SequenceFlow_0xzptc2" sourceRef="ServiceTask_0iry5yw" targetRef="CallActivity_1yilxx3" /> - <bpmn:sequenceFlow id="SequenceFlow_053tvct" sourceRef="CallActivity_1yilxx3" targetRef="CallActivity_0p84lpt" /> - <bpmn:sequenceFlow id="SequenceFlow_0h7yluk" sourceRef="CallActivity_0p84lpt" targetRef="Activity_0g3dip7" /> - <bpmn:serviceTask id="Activity_0g3dip7" name="Update NF Instance (VNF) Status to INSTANTIATED" camunda:expression="${CreateInstantiateVnfTask.updateNfInstanceStatusToInstantiated(execution)}"> - <bpmn:incoming>SequenceFlow_0h7yluk</bpmn:incoming> - <bpmn:outgoing>Flow_0srinh7</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0srinh7" sourceRef="Activity_0g3dip7" targetRef="Event_14qdixj" /> - <bpmn:subProcess id="Activity_0qtgdm9" name="Error Handling" triggeredByEvent="true"> - <bpmn:startEvent id="Event_08zcwc2" name="error"> - <bpmn:outgoing>Flow_06q1m6i</bpmn:outgoing> - <bpmn:errorEventDefinition id="ErrorEventDefinition_1ppvn77" /> - </bpmn:startEvent> - <bpmn:endEvent id="Event_1wkm29u" name="end"> - <bpmn:incoming>Flow_0anjylz</bpmn:incoming> - </bpmn:endEvent> - <bpmn:serviceTask id="Activity_0ltxcii" name="Update NF Instance (VNF) Status to FAILED" camunda:asyncBefore="true" camunda:expression="${CreateInstantiateVnfTask.updateNfInstanceStatusToFailed(execution)}"> - <bpmn:incoming>Flow_06q1m6i</bpmn:incoming> - <bpmn:outgoing>Flow_0anjylz</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_06q1m6i" sourceRef="Event_08zcwc2" targetRef="Activity_0ltxcii" /> - <bpmn:sequenceFlow id="Flow_0anjylz" sourceRef="Activity_0ltxcii" targetRef="Event_1wkm29u" /> - </bpmn:subProcess> - </bpmn:process> - <bpmndi:BPMNDiagram id="BPMNDiagram_1"> - <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="CreateInstantiateVnf"> - <bpmndi:BPMNEdge id="SequenceFlow_0h7yluk_di" bpmnElement="SequenceFlow_0h7yluk"> - <di:waypoint x="1030" y="117" /> - <di:waypoint x="1080" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_053tvct_di" bpmnElement="SequenceFlow_053tvct"> - <di:waypoint x="880" y="117" /> - <di:waypoint x="930" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0xzptc2_di" bpmnElement="SequenceFlow_0xzptc2"> - <di:waypoint x="740" y="117" /> - <di:waypoint x="780" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_123uagz_di" bpmnElement="Flow_123uagz"> - <di:waypoint x="350" y="117" /> - <di:waypoint x="380" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1c3kc4e_di" bpmnElement="Flow_1c3kc4e"> - <di:waypoint x="610" y="117" /> - <di:waypoint x="640" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_03p6ifi_di" bpmnElement="Flow_03p6ifi"> - <di:waypoint x="480" y="117" /> - <di:waypoint x="510" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_02bjz2v_di" bpmnElement="Flow_02bjz2v"> - <di:waypoint x="215" y="117" /> - <di:waypoint x="250" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0srinh7_di" bpmnElement="Flow_0srinh7"> - <di:waypoint x="1180" y="117" /> - <di:waypoint x="1232" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"> - <dc:Bounds x="179" y="99" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_19rmtjr_di" bpmnElement="Activity_19rmtjr"> - <dc:Bounds x="380" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0rto3n3_di" bpmnElement="Activity_0rto3n3"> - <dc:Bounds x="510" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1cluqgp_di" bpmnElement="Activity_1cluqgp"> - <dc:Bounds x="250" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ServiceTask_0iry5yw_di" bpmnElement="ServiceTask_0iry5yw"> - <dc:Bounds x="640" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="CallActivity_1yilxx3_di" bpmnElement="CallActivity_1yilxx3"> - <dc:Bounds x="780" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="CallActivity_0p84lpt_di" bpmnElement="CallActivity_0p84lpt"> - <dc:Bounds x="930" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_14qdixj_di" bpmnElement="Event_14qdixj"> - <dc:Bounds x="1232" y="99" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0g3dip7_di" bpmnElement="Activity_0g3dip7"> - <dc:Bounds x="1080" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0qtgdm9_di" bpmnElement="Activity_0qtgdm9" isExpanded="true"> - <dc:Bounds x="430" y="270" width="438" height="130" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="Flow_06q1m6i_di" bpmnElement="Flow_06q1m6i"> - <di:waypoint x="488" y="333" /> - <di:waypoint x="580" y="333" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0anjylz_di" bpmnElement="Flow_0anjylz"> - <di:waypoint x="680" y="333" /> - <di:waypoint x="812" y="333" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="Event_08zcwc2_di" bpmnElement="Event_08zcwc2"> - <dc:Bounds x="452" y="315" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="458" y="358" width="24" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_1wkm29u_di" bpmnElement="Event_1wkm29u"> - <dc:Bounds x="812" y="315" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="822" y="357" width="19" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0ltxcii_di" bpmnElement="Activity_0ltxcii"> - <dc:Bounds x="580" y="293" width="100" height="80" /> - </bpmndi:BPMNShape> - </bpmndi:BPMNPlane> - </bpmndi:BPMNDiagram> -</bpmn:definitions> diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/CreateNs.bpmn b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/CreateNs.bpmn deleted file mode 100644 index 4c24f91cf9..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/CreateNs.bpmn +++ /dev/null @@ -1,266 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:camunda="http://camunda.org/schema/1.0/bpmn" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="Definitions_1l4zor5" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="4.2.0"> - <bpmn:process id="CreateNs" name=" CreateNs" isExecutable="true"> - <bpmn:startEvent id="StartEvent_1" name="Start Process"> - <bpmn:outgoing>Flow_1tqn5q5</bpmn:outgoing> - </bpmn:startEvent> - <bpmn:endEvent id="EndEvent_1" name="End Process"> - <bpmn:incoming>Flow_0t87ov3</bpmn:incoming> - </bpmn:endEvent> - <bpmn:sequenceFlow id="Flow_1tqn5q5" sourceRef="StartEvent_1" targetRef="Activity_15ksfz6" /> - <bpmn:serviceTask id="Activity_15ksfz6" name="Set Job Status to STARTED" camunda:asyncBefore="true" camunda:expression="${CreateNsTask.setJobStatusToStarted(execution)}"> - <bpmn:incoming>Flow_1tqn5q5</bpmn:incoming> - <bpmn:outgoing>Flow_0y07mxe</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0y07mxe" sourceRef="Activity_15ksfz6" targetRef="Activity_12yonzp" /> - <bpmn:serviceTask id="Activity_1r4l8w8" name="Set Job Status to FINISHED" camunda:expression="${CreateNsTask.setJobStatusToFinished(execution)}"> - <bpmn:incoming>Flow_1rtsvpm</bpmn:incoming> - <bpmn:outgoing>Flow_0t87ov3</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0t87ov3" sourceRef="Activity_1r4l8w8" targetRef="EndEvent_1" /> - <bpmn:exclusiveGateway id="Gateway_0fuwzjj" name="Does Ns Package exists?"> - <bpmn:incoming>Flow_09582uw</bpmn:incoming> - <bpmn:outgoing>Flow_1f4vi10</bpmn:outgoing> - <bpmn:outgoing>Flow_0qabgp7</bpmn:outgoing> - </bpmn:exclusiveGateway> - <bpmn:serviceTask id="Activity_12yonzp" name="Get Ns Package from ETSI Catalog Manager" camunda:expression="${CreateNsTask.getNsPackage(execution)}"> - <bpmn:incoming>Flow_0y07mxe</bpmn:incoming> - <bpmn:outgoing>Flow_09582uw</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_09582uw" sourceRef="Activity_12yonzp" targetRef="Gateway_0fuwzjj" /> - <bpmn:subProcess id="Activity_06ko4e2" name="Error Handling" triggeredByEvent="true"> - <bpmn:startEvent id="Event_1ibvrn2" name="error"> - <bpmn:outgoing>Flow_0554tjv</bpmn:outgoing> - <bpmn:errorEventDefinition id="ErrorEventDefinition_0lc46mh" /> - </bpmn:startEvent> - <bpmn:endEvent id="Event_02f7sr1" name="end"> - <bpmn:incoming>Flow_04xvpee</bpmn:incoming> - </bpmn:endEvent> - <bpmn:sequenceFlow id="Flow_0554tjv" sourceRef="Event_1ibvrn2" targetRef="Activity_1sj0nvr" /> - <bpmn:serviceTask id="Activity_1sj0nvr" name="Set Job Status to ERROR" camunda:asyncBefore="true" camunda:expression="${CreateNsTask.setJobStatusToError(execution)}"> - <bpmn:incoming>Flow_0554tjv</bpmn:incoming> - <bpmn:outgoing>Flow_04xvpee</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_04xvpee" sourceRef="Activity_1sj0nvr" targetRef="Event_02f7sr1" /> - </bpmn:subProcess> - <bpmn:subProcess id="Activity_1dx9fz6" name="Java Exception Handling" triggeredByEvent="true"> - <bpmn:startEvent id="Event_0zne7ch" name="error"> - <bpmn:outgoing>Flow_0j1otrx</bpmn:outgoing> - <bpmn:errorEventDefinition id="ErrorEventDefinition_1p3h4ta" errorRef="Error_0s855yd" camunda:errorCodeVariable="BPMN_javaExpCode" camunda:errorMessageVariable="BPMN_javaExpMsg" /> - </bpmn:startEvent> - <bpmn:endEvent id="Event_0bcyh7u"> - <bpmn:incoming>Flow_0oqv7vl</bpmn:incoming> - </bpmn:endEvent> - <bpmn:sequenceFlow id="Flow_0j1otrx" sourceRef="Event_0zne7ch" targetRef="Activity_15uwy90" /> - <bpmn:serviceTask id="Activity_15uwy90" name="Set Job Status to ERROR" camunda:asyncBefore="true" camunda:expression="${CreateNsTask.setJobStatusToError(execution)}"> - <bpmn:incoming>Flow_0j1otrx</bpmn:incoming> - <bpmn:outgoing>Flow_0oqv7vl</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0oqv7vl" sourceRef="Activity_15uwy90" targetRef="Event_0bcyh7u" /> - </bpmn:subProcess> - <bpmn:sequenceFlow id="Flow_1f4vi10" name="No" sourceRef="Gateway_0fuwzjj" targetRef="Event_016q8gu"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">#{not doesNsPackageExists}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:endEvent id="Event_016q8gu"> - <bpmn:incoming>Flow_1f4vi10</bpmn:incoming> - <bpmn:incoming>Flow_1yql1cm</bpmn:incoming> - <bpmn:errorEventDefinition id="ErrorEventDefinition_1ugx52k" errorRef="Error_0rqvnym" /> - </bpmn:endEvent> - <bpmn:sequenceFlow id="Flow_0qabgp7" name="Yes" sourceRef="Gateway_0fuwzjj" targetRef="Activity_0vlb2nk"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">#{doesNsPackageExists}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:serviceTask id="Activity_0vlb2nk" name="Check NS Instance exists In DB " camunda:expression="${CreateNsTask.doesNsInstanceExistsInDb(execution)}"> - <bpmn:incoming>Flow_0qabgp7</bpmn:incoming> - <bpmn:outgoing>Flow_1exrj2b</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_1exrj2b" sourceRef="Activity_0vlb2nk" targetRef="Gateway_0d7n517" /> - <bpmn:exclusiveGateway id="Gateway_0d7n517"> - <bpmn:incoming>Flow_1exrj2b</bpmn:incoming> - <bpmn:outgoing>Flow_1rkg44s</bpmn:outgoing> - <bpmn:outgoing>Flow_1yql1cm</bpmn:outgoing> - </bpmn:exclusiveGateway> - <bpmn:sequenceFlow id="Flow_1rkg44s" name="No" sourceRef="Gateway_0d7n517" targetRef="Activity_09tqz8x"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">#{not doesNsInstanceExists}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:sequenceFlow id="Flow_1yql1cm" name="Yes" sourceRef="Gateway_0d7n517" targetRef="Event_016q8gu"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">#{doesNsInstanceExists}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:serviceTask id="Activity_09tqz8x" name="Create NS Instance record in DB" camunda:expression="${CreateNsTask.createNsInstanceInDb(execution)}"> - <bpmn:incoming>Flow_1rkg44s</bpmn:incoming> - <bpmn:outgoing>Flow_1jvfwd2</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_1jvfwd2" sourceRef="Activity_09tqz8x" targetRef="Activity_1akc79d" /> - <bpmn:serviceTask id="Activity_1akc79d" name="Create NS Instance in AAI" camunda:expression="${CreateNsTask.createNsInstanceInAai(execution)}"> - <bpmn:incoming>Flow_1jvfwd2</bpmn:incoming> - <bpmn:outgoing>Flow_0e5hvno</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0e5hvno" sourceRef="Activity_1akc79d" targetRef="Activity_03ht66t" /> - <bpmn:serviceTask id="Activity_03ht66t" name="Set Create NS Response" camunda:expression="${CreateNsTask.setCreateNsResponse(execution)}"> - <bpmn:incoming>Flow_0e5hvno</bpmn:incoming> - <bpmn:outgoing>Flow_1rtsvpm</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_1rtsvpm" sourceRef="Activity_03ht66t" targetRef="Activity_1r4l8w8" /> - </bpmn:process> - <bpmn:error id="Error_0s855yd" name="java.lang.Exception" errorCode="java.lang.Exception" /> - <bpmn:error id="Error_0rqvnym" name="NsWorkflowProcessingException" errorCode="CREATE_NS_WORKFLOW_PROCESSING_EXCEPTION" /> - <bpmndi:BPMNDiagram id="BPMNDiagram_1"> - <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="CreateNs"> - <bpmndi:BPMNEdge id="Flow_1rtsvpm_di" bpmnElement="Flow_1rtsvpm"> - <di:waypoint x="1160" y="157" /> - <di:waypoint x="1160" y="230" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0e5hvno_di" bpmnElement="Flow_0e5hvno"> - <di:waypoint x="1070" y="117" /> - <di:waypoint x="1110" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1jvfwd2_di" bpmnElement="Flow_1jvfwd2"> - <di:waypoint x="930" y="117" /> - <di:waypoint x="970" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1yql1cm_di" bpmnElement="Flow_1yql1cm"> - <di:waypoint x="760" y="142" /> - <di:waypoint x="760" y="230" /> - <di:waypoint x="668" y="230" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="766" y="183" width="19" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1rkg44s_di" bpmnElement="Flow_1rkg44s"> - <di:waypoint x="785" y="117" /> - <di:waypoint x="830" y="117" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="799" y="99" width="14" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1exrj2b_di" bpmnElement="Flow_1exrj2b"> - <di:waypoint x="700" y="117" /> - <di:waypoint x="735" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0qabgp7_di" bpmnElement="Flow_0qabgp7"> - <di:waypoint x="565" y="117" /> - <di:waypoint x="600" y="117" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="579" y="99" width="19" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1f4vi10_di" bpmnElement="Flow_1f4vi10"> - <di:waypoint x="540" y="142" /> - <di:waypoint x="540" y="230" /> - <di:waypoint x="632" y="230" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="548" y="183" width="14" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_09582uw_di" bpmnElement="Flow_09582uw"> - <di:waypoint x="480" y="117" /> - <di:waypoint x="515" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0t87ov3_di" bpmnElement="Flow_0t87ov3"> - <di:waypoint x="1160" y="310" /> - <di:waypoint x="1160" y="357" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0y07mxe_di" bpmnElement="Flow_0y07mxe"> - <di:waypoint x="350" y="117" /> - <di:waypoint x="380" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1tqn5q5_di" bpmnElement="Flow_1tqn5q5"> - <di:waypoint x="208" y="117" /> - <di:waypoint x="250" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"> - <dc:Bounds x="172" y="99" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="158" y="142" width="67" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_0db1w1a_di" bpmnElement="EndEvent_1"> - <dc:Bounds x="1142" y="357" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1129" y="400" width="63" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_15ksfz6_di" bpmnElement="Activity_15ksfz6"> - <dc:Bounds x="250" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1r4l8w8_di" bpmnElement="Activity_1r4l8w8"> - <dc:Bounds x="1110" y="230" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Gateway_0fuwzjj_di" bpmnElement="Gateway_0fuwzjj" isMarkerVisible="true"> - <dc:Bounds x="515" y="92" width="50" height="50" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="498" y="62" width="88" height="27" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_12yonzp_di" bpmnElement="Activity_12yonzp"> - <dc:Bounds x="380" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_06ko4e2_di" bpmnElement="Activity_06ko4e2" isExpanded="true"> - <dc:Bounds x="431" y="310" width="438" height="130" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="Flow_04xvpee_di" bpmnElement="Flow_04xvpee"> - <di:waypoint x="681" y="373" /> - <di:waypoint x="813" y="373" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0554tjv_di" bpmnElement="Flow_0554tjv"> - <di:waypoint x="489" y="373" /> - <di:waypoint x="581" y="373" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="Event_1ibvrn2_di" bpmnElement="Event_1ibvrn2"> - <dc:Bounds x="453" y="355" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="459" y="398" width="24" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_02f7sr1_di" bpmnElement="Event_02f7sr1"> - <dc:Bounds x="813" y="355" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="823" y="397" width="19" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1sj0nvr_di" bpmnElement="Activity_1sj0nvr"> - <dc:Bounds x="581" y="333" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1dx9fz6_di" bpmnElement="Activity_1dx9fz6" isExpanded="true"> - <dc:Bounds x="431" y="470" width="438" height="130" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="Flow_0oqv7vl_di" bpmnElement="Flow_0oqv7vl"> - <di:waypoint x="680" y="533" /> - <di:waypoint x="772" y="533" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0j1otrx_di" bpmnElement="Flow_0j1otrx"> - <di:waypoint x="522" y="533" /> - <di:waypoint x="580" y="533" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="Event_0zne7ch_di" bpmnElement="Event_0zne7ch"> - <dc:Bounds x="486" y="515" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="493" y="558" width="24" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_0bcyh7u_di" bpmnElement="Event_0bcyh7u"> - <dc:Bounds x="772" y="515" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_15uwy90_di" bpmnElement="Activity_15uwy90"> - <dc:Bounds x="580" y="493" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_0spfqz1_di" bpmnElement="Event_016q8gu"> - <dc:Bounds x="632" y="212" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0vlb2nk_di" bpmnElement="Activity_0vlb2nk"> - <dc:Bounds x="600" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Gateway_0d7n517_di" bpmnElement="Gateway_0d7n517" isMarkerVisible="true"> - <dc:Bounds x="735" y="92" width="50" height="50" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_09tqz8x_di" bpmnElement="Activity_09tqz8x"> - <dc:Bounds x="830" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1akc79d_di" bpmnElement="Activity_1akc79d"> - <dc:Bounds x="970" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_03ht66t_di" bpmnElement="Activity_03ht66t"> - <dc:Bounds x="1110" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - </bpmndi:BPMNPlane> - </bpmndi:BPMNDiagram> -</bpmn:definitions> diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/DeleteNs.bpmn b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/DeleteNs.bpmn deleted file mode 100644 index a6bb214440..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/DeleteNs.bpmn +++ /dev/null @@ -1,260 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:camunda="http://camunda.org/schema/1.0/bpmn" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="Definitions_1l4zor5" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="4.2.0"> - <bpmn:process id="DeleteNs" name="DeleteNs" isExecutable="true"> - <bpmn:startEvent id="StartEvent_1" name="Start Process"> - <bpmn:outgoing>Flow_1tqn5q5</bpmn:outgoing> - </bpmn:startEvent> - <bpmn:endEvent id="EndEvent_1" name="End Process"> - <bpmn:incoming>Flow_0t87ov3</bpmn:incoming> - </bpmn:endEvent> - <bpmn:sequenceFlow id="Flow_1tqn5q5" sourceRef="StartEvent_1" targetRef="Activity_15ksfz6" /> - <bpmn:serviceTask id="Activity_15ksfz6" name="Set Job Status to STARTED" camunda:asyncBefore="true" camunda:expression="${DeleteNsTask.setJobStatusToStarted(execution)}"> - <bpmn:incoming>Flow_1tqn5q5</bpmn:incoming> - <bpmn:outgoing>Flow_0fhodlp</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:serviceTask id="Activity_1r4l8w8" name="Set Job Status to FINISHED" camunda:expression="${DeleteNsTask.setJobStatusToFinished(execution)}"> - <bpmn:incoming>Flow_1rtsvpm</bpmn:incoming> - <bpmn:outgoing>Flow_0t87ov3</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0t87ov3" sourceRef="Activity_1r4l8w8" targetRef="EndEvent_1" /> - <bpmn:subProcess id="Activity_06ko4e2" name="Error Handling" triggeredByEvent="true"> - <bpmn:startEvent id="Event_1ibvrn2" name="error"> - <bpmn:outgoing>Flow_0554tjv</bpmn:outgoing> - <bpmn:errorEventDefinition id="ErrorEventDefinition_0lc46mh" /> - </bpmn:startEvent> - <bpmn:endEvent id="Event_02f7sr1" name="end"> - <bpmn:incoming>Flow_04xvpee</bpmn:incoming> - </bpmn:endEvent> - <bpmn:sequenceFlow id="Flow_0554tjv" sourceRef="Event_1ibvrn2" targetRef="Activity_1sj0nvr" /> - <bpmn:serviceTask id="Activity_1sj0nvr" name="Set Job Status to ERROR" camunda:asyncBefore="true" camunda:expression="${DeleteNsTask.setJobStatusToError(execution)}"> - <bpmn:incoming>Flow_0554tjv</bpmn:incoming> - <bpmn:outgoing>Flow_04xvpee</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_04xvpee" sourceRef="Activity_1sj0nvr" targetRef="Event_02f7sr1" /> - </bpmn:subProcess> - <bpmn:subProcess id="Activity_1dx9fz6" name="Java Exception Handling" triggeredByEvent="true"> - <bpmn:startEvent id="Event_0zne7ch" name="error"> - <bpmn:outgoing>Flow_0j1otrx</bpmn:outgoing> - <bpmn:errorEventDefinition id="ErrorEventDefinition_1p3h4ta" errorRef="Error_0rqvnym" camunda:errorCodeVariable="BPMN_javaExpCode" camunda:errorMessageVariable="BPMN_javaExpMsg" /> - </bpmn:startEvent> - <bpmn:endEvent id="Event_0bcyh7u"> - <bpmn:incoming>Flow_0oqv7vl</bpmn:incoming> - </bpmn:endEvent> - <bpmn:sequenceFlow id="Flow_0j1otrx" sourceRef="Event_0zne7ch" targetRef="Activity_15uwy90" /> - <bpmn:serviceTask id="Activity_15uwy90" name="Set Job Status to ERROR" camunda:asyncBefore="true" camunda:expression="${DeleteNsTask.setJobStatusToError(execution)}"> - <bpmn:incoming>Flow_0j1otrx</bpmn:incoming> - <bpmn:outgoing>Flow_0oqv7vl</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0oqv7vl" sourceRef="Activity_15uwy90" targetRef="Event_0bcyh7u" /> - </bpmn:subProcess> - <bpmn:serviceTask id="Activity_0vlb2nk" name="Check NS Instance exists In DB " camunda:expression="${DeleteNsTask.checkIfNsInstanceExistsInDb(execution)}"> - <bpmn:incoming>Flow_0fhodlp</bpmn:incoming> - <bpmn:outgoing>Flow_1duwqzf</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:serviceTask id="Activity_09tqz8x" name="Check that NS Instance in DB is in NOT_INSTANTIATED state" camunda:expression="${DeleteNsTask.checkthatNsInstanceInDbIsInNotInstantiatedState(execution)}"> - <bpmn:incoming>Flow_02g3nbb</bpmn:incoming> - <bpmn:outgoing>Flow_1ihvsfs</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:serviceTask id="Activity_03ht66t" name="Delete NS Instance from DB" camunda:expression="${DeleteNsTask.deleteNsInstanceFromDb(execution)}"> - <bpmn:incoming>Flow_04wub0a</bpmn:incoming> - <bpmn:outgoing>Flow_1rtsvpm</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_1rtsvpm" sourceRef="Activity_03ht66t" targetRef="Activity_1r4l8w8" /> - <bpmn:sequenceFlow id="Flow_0fhodlp" sourceRef="Activity_15ksfz6" targetRef="Activity_0vlb2nk" /> - <bpmn:sequenceFlow id="Flow_1duwqzf" sourceRef="Activity_0vlb2nk" targetRef="Gateway_1tjajb0" /> - <bpmn:sequenceFlow id="Flow_1ihvsfs" sourceRef="Activity_09tqz8x" targetRef="Gateway_1voek52" /> - <bpmn:serviceTask id="Activity_1rrzri0" name="Delete NS Instance from AAI" camunda:expression="${DeleteNsTask.deleteNsInstanceFromAai(execution)}"> - <bpmn:incoming>Flow_1buncqe</bpmn:incoming> - <bpmn:outgoing>Flow_04wub0a</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_04wub0a" sourceRef="Activity_1rrzri0" targetRef="Activity_03ht66t" /> - <bpmn:exclusiveGateway id="Gateway_1tjajb0" name="Does NS Instance Exist?"> - <bpmn:incoming>Flow_1duwqzf</bpmn:incoming> - <bpmn:outgoing>Flow_02g3nbb</bpmn:outgoing> - <bpmn:outgoing>Flow_1swnlzf</bpmn:outgoing> - </bpmn:exclusiveGateway> - <bpmn:sequenceFlow id="Flow_02g3nbb" name="Yes" sourceRef="Gateway_1tjajb0" targetRef="Activity_09tqz8x"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">#{nsInstanceExists}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:exclusiveGateway id="Gateway_1voek52" name="Is NS Instance in NOT INSTANTIATED State?"> - <bpmn:incoming>Flow_1ihvsfs</bpmn:incoming> - <bpmn:outgoing>Flow_1buncqe</bpmn:outgoing> - <bpmn:outgoing>Flow_1eozcur</bpmn:outgoing> - </bpmn:exclusiveGateway> - <bpmn:sequenceFlow id="Flow_1buncqe" name="Yes" sourceRef="Gateway_1voek52" targetRef="Activity_1rrzri0"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">#{isInNotInstantiatedState}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:endEvent id="Event_0dqc93c"> - <bpmn:incoming>Flow_1swnlzf</bpmn:incoming> - <bpmn:incoming>Flow_1eozcur</bpmn:incoming> - <bpmn:errorEventDefinition id="ErrorEventDefinition_0pfrgad" errorRef="Error_0rqvnym" /> - </bpmn:endEvent> - <bpmn:sequenceFlow id="Flow_1swnlzf" name="No" sourceRef="Gateway_1tjajb0" targetRef="Event_0dqc93c"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">#{not nsInstanceExists}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:sequenceFlow id="Flow_1eozcur" name="No" sourceRef="Gateway_1voek52" targetRef="Event_0dqc93c"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">#{not isInNotInstantiatedState}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - </bpmn:process> - <bpmn:error id="Error_0s855yd" name="java.lang.Exception" errorCode="java.lang.Exception" /> - <bpmn:error id="Error_0rqvnym" name="NsWorkflowProcessingException" errorCode="DELETE_NS_WORKFLOW_PROCESSING_EXCEPTION" /> - <bpmndi:BPMNDiagram id="BPMNDiagram_1"> - <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="DeleteNs"> - <bpmndi:BPMNEdge id="Flow_1eozcur_di" bpmnElement="Flow_1eozcur"> - <di:waypoint x="830" y="192" /> - <di:waypoint x="830" y="270" /> - <di:waypoint x="708" y="270" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="843" y="228" width="14" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1swnlzf_di" bpmnElement="Flow_1swnlzf"> - <di:waypoint x="550" y="192" /> - <di:waypoint x="550" y="270" /> - <di:waypoint x="672" y="270" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="558" y="228" width="14" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1buncqe_di" bpmnElement="Flow_1buncqe"> - <di:waypoint x="855" y="167" /> - <di:waypoint x="960" y="167" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="890" y="149" width="19" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_02g3nbb_di" bpmnElement="Flow_02g3nbb"> - <di:waypoint x="575" y="167" /> - <di:waypoint x="640" y="167" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="598" y="149" width="19" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_04wub0a_di" bpmnElement="Flow_04wub0a"> - <di:waypoint x="1060" y="167" /> - <di:waypoint x="1100" y="167" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1ihvsfs_di" bpmnElement="Flow_1ihvsfs"> - <di:waypoint x="740" y="167" /> - <di:waypoint x="805" y="167" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1duwqzf_di" bpmnElement="Flow_1duwqzf"> - <di:waypoint x="490" y="167" /> - <di:waypoint x="525" y="167" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0fhodlp_di" bpmnElement="Flow_0fhodlp"> - <di:waypoint x="350" y="167" /> - <di:waypoint x="390" y="167" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1rtsvpm_di" bpmnElement="Flow_1rtsvpm"> - <di:waypoint x="1200" y="167" /> - <di:waypoint x="1240" y="167" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0t87ov3_di" bpmnElement="Flow_0t87ov3"> - <di:waypoint x="1340" y="167" /> - <di:waypoint x="1382" y="167" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1tqn5q5_di" bpmnElement="Flow_1tqn5q5"> - <di:waypoint x="208" y="167" /> - <di:waypoint x="250" y="167" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"> - <dc:Bounds x="172" y="149" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="158" y="192" width="67" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_0db1w1a_di" bpmnElement="EndEvent_1"> - <dc:Bounds x="1382" y="149" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1369" y="192" width="63" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_15ksfz6_di" bpmnElement="Activity_15ksfz6"> - <dc:Bounds x="250" y="127" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1r4l8w8_di" bpmnElement="Activity_1r4l8w8"> - <dc:Bounds x="1240" y="127" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_06ko4e2_di" bpmnElement="Activity_06ko4e2" isExpanded="true"> - <dc:Bounds x="431" y="360" width="438" height="130" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="Flow_04xvpee_di" bpmnElement="Flow_04xvpee"> - <di:waypoint x="681" y="423" /> - <di:waypoint x="813" y="423" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0554tjv_di" bpmnElement="Flow_0554tjv"> - <di:waypoint x="489" y="423" /> - <di:waypoint x="581" y="423" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="Event_1ibvrn2_di" bpmnElement="Event_1ibvrn2"> - <dc:Bounds x="453" y="405" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="459" y="448" width="24" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_02f7sr1_di" bpmnElement="Event_02f7sr1"> - <dc:Bounds x="813" y="405" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="823" y="447" width="19" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1sj0nvr_di" bpmnElement="Activity_1sj0nvr"> - <dc:Bounds x="581" y="383" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1dx9fz6_di" bpmnElement="Activity_1dx9fz6" isExpanded="true"> - <dc:Bounds x="431" y="520" width="438" height="130" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="Flow_0oqv7vl_di" bpmnElement="Flow_0oqv7vl"> - <di:waypoint x="680" y="583" /> - <di:waypoint x="772" y="583" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0j1otrx_di" bpmnElement="Flow_0j1otrx"> - <di:waypoint x="522" y="583" /> - <di:waypoint x="580" y="583" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="Event_0zne7ch_di" bpmnElement="Event_0zne7ch"> - <dc:Bounds x="486" y="565" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="493" y="608" width="24" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_0bcyh7u_di" bpmnElement="Event_0bcyh7u"> - <dc:Bounds x="772" y="565" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_15uwy90_di" bpmnElement="Activity_15uwy90"> - <dc:Bounds x="580" y="543" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0vlb2nk_di" bpmnElement="Activity_0vlb2nk"> - <dc:Bounds x="390" y="127" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_09tqz8x_di" bpmnElement="Activity_09tqz8x"> - <dc:Bounds x="640" y="127" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_03ht66t_di" bpmnElement="Activity_03ht66t"> - <dc:Bounds x="1100" y="127" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1rrzri0_di" bpmnElement="Activity_1rrzri0"> - <dc:Bounds x="960" y="127" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Gateway_1tjajb0_di" bpmnElement="Gateway_1tjajb0" isMarkerVisible="true"> - <dc:Bounds x="525" y="142" width="50" height="50" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="505" y="106" width="89" height="27" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Gateway_1voek52_di" bpmnElement="Gateway_1voek52" isMarkerVisible="true"> - <dc:Bounds x="805" y="142" width="50" height="50" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="791" y="83" width="79" height="53" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_029a1ih_di" bpmnElement="Event_0dqc93c"> - <dc:Bounds x="672" y="252" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="646" y="245" width="88" height="27" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - </bpmndi:BPMNPlane> - </bpmndi:BPMNDiagram> -</bpmn:definitions> diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/InstantiateNs.bpmn b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/InstantiateNs.bpmn deleted file mode 100644 index bc34c144c9..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/InstantiateNs.bpmn +++ /dev/null @@ -1,331 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:camunda="http://camunda.org/schema/1.0/bpmn" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="Definitions_0mdda96" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="4.0.0"> - <bpmn:process id="InstantiateNs" name="InstantiateNs" isExecutable="true"> - <bpmn:startEvent id="StartEvent_1" name="Start Process"> - <bpmn:outgoing>SequenceFlow_16k0f61</bpmn:outgoing> - </bpmn:startEvent> - <bpmn:sequenceFlow id="SequenceFlow_16k0f61" sourceRef="StartEvent_1" targetRef="Activity_194tqy0" /> - <bpmn:serviceTask id="Task_0opnwx0" name="Update NS Instance status to INSTANTIATING" camunda:expression="${InstantiateNsTask.updateNsInstanceStatusToInstantiating(execution)}"> - <bpmn:incoming>Flow_04pxtdd</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_0bdznyp</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:endEvent id="EndEvent_0szswbo" name="End Process"> - <bpmn:incoming>Flow_1pcu8aa</bpmn:incoming> - </bpmn:endEvent> - <bpmn:sequenceFlow id="SequenceFlow_0bdznyp" sourceRef="Task_0opnwx0" targetRef="Activity_1jrym1e" /> - <bpmn:serviceTask id="Activity_194tqy0" name="Set Job Status to STARTED" camunda:asyncBefore="true" camunda:expression="${InstantiateNsTask.setJobStatusToStarted(execution)}"> - <bpmn:incoming>SequenceFlow_16k0f61</bpmn:incoming> - <bpmn:outgoing>Flow_04pxtdd</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_04pxtdd" sourceRef="Activity_194tqy0" targetRef="Task_0opnwx0" /> - <bpmn:subProcess id="Activity_0pjxszh" name="Error Handling" triggeredByEvent="true"> - <bpmn:startEvent id="Event_1rpzcl3" name="error"> - <bpmn:outgoing>Flow_07bh7l7</bpmn:outgoing> - <bpmn:errorEventDefinition id="ErrorEventDefinition_0m2e0oa" /> - </bpmn:startEvent> - <bpmn:endEvent id="Event_1fcw3ei" name="end"> - <bpmn:incoming>Flow_1wa1jpl</bpmn:incoming> - </bpmn:endEvent> - <bpmn:serviceTask id="Activity_0ddja9m" name="Set Job Status to ERROR" camunda:asyncBefore="true" camunda:expression="${InstantiateNsTask.setJobStatusToError(execution)}"> - <bpmn:incoming>Flow_0n3dai5</bpmn:incoming> - <bpmn:outgoing>Flow_1wa1jpl</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_1wa1jpl" sourceRef="Activity_0ddja9m" targetRef="Event_1fcw3ei" /> - <bpmn:sequenceFlow id="Flow_07bh7l7" sourceRef="Event_1rpzcl3" targetRef="Activity_1miy3hw" /> - <bpmn:serviceTask id="Activity_1miy3hw" name="Update NSLcmOpOcc operation status to FAILED" camunda:asyncBefore="true" camunda:expression="${InstantiateNsTask.updateNsLcmOpOccStatusToFailed(execution)}"> - <bpmn:incoming>Flow_07bh7l7</bpmn:incoming> - <bpmn:outgoing>Flow_0n3dai5</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0n3dai5" sourceRef="Activity_1miy3hw" targetRef="Activity_0ddja9m" /> - </bpmn:subProcess> - <bpmn:subProcess id="Activity_0mtscwq" name="Java Exception Handling" triggeredByEvent="true"> - <bpmn:startEvent id="Event_0lqr6al" name="error"> - <bpmn:outgoing>Flow_05lo00r</bpmn:outgoing> - <bpmn:errorEventDefinition id="ErrorEventDefinition_02lwl19" errorRef="Error_0jsct8p" camunda:errorCodeVariable="BPMN_javaExpCode" camunda:errorMessageVariable="BPMN_javaExpMsg" /> - </bpmn:startEvent> - <bpmn:endEvent id="Event_05ty7c4"> - <bpmn:incoming>Flow_16aryg5</bpmn:incoming> - </bpmn:endEvent> - <bpmn:serviceTask id="Activity_1ezu7d4" name="Set Job Status to ERROR" camunda:asyncBefore="true" camunda:expression="${InstantiateNsTask.setJobStatusToError(execution)}"> - <bpmn:incoming>Flow_09zcw2a</bpmn:incoming> - <bpmn:outgoing>Flow_16aryg5</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_16aryg5" sourceRef="Activity_1ezu7d4" targetRef="Event_05ty7c4" /> - <bpmn:sequenceFlow id="Flow_05lo00r" sourceRef="Event_0lqr6al" targetRef="Activity_17leldb" /> - <bpmn:serviceTask id="Activity_17leldb" name="Update NSLcmOpOcc operation status to FAILED" camunda:asyncBefore="true" camunda:expression="${InstantiateNsTask.updateNsLcmOpOccStatusToFailed(execution)}"> - <bpmn:incoming>Flow_05lo00r</bpmn:incoming> - <bpmn:outgoing>Flow_09zcw2a</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_09zcw2a" sourceRef="Activity_17leldb" targetRef="Activity_1ezu7d4" /> - </bpmn:subProcess> - <bpmn:serviceTask id="Activity_1w09i1k" name="Set Job Status to FINISHED" camunda:expression="${InstantiateNsTask.setJobStatusToFinished(execution)}"> - <bpmn:incoming>Flow_1i36dw4</bpmn:incoming> - <bpmn:outgoing>Flow_1pcu8aa</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_1pcu8aa" sourceRef="Activity_1w09i1k" targetRef="EndEvent_0szswbo" /> - <bpmn:serviceTask id="Activity_1jrym1e" name="Get and parse NSD from ETSI Catalog" camunda:expression="${InstantiateNsTask.getAndParseNsdFromEtsiCatalog(execution)}"> - <bpmn:incoming>SequenceFlow_0bdznyp</bpmn:incoming> - <bpmn:outgoing>Flow_10zjw0w</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_10zjw0w" sourceRef="Activity_1jrym1e" targetRef="Activity_1kikjaf" /> - <bpmn:callActivity id="Activity_1b2s2wr" name="Create and Instantiate each Vnf" calledElement="CreateInstantiateVnf"> - <bpmn:extensionElements> - <camunda:in source="request" target="request" /> - <camunda:in source="jobId" target="jobId" /> - <camunda:in source="NsInstanceId" target="NsInstanceId" /> - </bpmn:extensionElements> - <bpmn:incoming>Flow_1irbp9b</bpmn:incoming> - <bpmn:outgoing>Flow_0mi4nqa</bpmn:outgoing> - <bpmn:multiInstanceLoopCharacteristics camunda:asyncAfter="true" camunda:collection="${vnfCreateInstantiateRequests}" camunda:elementVariable="request" /> - </bpmn:callActivity> - <bpmn:boundaryEvent id="Event_0rbb817" name="Overall Wait" attachedToRef="Activity_1b2s2wr"> - <bpmn:outgoing>Flow_17zn7we</bpmn:outgoing> - <bpmn:timerEventDefinition id="TimerEventDefinition_13ud1f4"> - <bpmn:timeDuration xsi:type="bpmn:tFormalExpression">PT3H</bpmn:timeDuration> - </bpmn:timerEventDefinition> - </bpmn:boundaryEvent> - <bpmn:sequenceFlow id="Flow_17zn7we" sourceRef="Event_0rbb817" targetRef="Activity_16z66xm" /> - <bpmn:serviceTask id="Activity_0eou3y4" name="Prepare Create Instantiate requests" camunda:expression="${InstantiateNsTask.prepareCreateInstantiateRequests(execution)}"> - <bpmn:incoming>Flow_01ju1mj</bpmn:incoming> - <bpmn:outgoing>Flow_1irbp9b</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_1irbp9b" sourceRef="Activity_0eou3y4" targetRef="Activity_1b2s2wr" /> - <bpmn:serviceTask id="Activity_1kikjaf" name="Get Vnf Pkg ID for each VNFD ID" camunda:expression="${InstantiateNsTask.getVnfPkgIdForEachVnfdId(execution)}"> - <bpmn:incoming>Flow_10zjw0w</bpmn:incoming> - <bpmn:outgoing>Flow_01ju1mj</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_01ju1mj" sourceRef="Activity_1kikjaf" targetRef="Activity_0eou3y4" /> - <bpmn:serviceTask id="Activity_16cvdbw" name="Update NS Instance status to INSTANTIATED" camunda:expression="${InstantiateNsTask.updateNsInstanceStatusToInstantiated(execution)}"> - <bpmn:incoming>Flow_1nieng0</bpmn:incoming> - <bpmn:outgoing>Flow_0xptc0r</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0xptc0r" sourceRef="Activity_16cvdbw" targetRef="Activity_0gkpdft" /> - <bpmn:endEvent id="Event_1e4bwip"> - <bpmn:incoming>Flow_10oprxr</bpmn:incoming> - <bpmn:incoming>Flow_1p21p1m</bpmn:incoming> - <bpmn:errorEventDefinition id="ErrorEventDefinition_0vg6v5r" errorRef="Error_0jsct8p" /> - </bpmn:endEvent> - <bpmn:exclusiveGateway id="Gateway_0nxf0rv" name="is Successful?"> - <bpmn:incoming>Flow_15m4nm1</bpmn:incoming> - <bpmn:outgoing>Flow_1nieng0</bpmn:outgoing> - <bpmn:outgoing>Flow_10oprxr</bpmn:outgoing> - </bpmn:exclusiveGateway> - <bpmn:sequenceFlow id="Flow_1nieng0" name="Yes" sourceRef="Gateway_0nxf0rv" targetRef="Activity_16cvdbw"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">#{isNsInstantiationSuccessful}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:serviceTask id="Activity_14iwa8x" name="Check if VNF Instantiation was Successful" camunda:expression="${InstantiateNsTask.checkIfVnfInstantiationWasSuccessful(execution)}"> - <bpmn:incoming>Flow_0mi4nqa</bpmn:incoming> - <bpmn:outgoing>Flow_15m4nm1</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0mi4nqa" sourceRef="Activity_1b2s2wr" targetRef="Activity_14iwa8x" /> - <bpmn:sequenceFlow id="Flow_15m4nm1" sourceRef="Activity_14iwa8x" targetRef="Gateway_0nxf0rv" /> - <bpmn:serviceTask id="Activity_16z66xm" name="Log TimeOut" camunda:expression="${InstantiateNsTask.logTimeOut(execution)}"> - <bpmn:incoming>Flow_17zn7we</bpmn:incoming> - <bpmn:outgoing>Flow_1p21p1m</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_10oprxr" name="No" sourceRef="Gateway_0nxf0rv" targetRef="Event_1e4bwip"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">#{not isNsInstantiationSuccessful}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:sequenceFlow id="Flow_1p21p1m" sourceRef="Activity_16z66xm" targetRef="Event_1e4bwip" /> - <bpmn:serviceTask id="Activity_0gkpdft" name="Update NSLcmOpOcc operation status to COMPLETED" camunda:expression="${InstantiateNsTask.updateNsLcmOpOccStatusToCompleted(execution)}"> - <bpmn:incoming>Flow_0xptc0r</bpmn:incoming> - <bpmn:outgoing>Flow_1i36dw4</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_1i36dw4" sourceRef="Activity_0gkpdft" targetRef="Activity_1w09i1k" /> - </bpmn:process> - <bpmn:error id="Error_0jsct8p" name="NsWorkflowProcessingException" errorCode="INSTANTIATE_NS_WORKFLOW_PROCESSING_EXCEPTION" /> - <bpmndi:BPMNDiagram id="BPMNDiagram_1"> - <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="InstantiateNs"> - <bpmndi:BPMNEdge id="Flow_1p21p1m_di" bpmnElement="Flow_1p21p1m"> - <di:waypoint x="1250" y="270" /> - <di:waypoint x="1332" y="270" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_10oprxr_di" bpmnElement="Flow_10oprxr"> - <di:waypoint x="1350" y="146" /> - <di:waypoint x="1350" y="252" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1358" y="196" width="14" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_15m4nm1_di" bpmnElement="Flow_15m4nm1"> - <di:waypoint x="1250" y="121" /> - <di:waypoint x="1325" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0mi4nqa_di" bpmnElement="Flow_0mi4nqa"> - <di:waypoint x="1090" y="121" /> - <di:waypoint x="1150" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1nieng0_di" bpmnElement="Flow_1nieng0"> - <di:waypoint x="1375" y="121" /> - <di:waypoint x="1430" y="121" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1393" y="103" width="19" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0xptc0r_di" bpmnElement="Flow_0xptc0r"> - <di:waypoint x="1530" y="121" /> - <di:waypoint x="1580" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_01ju1mj_di" bpmnElement="Flow_01ju1mj"> - <di:waypoint x="800" y="121" /> - <di:waypoint x="850" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1irbp9b_di" bpmnElement="Flow_1irbp9b"> - <di:waypoint x="950" y="121" /> - <di:waypoint x="990" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_17zn7we_di" bpmnElement="Flow_17zn7we"> - <di:waypoint x="1070" y="179" /> - <di:waypoint x="1070" y="270" /> - <di:waypoint x="1150" y="270" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_10zjw0w_di" bpmnElement="Flow_10zjw0w"> - <di:waypoint x="649" y="121" /> - <di:waypoint x="700" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1pcu8aa_di" bpmnElement="Flow_1pcu8aa"> - <di:waypoint x="1820" y="121" /> - <di:waypoint x="1862" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_04pxtdd_di" bpmnElement="Flow_04pxtdd"> - <di:waypoint x="360" y="121" /> - <di:waypoint x="400" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0bdznyp_di" bpmnElement="SequenceFlow_0bdznyp"> - <di:waypoint x="500" y="121" /> - <di:waypoint x="549" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_16k0f61_di" bpmnElement="SequenceFlow_16k0f61"> - <di:waypoint x="208" y="121" /> - <di:waypoint x="260" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1i36dw4_di" bpmnElement="Flow_1i36dw4"> - <di:waypoint x="1680" y="121" /> - <di:waypoint x="1720" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"> - <dc:Bounds x="172" y="103" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="157" y="146" width="67" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ServiceTask_1y7xfqt_di" bpmnElement="Task_0opnwx0"> - <dc:Bounds x="400" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_194tqy0_di" bpmnElement="Activity_194tqy0"> - <dc:Bounds x="260" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="EndEvent_0szswbo_di" bpmnElement="EndEvent_0szswbo"> - <dc:Bounds x="1862" y="103" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1848" y="79" width="63" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1w09i1k_di" bpmnElement="Activity_1w09i1k"> - <dc:Bounds x="1720" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0gkpdft_di" bpmnElement="Activity_0gkpdft"> - <dc:Bounds x="1580" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0pjxszh_di" bpmnElement="Activity_0pjxszh" isExpanded="true"> - <dc:Bounds x="380" y="270" width="510" height="130" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="Flow_07bh7l7_di" bpmnElement="Flow_07bh7l7"> - <di:waypoint x="438" y="333" /> - <di:waypoint x="500" y="333" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1wa1jpl_di" bpmnElement="Flow_1wa1jpl"> - <di:waypoint x="760" y="333" /> - <di:waypoint x="822" y="333" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0n3dai5_di" bpmnElement="Flow_0n3dai5"> - <di:waypoint x="600" y="333" /> - <di:waypoint x="660" y="333" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="Event_1rpzcl3_di" bpmnElement="Event_1rpzcl3"> - <dc:Bounds x="402" y="315" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="408" y="358" width="24" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1miy3hw_di" bpmnElement="Activity_1miy3hw"> - <dc:Bounds x="500" y="293" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0ddja9m_di" bpmnElement="Activity_0ddja9m"> - <dc:Bounds x="660" y="293" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_1fcw3ei_di" bpmnElement="Event_1fcw3ei"> - <dc:Bounds x="822" y="315" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="832" y="357" width="19" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0mtscwq_di" bpmnElement="Activity_0mtscwq" isExpanded="true"> - <dc:Bounds x="380" y="430" width="510" height="130" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="Flow_05lo00r_di" bpmnElement="Flow_05lo00r"> - <di:waypoint x="438" y="493" /> - <di:waypoint x="500" y="493" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_16aryg5_di" bpmnElement="Flow_16aryg5"> - <di:waypoint x="760" y="493" /> - <di:waypoint x="822" y="493" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_09zcw2a_di" bpmnElement="Flow_09zcw2a"> - <di:waypoint x="600" y="493" /> - <di:waypoint x="660" y="493" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="Event_0lqr6al_di" bpmnElement="Event_0lqr6al"> - <dc:Bounds x="402" y="475" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="409" y="518" width="24" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_17leldb_di" bpmnElement="Activity_17leldb"> - <dc:Bounds x="500" y="453" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1ezu7d4_di" bpmnElement="Activity_1ezu7d4"> - <dc:Bounds x="660" y="453" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_05ty7c4_di" bpmnElement="Event_05ty7c4"> - <dc:Bounds x="822" y="475" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1jrym1e_di" bpmnElement="Activity_1jrym1e"> - <dc:Bounds x="549" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1xjmizv_di" bpmnElement="Activity_1b2s2wr"> - <dc:Bounds x="990" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0eou3y4_di" bpmnElement="Activity_0eou3y4"> - <dc:Bounds x="850" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1kikjaf_di" bpmnElement="Activity_1kikjaf"> - <dc:Bounds x="700" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_16cvdbw_di" bpmnElement="Activity_16cvdbw"> - <dc:Bounds x="1430" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_16umj30_di" bpmnElement="Event_1e4bwip"> - <dc:Bounds x="1332" y="252" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Gateway_0nxf0rv_di" bpmnElement="Gateway_0nxf0rv" isMarkerVisible="true"> - <dc:Bounds x="1325" y="96" width="50" height="50" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1320" y="66" width="71" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_14iwa8x_di" bpmnElement="Activity_14iwa8x"> - <dc:Bounds x="1150" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_16z66xm_di" bpmnElement="Activity_16z66xm"> - <dc:Bounds x="1150" y="230" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_0rbb817_di" bpmnElement="Event_0rbb817"> - <dc:Bounds x="1052" y="143" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1000" y="183" width="60" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - </bpmndi:BPMNPlane> - </bpmndi:BPMNDiagram> -</bpmn:definitions>
\ No newline at end of file diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/META-INF/services/org.onap.so.client.RestProperties b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/META-INF/services/org.onap.so.client.RestProperties deleted file mode 100644 index 9d9ba7371a..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/META-INF/services/org.onap.so.client.RestProperties +++ /dev/null @@ -1 +0,0 @@ -org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.aai.AaiPropertiesImpl
\ No newline at end of file diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/MonitorSol003AdapterCreateJob.bpmn b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/MonitorSol003AdapterCreateJob.bpmn deleted file mode 100644 index a9204ec442..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/MonitorSol003AdapterCreateJob.bpmn +++ /dev/null @@ -1,160 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:camunda="http://camunda.org/schema/1.0/bpmn" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="Definitions_12gnsyw" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="3.4.1"> - <bpmn:process id="MonitorSol003AdapterCreateJob" name="MonitorSol003AdapterCreateJob" isExecutable="true"> - <bpmn:startEvent id="StartEvent_1"> - <bpmn:outgoing>SequenceFlow_1x3tbl0</bpmn:outgoing> - </bpmn:startEvent> - <bpmn:endEvent id="EndEvent_0rf1gde"> - <bpmn:incoming>SequenceFlow_1543qy7</bpmn:incoming> - </bpmn:endEvent> - <bpmn:subProcess id="SubProcess_19j0v63"> - <bpmn:incoming>SequenceFlow_1x3tbl0</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_1v4yr3f</bpmn:outgoing> - <bpmn:startEvent id="StartEvent_01r97z2"> - <bpmn:outgoing>SequenceFlow_0s1plu9</bpmn:outgoing> - </bpmn:startEvent> - <bpmn:exclusiveGateway id="ExclusiveGateway_1hkl6yy" default="SequenceFlow_1vmxw9g"> - <bpmn:incoming>SequenceFlow_153a3kp</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_1vmxw9g</bpmn:outgoing> - <bpmn:outgoing>SequenceFlow_0is7myf</bpmn:outgoing> - </bpmn:exclusiveGateway> - <bpmn:intermediateCatchEvent id="IntermediateCatchEvent_1besn3n" name="Wait between checks" camunda:asyncAfter="true"> - <bpmn:incoming>SequenceFlow_1vmxw9g</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_0etw572</bpmn:outgoing> - <bpmn:timerEventDefinition id="TimerEventDefinition_0qgh11t"> - <bpmn:timeDuration xsi:type="bpmn:tFormalExpression">PT15S</bpmn:timeDuration> - </bpmn:timerEventDefinition> - </bpmn:intermediateCatchEvent> - <bpmn:endEvent id="EndEvent_1ohsce9"> - <bpmn:incoming>SequenceFlow_0is7myf</bpmn:incoming> - </bpmn:endEvent> - <bpmn:sequenceFlow id="SequenceFlow_0s1plu9" sourceRef="StartEvent_01r97z2" targetRef="ServiceTask_17jlnng" /> - <bpmn:sequenceFlow id="SequenceFlow_0etw572" sourceRef="IntermediateCatchEvent_1besn3n" targetRef="ServiceTask_17jlnng" /> - <bpmn:serviceTask id="ServiceTask_17jlnng" name=" Get Current Operation Status " camunda:asyncAfter="true" camunda:expression="${MonitorSol003AdapterCreateJobTask.getCurrentOperationStatus(execution)}"> - <bpmn:incoming>SequenceFlow_0etw572</bpmn:incoming> - <bpmn:incoming>SequenceFlow_0s1plu9</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_153a3kp</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="SequenceFlow_1vmxw9g" sourceRef="ExclusiveGateway_1hkl6yy" targetRef="IntermediateCatchEvent_1besn3n" /> - <bpmn:sequenceFlow id="SequenceFlow_0is7myf" sourceRef="ExclusiveGateway_1hkl6yy" targetRef="EndEvent_1ohsce9"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">${MonitorSol003AdapterCreateJobTask.hasOperationFinished(execution)}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:sequenceFlow id="SequenceFlow_153a3kp" sourceRef="ServiceTask_17jlnng" targetRef="ExclusiveGateway_1hkl6yy" /> - </bpmn:subProcess> - <bpmn:endEvent id="EndEvent_1w3t3t0" name="Timeout Exception"> - <bpmn:incoming>SequenceFlow_0bcgtzj</bpmn:incoming> - <bpmn:terminateEventDefinition id="TerminateEventDefinition_0fjecl3" /> - </bpmn:endEvent> - <bpmn:boundaryEvent id="BoundaryEvent_0xiabzp" name="Overall Wait" attachedToRef="SubProcess_19j0v63"> - <bpmn:outgoing>SequenceFlow_1i1o9sh</bpmn:outgoing> - <bpmn:timerEventDefinition id="TimerEventDefinition_10kqw61"> - <bpmn:timeDuration xsi:type="bpmn:tFormalExpression">PT3H</bpmn:timeDuration> - </bpmn:timerEventDefinition> - </bpmn:boundaryEvent> - <bpmn:sequenceFlow id="SequenceFlow_1v4yr3f" sourceRef="SubProcess_19j0v63" targetRef="ServiceTask_1gms128" /> - <bpmn:sequenceFlow id="SequenceFlow_1i1o9sh" sourceRef="BoundaryEvent_0xiabzp" targetRef="ServiceTask_1s87b92" /> - <bpmn:sequenceFlow id="SequenceFlow_1x3tbl0" sourceRef="StartEvent_1" targetRef="SubProcess_19j0v63" /> - <bpmn:serviceTask id="ServiceTask_1s87b92" name=" Time Out Log Failure " camunda:asyncAfter="true" camunda:expression="${MonitorSol003AdapterCreateJobTask.timeOutLogFailue(execution)}"> - <bpmn:incoming>SequenceFlow_1i1o9sh</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_0bcgtzj</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="SequenceFlow_0bcgtzj" sourceRef="ServiceTask_1s87b92" targetRef="EndEvent_1w3t3t0" /> - <bpmn:serviceTask id="ServiceTask_1gms128" name=" Check if operation was successful " camunda:asyncAfter="true" camunda:expression="${MonitorSol003AdapterCreateJobTask.checkIfOperationWasSuccessful(execution)}"> - <bpmn:incoming>SequenceFlow_1v4yr3f</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_1543qy7</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="SequenceFlow_1543qy7" sourceRef="ServiceTask_1gms128" targetRef="EndEvent_0rf1gde" /> - </bpmn:process> - <bpmndi:BPMNDiagram id="BPMNDiagram_1"> - <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="MonitorSol003AdapterCreateJob"> - <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"> - <dc:Bounds x="161" y="330" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="EndEvent_0rf1gde_di" bpmnElement="EndEvent_0rf1gde"> - <dc:Bounds x="1102" y="100" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="SubProcess_19j0v63_di" bpmnElement="SubProcess_19j0v63" isExpanded="true"> - <dc:Bounds x="301" y="248" width="523" height="200" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="EndEvent_1w3t3t0_di" bpmnElement="EndEvent_1w3t3t0"> - <dc:Bounds x="1102" y="322" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1095" y="282" width="49" height="27" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="BoundaryEvent_0xiabzp_di" bpmnElement="BoundaryEvent_0xiabzp"> - <dc:Bounds x="806" y="322" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="794" y="361" width="61" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="SequenceFlow_1v4yr3f_di" bpmnElement="SequenceFlow_1v4yr3f"> - <di:waypoint x="563" y="248" /> - <di:waypoint x="563" y="118" /> - <di:waypoint x="923" y="118" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_1i1o9sh_di" bpmnElement="SequenceFlow_1i1o9sh"> - <di:waypoint x="842" y="340" /> - <di:waypoint x="923" y="340" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="StartEvent_01r97z2_di" bpmnElement="StartEvent_01r97z2"> - <dc:Bounds x="330" y="306" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ExclusiveGateway_1hkl6yy_di" bpmnElement="ExclusiveGateway_1hkl6yy" isMarkerVisible="true"> - <dc:Bounds x="609" y="299" width="50" height="50" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="IntermediateCatchEvent_1besn3n_di" bpmnElement="IntermediateCatchEvent_1besn3n"> - <dc:Bounds x="550" y="378" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="537" y="421" width="66" height="27" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="EndEvent_1ohsce9_di" bpmnElement="EndEvent_1ohsce9"> - <dc:Bounds x="722" y="306" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="SequenceFlow_1x3tbl0_di" bpmnElement="SequenceFlow_1x3tbl0"> - <di:waypoint x="197" y="348" /> - <di:waypoint x="301" y="348" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="ServiceTask_17jlnng_di" bpmnElement="ServiceTask_17jlnng"> - <dc:Bounds x="425" y="284" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="SequenceFlow_0s1plu9_di" bpmnElement="SequenceFlow_0s1plu9"> - <di:waypoint x="366" y="324" /> - <di:waypoint x="425" y="324" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0etw572_di" bpmnElement="SequenceFlow_0etw572"> - <di:waypoint x="550" y="396" /> - <di:waypoint x="486" y="396" /> - <di:waypoint x="486" y="367" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_1vmxw9g_di" bpmnElement="SequenceFlow_1vmxw9g"> - <di:waypoint x="634" y="349" /> - <di:waypoint x="634" y="396" /> - <di:waypoint x="586" y="396" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0is7myf_di" bpmnElement="SequenceFlow_0is7myf"> - <di:waypoint x="659" y="324" /> - <di:waypoint x="722" y="324" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_153a3kp_di" bpmnElement="SequenceFlow_153a3kp"> - <di:waypoint x="525" y="324" /> - <di:waypoint x="609" y="324" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="ServiceTask_1s87b92_di" bpmnElement="ServiceTask_1s87b92"> - <dc:Bounds x="923" y="300" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="SequenceFlow_0bcgtzj_di" bpmnElement="SequenceFlow_0bcgtzj"> - <di:waypoint x="1023" y="340" /> - <di:waypoint x="1102" y="340" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="ServiceTask_1gms128_di" bpmnElement="ServiceTask_1gms128"> - <dc:Bounds x="923" y="78" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="SequenceFlow_1543qy7_di" bpmnElement="SequenceFlow_1543qy7"> - <di:waypoint x="1023" y="118" /> - <di:waypoint x="1102" y="118" /> - </bpmndi:BPMNEdge> - </bpmndi:BPMNPlane> - </bpmndi:BPMNDiagram> -</bpmn:definitions> diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/MonitorSol003AdapterCreateNodeStatus.bpmn b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/MonitorSol003AdapterCreateNodeStatus.bpmn deleted file mode 100644 index c0de5e0352..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/MonitorSol003AdapterCreateNodeStatus.bpmn +++ /dev/null @@ -1,138 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:camunda="http://camunda.org/schema/1.0/bpmn" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="Definitions_1ko0frn" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="3.4.1"> - <bpmn:process id="MonitorSol003AdapterCreateNodeStatus" name="MonitorSol003AdapterCreateNodeStatus" isExecutable="true"> - <bpmn:startEvent id="StartEvent_0k0qfjb"> - <bpmn:outgoing>SequenceFlow_1miob62</bpmn:outgoing> - </bpmn:startEvent> - <bpmn:subProcess id="SubProcess_10wotbc"> - <bpmn:incoming>SequenceFlow_1miob62</bpmn:incoming> - <bpmn:startEvent id="StartEvent_0r9qf43"> - <bpmn:outgoing>SequenceFlow_1moaz0q</bpmn:outgoing> - </bpmn:startEvent> - <bpmn:exclusiveGateway id="ExclusiveGateway_00xtlfj" default="SequenceFlow_1luu31f"> - <bpmn:incoming>SequenceFlow_0qvy3sn</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_1rxbeqi</bpmn:outgoing> - <bpmn:outgoing>SequenceFlow_1luu31f</bpmn:outgoing> - </bpmn:exclusiveGateway> - <bpmn:intermediateCatchEvent id="IntermediateCatchEvent_0xuznv9" name="Wait between checks" camunda:asyncAfter="true"> - <bpmn:incoming>SequenceFlow_1luu31f</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_09t51ao</bpmn:outgoing> - <bpmn:timerEventDefinition id="TimerEventDefinition_0vrbrge"> - <bpmn:timeDuration xsi:type="bpmn:tFormalExpression">PT15S</bpmn:timeDuration> - </bpmn:timerEventDefinition> - </bpmn:intermediateCatchEvent> - <bpmn:endEvent id="EndEvent_0tei3i9"> - <bpmn:incoming>SequenceFlow_1rxbeqi</bpmn:incoming> - </bpmn:endEvent> - <bpmn:serviceTask id="ServiceTask_0y71su8" name=" Get node status " camunda:asyncAfter="true" camunda:expression="${MonitorInstantiateSol003AdapterNodeTask.getNodeStatus(execution)}"> - <bpmn:incoming>SequenceFlow_1moaz0q</bpmn:incoming> - <bpmn:incoming>SequenceFlow_09t51ao</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_0qvy3sn</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="SequenceFlow_1rxbeqi" name=" create vnf success " sourceRef="ExclusiveGateway_00xtlfj" targetRef="EndEvent_0tei3i9"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">${execution.getVariable("createVnfNodeStatus")}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:sequenceFlow id="SequenceFlow_1luu31f" sourceRef="ExclusiveGateway_00xtlfj" targetRef="IntermediateCatchEvent_0xuznv9" /> - <bpmn:sequenceFlow id="SequenceFlow_1moaz0q" sourceRef="StartEvent_0r9qf43" targetRef="ServiceTask_0y71su8" /> - <bpmn:sequenceFlow id="SequenceFlow_0qvy3sn" sourceRef="ServiceTask_0y71su8" targetRef="ExclusiveGateway_00xtlfj" /> - <bpmn:sequenceFlow id="SequenceFlow_09t51ao" sourceRef="IntermediateCatchEvent_0xuznv9" targetRef="ServiceTask_0y71su8" /> - </bpmn:subProcess> - <bpmn:endEvent id="EndEvent_1b83rci" name="Timeout Exception"> - <bpmn:incoming>SequenceFlow_0uiqnl8</bpmn:incoming> - <bpmn:terminateEventDefinition id="TerminateEventDefinition_12rjfva" /> - </bpmn:endEvent> - <bpmn:serviceTask id="ServiceTask_12qp0ty" name=" Time Out Log Failure " camunda:asyncAfter="true" camunda:expression="${MonitorSol003AdapterNodeTask.timeOutLogFailue(execution)}"> - <bpmn:incoming>SequenceFlow_0qcc5x4</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_0uiqnl8</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:boundaryEvent id="BoundaryEvent_1f5o5i9" name="Overall Wait" attachedToRef="SubProcess_10wotbc"> - <bpmn:outgoing>SequenceFlow_0qcc5x4</bpmn:outgoing> - <bpmn:timerEventDefinition id="TimerEventDefinition_1t3ya63"> - <bpmn:timeDuration xsi:type="bpmn:tFormalExpression">PT3H</bpmn:timeDuration> - </bpmn:timerEventDefinition> - </bpmn:boundaryEvent> - <bpmn:sequenceFlow id="SequenceFlow_1miob62" sourceRef="StartEvent_0k0qfjb" targetRef="SubProcess_10wotbc" /> - <bpmn:sequenceFlow id="SequenceFlow_0uiqnl8" sourceRef="ServiceTask_12qp0ty" targetRef="EndEvent_1b83rci" /> - <bpmn:sequenceFlow id="SequenceFlow_0qcc5x4" sourceRef="BoundaryEvent_1f5o5i9" targetRef="ServiceTask_12qp0ty" /> - </bpmn:process> - <bpmndi:BPMNDiagram id="BPMNDiagram_1"> - <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="MonitorSol003AdapterCreateNodeStatus"> - <bpmndi:BPMNShape id="StartEvent_0k0qfjb_di" bpmnElement="StartEvent_0k0qfjb"> - <dc:Bounds x="155" y="159" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="SubProcess_10wotbc_di" bpmnElement="SubProcess_10wotbc" isExpanded="true"> - <dc:Bounds x="293" y="77" width="523" height="200" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="EndEvent_1b83rci_di" bpmnElement="EndEvent_1b83rci"> - <dc:Bounds x="1096" y="151" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1089" y="111" width="49" height="27" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ServiceTask_12qp0ty_di" bpmnElement="ServiceTask_12qp0ty"> - <dc:Bounds x="917" y="129" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="BoundaryEvent_1f5o5i9_di" bpmnElement="BoundaryEvent_1f5o5i9"> - <dc:Bounds x="800" y="151" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="788" y="190" width="61" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="SequenceFlow_1miob62_di" bpmnElement="SequenceFlow_1miob62"> - <di:waypoint x="191" y="177" /> - <di:waypoint x="293" y="177" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0uiqnl8_di" bpmnElement="SequenceFlow_0uiqnl8"> - <di:waypoint x="1017" y="169" /> - <di:waypoint x="1096" y="169" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0qcc5x4_di" bpmnElement="SequenceFlow_0qcc5x4"> - <di:waypoint x="836" y="169" /> - <di:waypoint x="917" y="169" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="StartEvent_0r9qf43_di" bpmnElement="StartEvent_0r9qf43"> - <dc:Bounds x="324" y="135" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ExclusiveGateway_00xtlfj_di" bpmnElement="ExclusiveGateway_00xtlfj" isMarkerVisible="true"> - <dc:Bounds x="603" y="128" width="50" height="50" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="IntermediateCatchEvent_0xuznv9_di" bpmnElement="IntermediateCatchEvent_0xuznv9"> - <dc:Bounds x="544" y="207" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="532" y="250" width="66" height="27" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="EndEvent_0tei3i9_di" bpmnElement="EndEvent_0tei3i9"> - <dc:Bounds x="716" y="135" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ServiceTask_0y71su8_di" bpmnElement="ServiceTask_0y71su8"> - <dc:Bounds x="412" y="113" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="SequenceFlow_1rxbeqi_di" bpmnElement="SequenceFlow_1rxbeqi"> - <di:waypoint x="653" y="153" /> - <di:waypoint x="716" y="153" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="660" y="135" width="50" height="80" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_1luu31f_di" bpmnElement="SequenceFlow_1luu31f"> - <di:waypoint x="628" y="178" /> - <di:waypoint x="628" y="225" /> - <di:waypoint x="580" y="225" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_1moaz0q_di" bpmnElement="SequenceFlow_1moaz0q"> - <di:waypoint x="360" y="153" /> - <di:waypoint x="412" y="153" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0qvy3sn_di" bpmnElement="SequenceFlow_0qvy3sn"> - <di:waypoint x="512" y="153" /> - <di:waypoint x="603" y="153" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_09t51ao_di" bpmnElement="SequenceFlow_09t51ao"> - <di:waypoint x="544" y="225" /> - <di:waypoint x="451" y="225" /> - <di:waypoint x="452" y="193" /> - </bpmndi:BPMNEdge> - </bpmndi:BPMNPlane> - </bpmndi:BPMNDiagram> -</bpmn:definitions> diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/MonitorSol003AdapterTerminateJob.bpmn b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/MonitorSol003AdapterTerminateJob.bpmn deleted file mode 100644 index 1181a497b2..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/MonitorSol003AdapterTerminateJob.bpmn +++ /dev/null @@ -1,160 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:camunda="http://camunda.org/schema/1.0/bpmn" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="Definitions_12gnsyw" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="4.2.0"> - <bpmn:process id="MonitorSol003AdapterTerminateJob" name="MonitorSol003AdapterTerminateJob" isExecutable="true"> - <bpmn:startEvent id="StartEvent_1"> - <bpmn:outgoing>SequenceFlow_1x3tbl0</bpmn:outgoing> - </bpmn:startEvent> - <bpmn:endEvent id="EndEvent_0rf1gde"> - <bpmn:incoming>SequenceFlow_1543qy7</bpmn:incoming> - </bpmn:endEvent> - <bpmn:subProcess id="SubProcess_19j0v63"> - <bpmn:incoming>SequenceFlow_1x3tbl0</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_1v4yr3f</bpmn:outgoing> - <bpmn:startEvent id="StartEvent_01r97z2"> - <bpmn:outgoing>SequenceFlow_0s1plu9</bpmn:outgoing> - </bpmn:startEvent> - <bpmn:exclusiveGateway id="ExclusiveGateway_1hkl6yy" default="SequenceFlow_1vmxw9g"> - <bpmn:incoming>SequenceFlow_153a3kp</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_1vmxw9g</bpmn:outgoing> - <bpmn:outgoing>SequenceFlow_0is7myf</bpmn:outgoing> - </bpmn:exclusiveGateway> - <bpmn:intermediateCatchEvent id="IntermediateCatchEvent_1besn3n" name="Wait between checks" camunda:asyncAfter="true"> - <bpmn:incoming>SequenceFlow_1vmxw9g</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_0etw572</bpmn:outgoing> - <bpmn:timerEventDefinition id="TimerEventDefinition_0qgh11t"> - <bpmn:timeDuration xsi:type="bpmn:tFormalExpression">PT15S</bpmn:timeDuration> - </bpmn:timerEventDefinition> - </bpmn:intermediateCatchEvent> - <bpmn:endEvent id="EndEvent_1ohsce9"> - <bpmn:incoming>SequenceFlow_0is7myf</bpmn:incoming> - </bpmn:endEvent> - <bpmn:sequenceFlow id="SequenceFlow_0s1plu9" sourceRef="StartEvent_01r97z2" targetRef="ServiceTask_17jlnng" /> - <bpmn:sequenceFlow id="SequenceFlow_0etw572" sourceRef="IntermediateCatchEvent_1besn3n" targetRef="ServiceTask_17jlnng" /> - <bpmn:serviceTask id="ServiceTask_17jlnng" name=" Get Current Operation Status " camunda:asyncAfter="true" camunda:expression="${MonitorSol003AdapterTerminateJobTask.getCurrentOperationStatus(execution)}"> - <bpmn:incoming>SequenceFlow_0etw572</bpmn:incoming> - <bpmn:incoming>SequenceFlow_0s1plu9</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_153a3kp</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="SequenceFlow_1vmxw9g" sourceRef="ExclusiveGateway_1hkl6yy" targetRef="IntermediateCatchEvent_1besn3n" /> - <bpmn:sequenceFlow id="SequenceFlow_0is7myf" sourceRef="ExclusiveGateway_1hkl6yy" targetRef="EndEvent_1ohsce9"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">${MonitorSol003AdapterCreateJobTask.hasOperationFinished(execution)}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:sequenceFlow id="SequenceFlow_153a3kp" sourceRef="ServiceTask_17jlnng" targetRef="ExclusiveGateway_1hkl6yy" /> - </bpmn:subProcess> - <bpmn:endEvent id="EndEvent_1w3t3t0" name="Timeout Exception"> - <bpmn:incoming>SequenceFlow_0bcgtzj</bpmn:incoming> - <bpmn:terminateEventDefinition id="TerminateEventDefinition_0fjecl3" /> - </bpmn:endEvent> - <bpmn:boundaryEvent id="BoundaryEvent_0xiabzp" name="Overall Wait" attachedToRef="SubProcess_19j0v63"> - <bpmn:outgoing>SequenceFlow_1i1o9sh</bpmn:outgoing> - <bpmn:timerEventDefinition id="TimerEventDefinition_10kqw61"> - <bpmn:timeDuration xsi:type="bpmn:tFormalExpression">PT3H</bpmn:timeDuration> - </bpmn:timerEventDefinition> - </bpmn:boundaryEvent> - <bpmn:sequenceFlow id="SequenceFlow_1v4yr3f" sourceRef="SubProcess_19j0v63" targetRef="ServiceTask_1gms128" /> - <bpmn:sequenceFlow id="SequenceFlow_1i1o9sh" sourceRef="BoundaryEvent_0xiabzp" targetRef="ServiceTask_1s87b92" /> - <bpmn:sequenceFlow id="SequenceFlow_1x3tbl0" sourceRef="StartEvent_1" targetRef="SubProcess_19j0v63" /> - <bpmn:serviceTask id="ServiceTask_1s87b92" name=" Time Out Log Failure " camunda:asyncAfter="true" camunda:expression="${MonitorSol003AdapterTerminateJobTask.timeOutLogFailure(execution)}"> - <bpmn:incoming>SequenceFlow_1i1o9sh</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_0bcgtzj</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="SequenceFlow_0bcgtzj" sourceRef="ServiceTask_1s87b92" targetRef="EndEvent_1w3t3t0" /> - <bpmn:serviceTask id="ServiceTask_1gms128" name=" Check if operation was successful " camunda:asyncAfter="true" camunda:expression="${MonitorSol003AdapterTerminateJobTask.checkIfOperationWasSuccessful(execution)}"> - <bpmn:incoming>SequenceFlow_1v4yr3f</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_1543qy7</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="SequenceFlow_1543qy7" sourceRef="ServiceTask_1gms128" targetRef="EndEvent_0rf1gde" /> - </bpmn:process> - <bpmndi:BPMNDiagram id="BPMNDiagram_1"> - <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="MonitorSol003AdapterTerminateJob"> - <bpmndi:BPMNEdge id="SequenceFlow_1543qy7_di" bpmnElement="SequenceFlow_1543qy7"> - <di:waypoint x="1023" y="118" /> - <di:waypoint x="1102" y="118" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0bcgtzj_di" bpmnElement="SequenceFlow_0bcgtzj"> - <di:waypoint x="1023" y="340" /> - <di:waypoint x="1102" y="340" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_1x3tbl0_di" bpmnElement="SequenceFlow_1x3tbl0"> - <di:waypoint x="197" y="348" /> - <di:waypoint x="301" y="348" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_1i1o9sh_di" bpmnElement="SequenceFlow_1i1o9sh"> - <di:waypoint x="842" y="340" /> - <di:waypoint x="923" y="340" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_1v4yr3f_di" bpmnElement="SequenceFlow_1v4yr3f"> - <di:waypoint x="563" y="248" /> - <di:waypoint x="563" y="118" /> - <di:waypoint x="923" y="118" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"> - <dc:Bounds x="161" y="330" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="EndEvent_0rf1gde_di" bpmnElement="EndEvent_0rf1gde"> - <dc:Bounds x="1102" y="100" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="SubProcess_19j0v63_di" bpmnElement="SubProcess_19j0v63" isExpanded="true"> - <dc:Bounds x="301" y="248" width="523" height="200" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="SequenceFlow_153a3kp_di" bpmnElement="SequenceFlow_153a3kp"> - <di:waypoint x="525" y="324" /> - <di:waypoint x="609" y="324" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0is7myf_di" bpmnElement="SequenceFlow_0is7myf"> - <di:waypoint x="659" y="324" /> - <di:waypoint x="722" y="324" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_1vmxw9g_di" bpmnElement="SequenceFlow_1vmxw9g"> - <di:waypoint x="634" y="349" /> - <di:waypoint x="634" y="396" /> - <di:waypoint x="586" y="396" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0etw572_di" bpmnElement="SequenceFlow_0etw572"> - <di:waypoint x="550" y="396" /> - <di:waypoint x="486" y="396" /> - <di:waypoint x="486" y="367" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0s1plu9_di" bpmnElement="SequenceFlow_0s1plu9"> - <di:waypoint x="366" y="324" /> - <di:waypoint x="425" y="324" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="StartEvent_01r97z2_di" bpmnElement="StartEvent_01r97z2"> - <dc:Bounds x="330" y="306" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ExclusiveGateway_1hkl6yy_di" bpmnElement="ExclusiveGateway_1hkl6yy" isMarkerVisible="true"> - <dc:Bounds x="609" y="299" width="50" height="50" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="IntermediateCatchEvent_1besn3n_di" bpmnElement="IntermediateCatchEvent_1besn3n"> - <dc:Bounds x="550" y="378" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="537" y="421" width="66" height="27" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="EndEvent_1ohsce9_di" bpmnElement="EndEvent_1ohsce9"> - <dc:Bounds x="722" y="306" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ServiceTask_17jlnng_di" bpmnElement="ServiceTask_17jlnng"> - <dc:Bounds x="425" y="284" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="EndEvent_1w3t3t0_di" bpmnElement="EndEvent_1w3t3t0"> - <dc:Bounds x="1102" y="322" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1095" y="282" width="49" height="27" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ServiceTask_1s87b92_di" bpmnElement="ServiceTask_1s87b92"> - <dc:Bounds x="923" y="300" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ServiceTask_1gms128_di" bpmnElement="ServiceTask_1gms128"> - <dc:Bounds x="923" y="78" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="BoundaryEvent_0xiabzp_di" bpmnElement="BoundaryEvent_0xiabzp"> - <dc:Bounds x="806" y="322" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="794" y="361" width="61" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - </bpmndi:BPMNPlane> - </bpmndi:BPMNDiagram> -</bpmn:definitions> diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/MonitorSol003AdapterTerminateNodeStatus.bpmn b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/MonitorSol003AdapterTerminateNodeStatus.bpmn deleted file mode 100644 index 5629ce81fa..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/MonitorSol003AdapterTerminateNodeStatus.bpmn +++ /dev/null @@ -1,138 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:camunda="http://camunda.org/schema/1.0/bpmn" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="Definitions_1ko0frn" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="4.2.0"> - <bpmn:process id="MonitorSol003AdapterTerminateNodeStatus" name="MonitorSol003AdapterTerminateNodeStatus" isExecutable="true"> - <bpmn:startEvent id="StartEvent_0k0qfjb"> - <bpmn:outgoing>SequenceFlow_1miob62</bpmn:outgoing> - </bpmn:startEvent> - <bpmn:subProcess id="SubProcess_10wotbc"> - <bpmn:incoming>SequenceFlow_1miob62</bpmn:incoming> - <bpmn:startEvent id="StartEvent_0r9qf43"> - <bpmn:outgoing>SequenceFlow_1moaz0q</bpmn:outgoing> - </bpmn:startEvent> - <bpmn:exclusiveGateway id="ExclusiveGateway_00xtlfj" default="SequenceFlow_1luu31f"> - <bpmn:incoming>SequenceFlow_0qvy3sn</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_1rxbeqi</bpmn:outgoing> - <bpmn:outgoing>SequenceFlow_1luu31f</bpmn:outgoing> - </bpmn:exclusiveGateway> - <bpmn:intermediateCatchEvent id="IntermediateCatchEvent_0xuznv9" name="Wait between checks" camunda:asyncAfter="true"> - <bpmn:incoming>SequenceFlow_1luu31f</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_09t51ao</bpmn:outgoing> - <bpmn:timerEventDefinition id="TimerEventDefinition_0vrbrge"> - <bpmn:timeDuration xsi:type="bpmn:tFormalExpression">PT15S</bpmn:timeDuration> - </bpmn:timerEventDefinition> - </bpmn:intermediateCatchEvent> - <bpmn:endEvent id="EndEvent_0tei3i9"> - <bpmn:incoming>SequenceFlow_1rxbeqi</bpmn:incoming> - </bpmn:endEvent> - <bpmn:serviceTask id="ServiceTask_0y71su8" name=" Get node status " camunda:asyncAfter="true" camunda:expression="${MonitorSol003AdapterTerminateNodeTask.getNodeStatus(execution)}"> - <bpmn:incoming>SequenceFlow_1moaz0q</bpmn:incoming> - <bpmn:incoming>SequenceFlow_09t51ao</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_0qvy3sn</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="SequenceFlow_1rxbeqi" name=" terminate vnf success " sourceRef="ExclusiveGateway_00xtlfj" targetRef="EndEvent_0tei3i9"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">${execution.getVariable("deleteVnfNodeStatus")}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:sequenceFlow id="SequenceFlow_1luu31f" sourceRef="ExclusiveGateway_00xtlfj" targetRef="IntermediateCatchEvent_0xuznv9" /> - <bpmn:sequenceFlow id="SequenceFlow_1moaz0q" sourceRef="StartEvent_0r9qf43" targetRef="ServiceTask_0y71su8" /> - <bpmn:sequenceFlow id="SequenceFlow_0qvy3sn" sourceRef="ServiceTask_0y71su8" targetRef="ExclusiveGateway_00xtlfj" /> - <bpmn:sequenceFlow id="SequenceFlow_09t51ao" sourceRef="IntermediateCatchEvent_0xuznv9" targetRef="ServiceTask_0y71su8" /> - </bpmn:subProcess> - <bpmn:endEvent id="EndEvent_1b83rci" name="Timeout Exception"> - <bpmn:incoming>SequenceFlow_0uiqnl8</bpmn:incoming> - <bpmn:terminateEventDefinition id="TerminateEventDefinition_12rjfva" /> - </bpmn:endEvent> - <bpmn:serviceTask id="ServiceTask_12qp0ty" name=" Time Out Log Failure " camunda:asyncAfter="true" camunda:expression="${MonitorSol003AdapterNodeTask.timeOutLogFailue(execution)}"> - <bpmn:incoming>SequenceFlow_0qcc5x4</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_0uiqnl8</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:boundaryEvent id="BoundaryEvent_1f5o5i9" name="Overall Wait" attachedToRef="SubProcess_10wotbc"> - <bpmn:outgoing>SequenceFlow_0qcc5x4</bpmn:outgoing> - <bpmn:timerEventDefinition id="TimerEventDefinition_1t3ya63"> - <bpmn:timeDuration xsi:type="bpmn:tFormalExpression">PT3H</bpmn:timeDuration> - </bpmn:timerEventDefinition> - </bpmn:boundaryEvent> - <bpmn:sequenceFlow id="SequenceFlow_1miob62" sourceRef="StartEvent_0k0qfjb" targetRef="SubProcess_10wotbc" /> - <bpmn:sequenceFlow id="SequenceFlow_0uiqnl8" sourceRef="ServiceTask_12qp0ty" targetRef="EndEvent_1b83rci" /> - <bpmn:sequenceFlow id="SequenceFlow_0qcc5x4" sourceRef="BoundaryEvent_1f5o5i9" targetRef="ServiceTask_12qp0ty" /> - </bpmn:process> - <bpmndi:BPMNDiagram id="BPMNDiagram_1"> - <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="MonitorSol003AdapterTerminateNodeStatus"> - <bpmndi:BPMNEdge id="SequenceFlow_0qcc5x4_di" bpmnElement="SequenceFlow_0qcc5x4"> - <di:waypoint x="836" y="169" /> - <di:waypoint x="917" y="169" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0uiqnl8_di" bpmnElement="SequenceFlow_0uiqnl8"> - <di:waypoint x="1017" y="169" /> - <di:waypoint x="1096" y="169" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_1miob62_di" bpmnElement="SequenceFlow_1miob62"> - <di:waypoint x="191" y="177" /> - <di:waypoint x="293" y="177" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="StartEvent_0k0qfjb_di" bpmnElement="StartEvent_0k0qfjb"> - <dc:Bounds x="155" y="159" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="SubProcess_10wotbc_di" bpmnElement="SubProcess_10wotbc" isExpanded="true"> - <dc:Bounds x="293" y="77" width="523" height="200" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="SequenceFlow_09t51ao_di" bpmnElement="SequenceFlow_09t51ao"> - <di:waypoint x="544" y="225" /> - <di:waypoint x="451" y="225" /> - <di:waypoint x="452" y="193" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0qvy3sn_di" bpmnElement="SequenceFlow_0qvy3sn"> - <di:waypoint x="512" y="153" /> - <di:waypoint x="603" y="153" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_1moaz0q_di" bpmnElement="SequenceFlow_1moaz0q"> - <di:waypoint x="360" y="153" /> - <di:waypoint x="412" y="153" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_1luu31f_di" bpmnElement="SequenceFlow_1luu31f"> - <di:waypoint x="628" y="178" /> - <di:waypoint x="628" y="225" /> - <di:waypoint x="580" y="225" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_1rxbeqi_di" bpmnElement="SequenceFlow_1rxbeqi"> - <di:waypoint x="653" y="153" /> - <di:waypoint x="716" y="153" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="653" y="135" width="65" height="80" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="StartEvent_0r9qf43_di" bpmnElement="StartEvent_0r9qf43"> - <dc:Bounds x="324" y="135" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ExclusiveGateway_00xtlfj_di" bpmnElement="ExclusiveGateway_00xtlfj" isMarkerVisible="true"> - <dc:Bounds x="603" y="128" width="50" height="50" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="IntermediateCatchEvent_0xuznv9_di" bpmnElement="IntermediateCatchEvent_0xuznv9"> - <dc:Bounds x="544" y="207" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="532" y="250" width="66" height="27" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="EndEvent_0tei3i9_di" bpmnElement="EndEvent_0tei3i9"> - <dc:Bounds x="716" y="135" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ServiceTask_0y71su8_di" bpmnElement="ServiceTask_0y71su8"> - <dc:Bounds x="412" y="113" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="EndEvent_1b83rci_di" bpmnElement="EndEvent_1b83rci"> - <dc:Bounds x="1096" y="151" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1089" y="111" width="49" height="27" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ServiceTask_12qp0ty_di" bpmnElement="ServiceTask_12qp0ty"> - <dc:Bounds x="917" y="129" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="BoundaryEvent_1f5o5i9_di" bpmnElement="BoundaryEvent_1f5o5i9"> - <dc:Bounds x="800" y="151" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="788" y="190" width="61" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - </bpmndi:BPMNPlane> - </bpmndi:BPMNDiagram> -</bpmn:definitions> diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/TerminateNs.bpmn b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/TerminateNs.bpmn deleted file mode 100644 index e971f6acf0..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/TerminateNs.bpmn +++ /dev/null @@ -1,307 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:camunda="http://camunda.org/schema/1.0/bpmn" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="Definitions_0mdda96" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="4.2.0"> - <bpmn:process id="TerminateNs" name="TerminateNs" isExecutable="true"> - <bpmn:startEvent id="StartEvent_1" name="Start Process"> - <bpmn:outgoing>SequenceFlow_16k0f61</bpmn:outgoing> - </bpmn:startEvent> - <bpmn:sequenceFlow id="SequenceFlow_16k0f61" sourceRef="StartEvent_1" targetRef="Activity_194tqy0" /> - <bpmn:serviceTask id="Task_0opnwx0" name="Update NS Instance status to TERMINATING" camunda:expression="${TerminateNsTask.updateNsInstanceStatusToTerminating(execution)}"> - <bpmn:incoming>Flow_04pxtdd</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_0bdznyp</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:endEvent id="EndEvent_0szswbo" name="End Process"> - <bpmn:incoming>Flow_1pcu8aa</bpmn:incoming> - </bpmn:endEvent> - <bpmn:sequenceFlow id="SequenceFlow_0bdznyp" sourceRef="Task_0opnwx0" targetRef="Activity_1kikjaf" /> - <bpmn:serviceTask id="Activity_194tqy0" name="Set Job Status to STARTED" camunda:asyncBefore="true" camunda:expression="${TerminateNsTask.setJobStatusToStarted(execution)}"> - <bpmn:incoming>SequenceFlow_16k0f61</bpmn:incoming> - <bpmn:outgoing>Flow_04pxtdd</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_04pxtdd" sourceRef="Activity_194tqy0" targetRef="Task_0opnwx0" /> - <bpmn:subProcess id="Activity_0pjxszh" name="Error Handling" triggeredByEvent="true"> - <bpmn:startEvent id="Event_1rpzcl3" name="error"> - <bpmn:outgoing>Flow_07bh7l7</bpmn:outgoing> - <bpmn:errorEventDefinition id="ErrorEventDefinition_0m2e0oa" /> - </bpmn:startEvent> - <bpmn:endEvent id="Event_1fcw3ei" name="end"> - <bpmn:incoming>Flow_1wa1jpl</bpmn:incoming> - </bpmn:endEvent> - <bpmn:serviceTask id="Activity_0ddja9m" name="Set Job Status to ERROR" camunda:asyncBefore="true" camunda:expression="${TerminateNsTask.setJobStatusToError(execution)}"> - <bpmn:incoming>Flow_0n3dai5</bpmn:incoming> - <bpmn:outgoing>Flow_1wa1jpl</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_1wa1jpl" sourceRef="Activity_0ddja9m" targetRef="Event_1fcw3ei" /> - <bpmn:sequenceFlow id="Flow_07bh7l7" sourceRef="Event_1rpzcl3" targetRef="Activity_1miy3hw" /> - <bpmn:serviceTask id="Activity_1miy3hw" name="Update NSLcmOpOcc operation status to FAILED" camunda:asyncBefore="true" camunda:expression="${TerminateNsTask.updateNsLcmOpOccStatusToFailed(execution)}"> - <bpmn:incoming>Flow_07bh7l7</bpmn:incoming> - <bpmn:outgoing>Flow_0n3dai5</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0n3dai5" sourceRef="Activity_1miy3hw" targetRef="Activity_0ddja9m" /> - </bpmn:subProcess> - <bpmn:subProcess id="Activity_0mtscwq" name="Java Exception Handling" triggeredByEvent="true"> - <bpmn:startEvent id="Event_0lqr6al" name="error"> - <bpmn:outgoing>Flow_05lo00r</bpmn:outgoing> - <bpmn:errorEventDefinition id="ErrorEventDefinition_02lwl19" errorRef="Error_0jsct8p" camunda:errorCodeVariable="BPMN_javaExpCode" camunda:errorMessageVariable="BPMN_javaExpMsg" /> - </bpmn:startEvent> - <bpmn:endEvent id="Event_05ty7c4"> - <bpmn:incoming>Flow_16aryg5</bpmn:incoming> - </bpmn:endEvent> - <bpmn:serviceTask id="Activity_1ezu7d4" name="Set Job Status to ERROR" camunda:asyncBefore="true" camunda:expression="${TerminateNsTask.setJobStatusToError(execution)}"> - <bpmn:incoming>Flow_09zcw2a</bpmn:incoming> - <bpmn:outgoing>Flow_16aryg5</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_16aryg5" sourceRef="Activity_1ezu7d4" targetRef="Event_05ty7c4" /> - <bpmn:sequenceFlow id="Flow_05lo00r" sourceRef="Event_0lqr6al" targetRef="Activity_17leldb" /> - <bpmn:serviceTask id="Activity_17leldb" name="Update NSLcmOpOcc operation status to FAILED" camunda:asyncBefore="true" camunda:expression="${TerminateNsTask.updateNsLcmOpOccStatusToFailed(execution)}"> - <bpmn:incoming>Flow_05lo00r</bpmn:incoming> - <bpmn:outgoing>Flow_09zcw2a</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_09zcw2a" sourceRef="Activity_17leldb" targetRef="Activity_1ezu7d4" /> - </bpmn:subProcess> - <bpmn:serviceTask id="Activity_1w09i1k" name="Set Job Status to FINISHED" camunda:expression="${TerminateNsTask.setJobStatusToFinished(execution)}"> - <bpmn:incoming>Flow_1i36dw4</bpmn:incoming> - <bpmn:outgoing>Flow_1pcu8aa</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_1pcu8aa" sourceRef="Activity_1w09i1k" targetRef="EndEvent_0szswbo" /> - <bpmn:callActivity id="Activity_1b2s2wr" name="Terminate Vnfs" calledElement="TerminateVnf"> - <bpmn:extensionElements> - <camunda:in source="jobId" target="jobId" /> - <camunda:in source="NsInstanceId" target="NsInstanceId" /> - <camunda:in source="vnfId" target="vnfId" /> - </bpmn:extensionElements> - <bpmn:incoming>Flow_01ju1mj</bpmn:incoming> - <bpmn:outgoing>Flow_0mi4nqa</bpmn:outgoing> - <bpmn:multiInstanceLoopCharacteristics camunda:asyncAfter="true" camunda:collection="${nfvoNfInstIds}" camunda:elementVariable="vnfId" /> - </bpmn:callActivity> - <bpmn:boundaryEvent id="Event_0rbb817" name="Overall Wait" attachedToRef="Activity_1b2s2wr"> - <bpmn:outgoing>Flow_17zn7we</bpmn:outgoing> - <bpmn:timerEventDefinition id="TimerEventDefinition_13ud1f4"> - <bpmn:timeDuration xsi:type="bpmn:tFormalExpression">PT3H</bpmn:timeDuration> - </bpmn:timerEventDefinition> - </bpmn:boundaryEvent> - <bpmn:sequenceFlow id="Flow_17zn7we" sourceRef="Event_0rbb817" targetRef="Activity_16z66xm" /> - <bpmn:serviceTask id="Activity_1kikjaf" name="Get Vnf IDs in NS" camunda:expression="${TerminateNsTask.getVnfIdsInNs(execution)}"> - <bpmn:incoming>SequenceFlow_0bdznyp</bpmn:incoming> - <bpmn:outgoing>Flow_01ju1mj</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_01ju1mj" sourceRef="Activity_1kikjaf" targetRef="Activity_1b2s2wr" /> - <bpmn:serviceTask id="Activity_16cvdbw" name="Update NS Instance status to NOT_INSTANTIATED" camunda:expression="${TerminateNsTask.updateNsInstanceStatusToNotInstantiated(execution)}"> - <bpmn:incoming>Flow_1nieng0</bpmn:incoming> - <bpmn:outgoing>Flow_0xptc0r</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0xptc0r" sourceRef="Activity_16cvdbw" targetRef="Activity_0gkpdft" /> - <bpmn:endEvent id="Event_1e4bwip"> - <bpmn:incoming>Flow_10oprxr</bpmn:incoming> - <bpmn:incoming>Flow_1p21p1m</bpmn:incoming> - <bpmn:errorEventDefinition id="ErrorEventDefinition_0vg6v5r" errorRef="Error_0jsct8p" /> - </bpmn:endEvent> - <bpmn:exclusiveGateway id="Gateway_0nxf0rv" name="is Successful?"> - <bpmn:incoming>Flow_15m4nm1</bpmn:incoming> - <bpmn:outgoing>Flow_1nieng0</bpmn:outgoing> - <bpmn:outgoing>Flow_10oprxr</bpmn:outgoing> - </bpmn:exclusiveGateway> - <bpmn:sequenceFlow id="Flow_1nieng0" name="Yes" sourceRef="Gateway_0nxf0rv" targetRef="Activity_16cvdbw"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">#{isNsTerminationSuccessful}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:serviceTask id="Activity_14iwa8x" name="Check if VNF Termination was Successful" camunda:expression="${TerminateNsTask.checkIfVnfTerminationWasSuccessful(execution)}"> - <bpmn:incoming>Flow_0mi4nqa</bpmn:incoming> - <bpmn:outgoing>Flow_15m4nm1</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0mi4nqa" sourceRef="Activity_1b2s2wr" targetRef="Activity_14iwa8x" /> - <bpmn:sequenceFlow id="Flow_15m4nm1" sourceRef="Activity_14iwa8x" targetRef="Gateway_0nxf0rv" /> - <bpmn:serviceTask id="Activity_16z66xm" name="Log TimeOut" camunda:expression="${TerminateNsTask.logTimeOut(execution)}"> - <bpmn:incoming>Flow_17zn7we</bpmn:incoming> - <bpmn:outgoing>Flow_1p21p1m</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_10oprxr" name="No" sourceRef="Gateway_0nxf0rv" targetRef="Event_1e4bwip"> - <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">#{not isNsTerminationSuccessful}</bpmn:conditionExpression> - </bpmn:sequenceFlow> - <bpmn:sequenceFlow id="Flow_1p21p1m" sourceRef="Activity_16z66xm" targetRef="Event_1e4bwip" /> - <bpmn:serviceTask id="Activity_0gkpdft" name="Update NSLcmOpOcc operation status to COMPLETED" camunda:expression="${TerminateNsTask.updateNsLcmOpOccStatusToCompleted(execution)}"> - <bpmn:incoming>Flow_0xptc0r</bpmn:incoming> - <bpmn:outgoing>Flow_1i36dw4</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_1i36dw4" sourceRef="Activity_0gkpdft" targetRef="Activity_1w09i1k" /> - </bpmn:process> - <bpmn:error id="Error_0jsct8p" name="NsWorkflowProcessingException" errorCode="TERMINATE_NS_WORKFLOW_PROCESSING_EXCEPTION" /> - <bpmndi:BPMNDiagram id="BPMNDiagram_1"> - <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="TerminateNs"> - <bpmndi:BPMNEdge id="Flow_1i36dw4_di" bpmnElement="Flow_1i36dw4"> - <di:waypoint x="1680" y="121" /> - <di:waypoint x="1720" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1p21p1m_di" bpmnElement="Flow_1p21p1m"> - <di:waypoint x="1110" y="270" /> - <di:waypoint x="1332" y="270" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_10oprxr_di" bpmnElement="Flow_10oprxr"> - <di:waypoint x="1350" y="146" /> - <di:waypoint x="1350" y="252" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1358" y="196" width="14" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_15m4nm1_di" bpmnElement="Flow_15m4nm1"> - <di:waypoint x="1110" y="121" /> - <di:waypoint x="1325" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0mi4nqa_di" bpmnElement="Flow_0mi4nqa"> - <di:waypoint x="790" y="121" /> - <di:waypoint x="1010" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1nieng0_di" bpmnElement="Flow_1nieng0"> - <di:waypoint x="1375" y="121" /> - <di:waypoint x="1430" y="121" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1393" y="103" width="19" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0xptc0r_di" bpmnElement="Flow_0xptc0r"> - <di:waypoint x="1530" y="121" /> - <di:waypoint x="1580" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_01ju1mj_di" bpmnElement="Flow_01ju1mj"> - <di:waypoint x="650" y="121" /> - <di:waypoint x="690" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_17zn7we_di" bpmnElement="Flow_17zn7we"> - <di:waypoint x="770" y="179" /> - <di:waypoint x="770" y="270" /> - <di:waypoint x="1010" y="270" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1pcu8aa_di" bpmnElement="Flow_1pcu8aa"> - <di:waypoint x="1820" y="121" /> - <di:waypoint x="1862" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_04pxtdd_di" bpmnElement="Flow_04pxtdd"> - <di:waypoint x="360" y="121" /> - <di:waypoint x="410" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0bdznyp_di" bpmnElement="SequenceFlow_0bdznyp"> - <di:waypoint x="510" y="121" /> - <di:waypoint x="550" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_16k0f61_di" bpmnElement="SequenceFlow_16k0f61"> - <di:waypoint x="208" y="121" /> - <di:waypoint x="260" y="121" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"> - <dc:Bounds x="172" y="103" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="157" y="146" width="67" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ServiceTask_1y7xfqt_di" bpmnElement="Task_0opnwx0"> - <dc:Bounds x="410" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="EndEvent_0szswbo_di" bpmnElement="EndEvent_0szswbo"> - <dc:Bounds x="1862" y="103" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1848" y="79" width="63" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_194tqy0_di" bpmnElement="Activity_194tqy0"> - <dc:Bounds x="260" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0pjxszh_di" bpmnElement="Activity_0pjxszh" isExpanded="true"> - <dc:Bounds x="380" y="310" width="510" height="130" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="Flow_0n3dai5_di" bpmnElement="Flow_0n3dai5"> - <di:waypoint x="600" y="373" /> - <di:waypoint x="660" y="373" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_07bh7l7_di" bpmnElement="Flow_07bh7l7"> - <di:waypoint x="438" y="373" /> - <di:waypoint x="500" y="373" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1wa1jpl_di" bpmnElement="Flow_1wa1jpl"> - <di:waypoint x="760" y="373" /> - <di:waypoint x="822" y="373" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="Event_1rpzcl3_di" bpmnElement="Event_1rpzcl3"> - <dc:Bounds x="402" y="355" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="408" y="398" width="24" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_1fcw3ei_di" bpmnElement="Event_1fcw3ei"> - <dc:Bounds x="822" y="355" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="832" y="397" width="19" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0ddja9m_di" bpmnElement="Activity_0ddja9m"> - <dc:Bounds x="660" y="333" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1miy3hw_di" bpmnElement="Activity_1miy3hw"> - <dc:Bounds x="500" y="333" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0mtscwq_di" bpmnElement="Activity_0mtscwq" isExpanded="true"> - <dc:Bounds x="380" y="480" width="510" height="130" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="Flow_09zcw2a_di" bpmnElement="Flow_09zcw2a"> - <di:waypoint x="600" y="543" /> - <di:waypoint x="660" y="543" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_05lo00r_di" bpmnElement="Flow_05lo00r"> - <di:waypoint x="438" y="543" /> - <di:waypoint x="500" y="543" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_16aryg5_di" bpmnElement="Flow_16aryg5"> - <di:waypoint x="760" y="543" /> - <di:waypoint x="822" y="543" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="Event_0lqr6al_di" bpmnElement="Event_0lqr6al"> - <dc:Bounds x="402" y="525" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="409" y="568" width="24" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_05ty7c4_di" bpmnElement="Event_05ty7c4"> - <dc:Bounds x="822" y="525" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1ezu7d4_di" bpmnElement="Activity_1ezu7d4"> - <dc:Bounds x="660" y="503" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_17leldb_di" bpmnElement="Activity_17leldb"> - <dc:Bounds x="500" y="503" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1w09i1k_di" bpmnElement="Activity_1w09i1k"> - <dc:Bounds x="1720" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1xjmizv_di" bpmnElement="Activity_1b2s2wr"> - <dc:Bounds x="690" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1kikjaf_di" bpmnElement="Activity_1kikjaf"> - <dc:Bounds x="550" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_16cvdbw_di" bpmnElement="Activity_16cvdbw"> - <dc:Bounds x="1430" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_16umj30_di" bpmnElement="Event_1e4bwip"> - <dc:Bounds x="1332" y="252" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Gateway_0nxf0rv_di" bpmnElement="Gateway_0nxf0rv" isMarkerVisible="true"> - <dc:Bounds x="1325" y="96" width="50" height="50" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="1320" y="66" width="71" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_14iwa8x_di" bpmnElement="Activity_14iwa8x"> - <dc:Bounds x="1010" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_16z66xm_di" bpmnElement="Activity_16z66xm"> - <dc:Bounds x="1010" y="230" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0gkpdft_di" bpmnElement="Activity_0gkpdft"> - <dc:Bounds x="1580" y="81" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_0rbb817_di" bpmnElement="Event_0rbb817"> - <dc:Bounds x="752" y="143" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="700" y="183" width="60" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - </bpmndi:BPMNPlane> - </bpmndi:BPMNDiagram> -</bpmn:definitions> diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/TerminateVnf.bpmn b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/TerminateVnf.bpmn deleted file mode 100644 index 994933f2ac..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/main/resources/TerminateVnf.bpmn +++ /dev/null @@ -1,171 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:camunda="http://camunda.org/schema/1.0/bpmn" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" id="Definitions_1uf6nd9" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="4.2.0"> - <bpmn:process id="TerminateVnf" name="TerminateVnf" isExecutable="true"> - <bpmn:startEvent id="StartEvent_1"> - <bpmn:outgoing>Flow_02bjz2v</bpmn:outgoing> - </bpmn:startEvent> - <bpmn:sequenceFlow id="Flow_02bjz2v" sourceRef="StartEvent_1" targetRef="Activity_1cluqgp" /> - <bpmn:endEvent id="Event_14qdixj"> - <bpmn:incoming>Flow_1egtf3w</bpmn:incoming> - </bpmn:endEvent> - <bpmn:serviceTask id="Activity_1cluqgp" name="Check If NF Instance (VNF) exists in DB" camunda:expression="${TerminateVnfTask.checkIfNfInstanceExistsInDb(execution)}"> - <bpmn:incoming>Flow_02bjz2v</bpmn:incoming> - <bpmn:outgoing>Flow_123uagz</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_123uagz" sourceRef="Activity_1cluqgp" targetRef="Activity_17vixcx" /> - <bpmn:serviceTask id="ServiceTask_0iry5yw" name=" Invoke VNFM Adapter " camunda:asyncAfter="true" camunda:expression="${TerminateVnfTask.invokeTerminateRequest(execution)}"> - <bpmn:incoming>Flow_0in3hgl</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_0xzptc2</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:callActivity id="CallActivity_1yilxx3" name="Monitor Sol003 Adapter Terminate Job" calledElement="MonitorSol003AdapterTerminateJob"> - <bpmn:extensionElements> - <camunda:in source="jobId" target="jobId" /> - <camunda:in source="deleteVnfResponse" target="deleteVnfResponse" /> - </bpmn:extensionElements> - <bpmn:incoming>SequenceFlow_0xzptc2</bpmn:incoming> - <bpmn:outgoing>SequenceFlow_053tvct</bpmn:outgoing> - </bpmn:callActivity> - <bpmn:sequenceFlow id="SequenceFlow_0xzptc2" sourceRef="ServiceTask_0iry5yw" targetRef="CallActivity_1yilxx3" /> - <bpmn:sequenceFlow id="SequenceFlow_053tvct" sourceRef="CallActivity_1yilxx3" targetRef="Activity_0wgjtoy" /> - <bpmn:serviceTask id="Activity_0g3dip7" name="Update NF Instance (VNF) Status to NOT_INSTANTIATED" camunda:expression="${TerminateVnfTask.updateNfInstanceStatusToNotInstantiated(execution)}"> - <bpmn:incoming>Flow_1rw8pwu</bpmn:incoming> - <bpmn:outgoing>Flow_0srinh7</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0srinh7" sourceRef="Activity_0g3dip7" targetRef="Activity_1vptrrr" /> - <bpmn:subProcess id="Activity_0qtgdm9" name="Error Handling" triggeredByEvent="true"> - <bpmn:startEvent id="Event_08zcwc2" name="error"> - <bpmn:outgoing>Flow_06q1m6i</bpmn:outgoing> - <bpmn:errorEventDefinition id="ErrorEventDefinition_1ppvn77" /> - </bpmn:startEvent> - <bpmn:endEvent id="Event_1wkm29u" name="end"> - <bpmn:incoming>Flow_0anjylz</bpmn:incoming> - </bpmn:endEvent> - <bpmn:serviceTask id="Activity_0ltxcii" name="Update NF Instance (VNF) Status to FAILED" camunda:asyncBefore="true" camunda:expression="${TerminateVnfTask.updateNfInstanceStatusToFailed(execution)}"> - <bpmn:incoming>Flow_06q1m6i</bpmn:incoming> - <bpmn:outgoing>Flow_0anjylz</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_06q1m6i" sourceRef="Event_08zcwc2" targetRef="Activity_0ltxcii" /> - <bpmn:sequenceFlow id="Flow_0anjylz" sourceRef="Activity_0ltxcii" targetRef="Event_1wkm29u" /> - </bpmn:subProcess> - <bpmn:callActivity id="Activity_0wgjtoy" name="Monitor Sol003 Adapter Terminate Node Status" calledElement="MonitorSol003AdapterTerminateNodeStatus"> - <bpmn:extensionElements> - <camunda:in source="NF_INST_ID" target="NF_INST_ID" /> - <camunda:in source="deleteVnfResponse" target="deleteVnfResponse" /> - </bpmn:extensionElements> - <bpmn:incoming>SequenceFlow_053tvct</bpmn:incoming> - <bpmn:outgoing>Flow_1wfvdmt</bpmn:outgoing> - </bpmn:callActivity> - <bpmn:sequenceFlow id="Flow_1wfvdmt" sourceRef="Activity_0wgjtoy" targetRef="Activity_0lulaof" /> - <bpmn:sequenceFlow id="Flow_1egtf3w" sourceRef="Activity_1vptrrr" targetRef="Event_14qdixj" /> - <bpmn:serviceTask id="Activity_1vptrrr" name="Delete NF Instance (VNF) record from DB" camunda:expression="${TerminateVnfTask.deleteNfInstanceFromDb(execution)}"> - <bpmn:incoming>Flow_0srinh7</bpmn:incoming> - <bpmn:outgoing>Flow_1egtf3w</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_0in3hgl" sourceRef="Activity_17vixcx" targetRef="ServiceTask_0iry5yw" /> - <bpmn:serviceTask id="Activity_17vixcx" name="Update NF Instance (VNF) Status to TERMINATING" camunda:expression="${TerminateVnfTask.updateNfInstanceStatusToTerminating(execution)}"> - <bpmn:incoming>Flow_123uagz</bpmn:incoming> - <bpmn:outgoing>Flow_0in3hgl</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:serviceTask id="Activity_0lulaof" name="Delete Generic VNF From AAI" camunda:expression="${TerminateVnfTask.deleteGenericVnfFromAai(execution)}"> - <bpmn:incoming>Flow_1wfvdmt</bpmn:incoming> - <bpmn:outgoing>Flow_1rw8pwu</bpmn:outgoing> - </bpmn:serviceTask> - <bpmn:sequenceFlow id="Flow_1rw8pwu" sourceRef="Activity_0lulaof" targetRef="Activity_0g3dip7" /> - </bpmn:process> - <bpmndi:BPMNDiagram id="BPMNDiagram_1"> - <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="TerminateVnf"> - <bpmndi:BPMNEdge id="Flow_0in3hgl_di" bpmnElement="Flow_0in3hgl"> - <di:waypoint x="490" y="117" /> - <di:waypoint x="540" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1egtf3w_di" bpmnElement="Flow_1egtf3w"> - <di:waypoint x="1370" y="117" /> - <di:waypoint x="1432" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1wfvdmt_di" bpmnElement="Flow_1wfvdmt"> - <di:waypoint x="940" y="117" /> - <di:waypoint x="990" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_0srinh7_di" bpmnElement="Flow_0srinh7"> - <di:waypoint x="1230" y="117" /> - <di:waypoint x="1270" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_053tvct_di" bpmnElement="SequenceFlow_053tvct"> - <di:waypoint x="790" y="117" /> - <di:waypoint x="840" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="SequenceFlow_0xzptc2_di" bpmnElement="SequenceFlow_0xzptc2"> - <di:waypoint x="640" y="117" /> - <di:waypoint x="690" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_123uagz_di" bpmnElement="Flow_123uagz"> - <di:waypoint x="350" y="117" /> - <di:waypoint x="390" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_02bjz2v_di" bpmnElement="Flow_02bjz2v"> - <di:waypoint x="215" y="117" /> - <di:waypoint x="250" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_1rw8pwu_di" bpmnElement="Flow_1rw8pwu"> - <di:waypoint x="1090" y="117" /> - <di:waypoint x="1130" y="117" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"> - <dc:Bounds x="179" y="99" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_1cluqgp_di" bpmnElement="Activity_1cluqgp"> - <dc:Bounds x="250" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="ServiceTask_0iry5yw_di" bpmnElement="ServiceTask_0iry5yw"> - <dc:Bounds x="540" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="CallActivity_1yilxx3_di" bpmnElement="CallActivity_1yilxx3"> - <dc:Bounds x="690" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0wgjtoy_di" bpmnElement="Activity_0wgjtoy"> - <dc:Bounds x="840" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0lulaof_di" bpmnElement="Activity_0lulaof"> - <dc:Bounds x="990" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0g3dip7_di" bpmnElement="Activity_0g3dip7"> - <dc:Bounds x="1130" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0fsaanz_di" bpmnElement="Activity_1vptrrr"> - <dc:Bounds x="1270" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_14qdixj_di" bpmnElement="Event_14qdixj"> - <dc:Bounds x="1432" y="99" width="36" height="36" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0qtgdm9_di" bpmnElement="Activity_0qtgdm9" isExpanded="true"> - <dc:Bounds x="430" y="270" width="438" height="130" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNEdge id="Flow_0anjylz_di" bpmnElement="Flow_0anjylz"> - <di:waypoint x="680" y="333" /> - <di:waypoint x="812" y="333" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNEdge id="Flow_06q1m6i_di" bpmnElement="Flow_06q1m6i"> - <di:waypoint x="488" y="333" /> - <di:waypoint x="580" y="333" /> - </bpmndi:BPMNEdge> - <bpmndi:BPMNShape id="Event_08zcwc2_di" bpmnElement="Event_08zcwc2"> - <dc:Bounds x="452" y="315" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="458" y="358" width="24" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Event_1wkm29u_di" bpmnElement="Event_1wkm29u"> - <dc:Bounds x="812" y="315" width="36" height="36" /> - <bpmndi:BPMNLabel> - <dc:Bounds x="822" y="357" width="19" height="14" /> - </bpmndi:BPMNLabel> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_0ltxcii_di" bpmnElement="Activity_0ltxcii"> - <dc:Bounds x="580" y="293" width="100" height="80" /> - </bpmndi:BPMNShape> - <bpmndi:BPMNShape id="Activity_08pcuhq_di" bpmnElement="Activity_17vixcx"> - <dc:Bounds x="390" y="77" width="100" height="80" /> - </bpmndi:BPMNShape> - </bpmndi:BPMNPlane> - </bpmndi:BPMNDiagram> -</bpmn:definitions> diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/BaseTest.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/BaseTest.java deleted file mode 100644 index 1a89f75a70..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/BaseTest.java +++ /dev/null @@ -1,155 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows; - -import static org.camunda.bpm.engine.history.HistoricProcessInstance.STATE_ACTIVE; -import static org.slf4j.LoggerFactory.getLogger; -import java.time.LocalDateTime; -import java.util.List; -import java.util.Map; -import java.util.Optional; -import java.util.UUID; -import java.util.concurrent.TimeUnit; -import org.camunda.bpm.engine.HistoryService; -import org.camunda.bpm.engine.RuntimeService; -import org.camunda.bpm.engine.history.HistoricProcessInstance; -import org.camunda.bpm.engine.history.HistoricVariableInstance; -import org.camunda.bpm.engine.runtime.ProcessInstance; -import org.junit.runner.RunWith; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobAction; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJob; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.slf4j.Logger; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.test.context.SpringBootTest; -import org.springframework.cloud.contract.wiremock.AutoConfigureWireMock; -import org.springframework.test.context.ActiveProfiles; -import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.junit4.SpringRunner; -import com.github.tomakehurst.wiremock.WireMockServer; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@RunWith(SpringRunner.class) -@SpringBootTest(classes = TestApplication.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) -@ActiveProfiles("test") -@ContextConfiguration -@AutoConfigureWireMock(port = 0) -public abstract class BaseTest { - protected static final String ETSI_CATALOG_URL = "http://modeling-etsicatalog.onap:8806/api"; - protected static final String SOL003_ADAPTER_ENDPOINT_URL = "https://so-vnfm-adapter.onap:9092/so/vnfm-adapter/v1"; - protected static final String GLOBAL_CUSTOMER_ID = UUID.randomUUID().toString(); - protected static final String NSD_INVARIANT_ID = UUID.randomUUID().toString(); - protected static final String SERVICE_TYPE = "NetworkService"; - protected static final String UUID_REGEX = - "[0-9a-zA-Z]{8}\\-[0-9a-zA-Z]{4}\\-[0-9a-zA-Z]{4}\\-[0-9a-zA-Z]{4}\\-[0-9a-zA-Z]{12}"; - protected static final String RANDOM_JOB_ID = UUID.randomUUID().toString(); - - protected static final Logger logger = getLogger(BaseTest.class); - - private static final long TIME_OUT_IN_SECONDS = 120; - private static final int SLEEP_TIME_IN_SECONDS = 5; - - @Autowired - private HistoryService historyService; - - @Autowired - private RuntimeService runtimeService; - - @Autowired - protected DatabaseServiceProvider databaseServiceProvider; - - @Autowired - protected WireMockServer wireMockServer; - - public NfvoJob createNewNfvoJob(final String jobAction, final String nsdId, final String nsName) { - final NfvoJob newJob = new NfvoJob().startTime(LocalDateTime.now()).jobType("NS").jobAction(JobAction.CREATE) - .status(JobStatusEnum.STARTING).resourceId(nsdId).resourceName(nsName); - databaseServiceProvider.addJob(newJob); - return newJob; - } - - public Optional<NfvoJob> getNfvoJob(final String jobId) { - return databaseServiceProvider.getJob(jobId); - } - - public Optional<NfvoJob> getJobByResourceId(final String resourceId) { - return databaseServiceProvider.getJobByResourceId(resourceId); - } - - public ProcessInstance executeWorkflow(final String processDefinitionKey, final String businessKey, - final Map<String, Object> variables) { - return runtimeService.startProcessInstanceByKey(processDefinitionKey, businessKey, variables); - } - - public HistoricProcessInstance getHistoricProcessInstance(final String processInstanceId) { - return historyService.createHistoricProcessInstanceQuery().processInstanceId(processInstanceId).singleResult(); - } - - public HistoricVariableInstance getVariable(final String processInstanceId, final String name) { - return historyService.createHistoricVariableInstanceQuery().processInstanceId(processInstanceId) - .variableName(name).singleResult(); - } - - public List<HistoricVariableInstance> getVariables(final String processInstanceId) { - return historyService.createHistoricVariableInstanceQuery().processInstanceId(processInstanceId).list(); - } - - public boolean waitForProcessInstanceToFinish(final String processInstanceId) throws InterruptedException { - final long startTimeInMillis = System.currentTimeMillis(); - final long timeOutTime = startTimeInMillis + TimeUnit.SECONDS.toMillis(TIME_OUT_IN_SECONDS); - while (timeOutTime > System.currentTimeMillis()) { - - if (isProcessEndedByProcessInstanceId(processInstanceId)) { - logger.info("processInstanceId: {} is finished", processInstanceId); - return true; - } - logger.info("processInstanceId: {} is still running", processInstanceId); - logger.info("Process instance {} not finished yet, will try again in {} seconds", processInstanceId, - SLEEP_TIME_IN_SECONDS); - TimeUnit.SECONDS.sleep(SLEEP_TIME_IN_SECONDS); - } - logger.warn("Timeout {} process didn't finished ", processInstanceId); - return false; - } - - - public boolean isProcessEndedByProcessInstanceId(final String processInstanceId) { - return !isProcessInstanceActive(processInstanceId) && isProcessInstanceEnded(processInstanceId); - } - - private boolean isProcessInstanceActive(final String processInstanceId) { - final HistoricProcessInstance processInstance = getHistoricProcessInstance(processInstanceId); - return processInstance != null && STATE_ACTIVE.equalsIgnoreCase(processInstance.getState()); - } - - private boolean isProcessInstanceEnded(final String processInstanceId) { - return runtimeService.createProcessInstanceQuery().processInstanceId(processInstanceId).singleResult() == null; - } - - protected String getAaiServiceInstanceEndPoint() { - return "/aai/v[0-9]+/business/customers/customer/" + GLOBAL_CUSTOMER_ID - + "/service-subscriptions/service-subscription/" + SERVICE_TYPE - + "/service-instances/service-instance/.*"; - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/DefaultToShortClassNameBeanNameGenerator.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/DefaultToShortClassNameBeanNameGenerator.java deleted file mode 100644 index f91cf9d0c3..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/DefaultToShortClassNameBeanNameGenerator.java +++ /dev/null @@ -1,37 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows; - -import org.springframework.beans.factory.config.BeanDefinition; -import org.springframework.context.annotation.AnnotationBeanNameGenerator; -import org.springframework.util.ClassUtils; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class DefaultToShortClassNameBeanNameGenerator extends AnnotationBeanNameGenerator { - - @Override - protected String buildDefaultBeanName(final BeanDefinition definition) { - return ClassUtils.getShortName(definition.getBeanClassName()); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/PojoClassesTests.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/PojoClassesTests.java deleted file mode 100644 index edfb20afd2..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/PojoClassesTests.java +++ /dev/null @@ -1,63 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows; - -import java.util.Arrays; -import java.util.List; -import org.junit.Test; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.FileEntry; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.NetworkServiceDescriptor; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.ToscaMetadata; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.VirtualNetworkFunction; -import org.onap.so.openpojo.rules.ToStringTester; -import com.openpojo.reflection.filters.FilterPackageInfo; -import com.openpojo.validation.Validator; -import com.openpojo.validation.ValidatorBuilder; -import com.openpojo.validation.test.impl.GetterTester; -import com.openpojo.validation.test.impl.SetterTester; -import nl.jqno.equalsverifier.EqualsVerifier; -import nl.jqno.equalsverifier.Warning; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class PojoClassesTests { - - @Test - public void test_nsd_parser_pojo_classes() throws ClassNotFoundException { - - final Validator validator = ValidatorBuilder.create().with(new SetterTester()).with(new GetterTester()) - .with(new ToStringTester()).build(); - validator.validate(FileEntry.class.getPackageName(), new FilterPackageInfo()); - } - - - @Test - public void test_nsd_parser_pojo_classes_equalAndHashMethod() throws ClassNotFoundException { - final List<Class<?>> classes = Arrays.asList(FileEntry.class, NetworkServiceDescriptor.class, - ToscaMetadata.class, VirtualNetworkFunction.class); - for (final Class<?> clazz : classes) { - EqualsVerifier.forClass(clazz).suppress(Warning.STRICT_INHERITANCE, Warning.NONFINAL_FIELDS, - Warning.INHERITED_DIRECTLY_FROM_OBJECT).verify(); - } - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/TestApplication.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/TestApplication.java deleted file mode 100644 index 18d601930c..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/TestApplication.java +++ /dev/null @@ -1,45 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows; - -import org.springframework.boot.SpringApplication; -import org.springframework.boot.autoconfigure.EnableAutoConfiguration; -import org.springframework.boot.autoconfigure.SpringBootApplication; -import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration; -import org.springframework.context.annotation.ComponentScan; -import org.springframework.context.annotation.FilterType; -import org.springframework.context.annotation.ComponentScan.Filter; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@SpringBootApplication(scanBasePackages = {"org.onap.so"}) -@EnableAutoConfiguration(exclude = {JacksonAutoConfiguration.class}) -@ComponentScan(basePackages = {"org.onap"}, nameGenerator = DefaultToShortClassNameBeanNameGenerator.class, - excludeFilters = {@Filter(type = FilterType.ANNOTATION, classes = SpringBootApplication.class)}) -public class TestApplication { - - public static void main(final String[] args) { - new SpringApplication(TestApplication.class).run(args); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/NetworkServiceDescriptorParserTest.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/NetworkServiceDescriptorParserTest.java deleted file mode 100644 index 4a8c715e5c..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/bpmn/flows/nsd/parser/NetworkServiceDescriptorParserTest.java +++ /dev/null @@ -1,89 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.parser; - -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; -import java.io.File; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Paths; -import java.util.Map; -import java.util.Optional; -import org.junit.Test; -import org.junit.runner.RunWith; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.TestApplication; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.NetworkServiceDescriptor; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.parser.NetworkServiceDescriptorParser; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.test.context.SpringBootTest; -import org.springframework.test.context.ActiveProfiles; -import org.springframework.test.context.junit4.SpringRunner; - - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@RunWith(SpringRunner.class) -@SpringBootTest(classes = TestApplication.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) -@ActiveProfiles("test") -public class NetworkServiceDescriptorParserTest { - - private static final String VALID_ETSI_NSD_FILE = "src/test/resources/ns.csar"; - private static final String INVALID_ETSI_NSD_FILE = "src/test/resources/invalid_ns.csar"; - - @Autowired - private NetworkServiceDescriptorParser objUnderTest; - - @Test - public void testValidEtsiNsd_ableToParseIt() throws IOException { - final byte[] zipBytes = Files.readAllBytes(Paths.get(getAbsolutePath(VALID_ETSI_NSD_FILE))); - final Optional<NetworkServiceDescriptor> optional = objUnderTest.parse(zipBytes); - assertTrue(optional.isPresent()); - final NetworkServiceDescriptor actualNsd = optional.get(); - assertEquals(NetworkServiceDescriptorParser.NS_NODE_TYPE, actualNsd.getType()); - assertFalse(actualNsd.getProperties().isEmpty()); - - final Map<String, Object> actualNsdProperties = actualNsd.getProperties(); - assertEquals(5, actualNsdProperties.size()); - assertEquals("ffdddc5d-a44b-45ae-8fc3-e6551cce350f", actualNsdProperties.get("descriptor_id")); - assertEquals(5, actualNsd.getVnfs().size()); - - } - - @Test - public void testEmptyEtsiNsd_returnEmptyOptional() throws IOException { - assertFalse(objUnderTest.parse(new byte[] {}).isPresent()); - } - - @Test - public void testInvalidEtsiNsd_returnEmptyOptional() throws IOException { - final byte[] zipBytes = Files.readAllBytes(Paths.get(getAbsolutePath(INVALID_ETSI_NSD_FILE))); - assertFalse(objUnderTest.parse(zipBytes).isPresent()); - } - - private String getAbsolutePath(final String path) { - final File file = new File(path); - return file.getAbsolutePath(); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/CreateNsTaskTest.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/CreateNsTaskTest.java deleted file mode 100644 index 3686cd620d..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/CreateNsTaskTest.java +++ /dev/null @@ -1,381 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.workflow.engine.tasks; - -import static com.github.tomakehurst.wiremock.client.WireMock.get; -import static com.github.tomakehurst.wiremock.client.WireMock.notFound; -import static com.github.tomakehurst.wiremock.client.WireMock.ok; -import static com.github.tomakehurst.wiremock.client.WireMock.put; -import static com.github.tomakehurst.wiremock.client.WireMock.urlMatching; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertNull; -import static org.junit.Assert.assertTrue; -import static org.junit.Assert.fail; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.etsicatalog.EtsiCatalogServiceProviderConfiguration.ETSI_CATALOG_REST_TEMPLATE_BEAN; -import static org.springframework.test.web.client.match.MockRestRequestMatchers.method; -import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo; -import static org.springframework.test.web.client.response.MockRestResponseCreators.withStatus; -import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess; -import java.time.LocalDateTime; -import java.util.Arrays; -import java.util.HashMap; -import java.util.Map; -import java.util.Optional; -import java.util.UUID; -import org.camunda.bpm.engine.history.HistoricProcessInstance; -import org.camunda.bpm.engine.history.HistoricVariableInstance; -import org.camunda.bpm.engine.runtime.ProcessInstance; -import org.junit.After; -import org.junit.Before; -import org.junit.Test; -import org.onap.so.adapters.etsisol003adapter.pkgm.extclients.etsicatalog.model.NsdInfo; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.BaseTest; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.GsonProvider; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.exceptions.NsRequestProcessingException; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.service.JobExecutorService; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.service.WorkflowQueryService; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJob; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.onap.so.etsi.nfvo.ns.lcm.model.CreateNsRequest; -import org.onap.so.etsi.nfvo.ns.lcm.model.InlineResponse400; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsInstancesNsInstance; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsInstancesNsInstance.NsStateEnum; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.converter.json.GsonHttpMessageConverter; -import org.springframework.test.web.client.MockRestServiceServer; -import org.springframework.web.client.RestTemplate; -import com.github.tomakehurst.wiremock.client.WireMock; -import com.google.gson.Gson; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class CreateNsTaskTest extends BaseTest { - private static final String NSD_ID = UUID.randomUUID().toString(); - private static final String NS_NAME = "CreateNetworkService-" + NSD_ID; - private static final String CREATE_NS_WORKFLOW_NAME = "CreateNs"; - - @Autowired - @Qualifier(ETSI_CATALOG_REST_TEMPLATE_BEAN) - private RestTemplate restTemplate; - - @Autowired - private GsonProvider gsonProvider; - - @Autowired - private JobExecutorService objUnderTest; - - @Autowired - private WorkflowQueryService workflowQueryService; - - private MockRestServiceServer mockRestServiceServer; - - private Gson gson; - - @Before - public void before() { - wireMockServer.resetAll(); - final MockRestServiceServer.MockRestServiceServerBuilder builder = MockRestServiceServer.bindTo(restTemplate); - builder.ignoreExpectOrder(true); - mockRestServiceServer = builder.build(); - gson = gsonProvider.getGson(); - restTemplate.getMessageConverters().add(new GsonHttpMessageConverter(gson)); - } - - @After - public void after() { - wireMockServer.resetAll(); - mockRestServiceServer.reset(); - } - - @Test - public void testCreateNsWorkflow_SuccessfullCase() throws InterruptedException { - final CreateNsRequest createNsRequest = getCreateNsRequest(); - - mockEtsiCatalogEndpoints(); - mockAAIEndpoints(createNsRequest); - - final NsInstancesNsInstance nsResponse = - objUnderTest.runCreateNsJob(createNsRequest, GLOBAL_CUSTOMER_ID, SERVICE_TYPE); - assertNotNull(nsResponse); - assertNotNull(nsResponse.getId()); - - final Optional<NfvoJob> optional = getJobByResourceId(createNsRequest.getNsdId()); - assertTrue(optional.isPresent()); - final NfvoJob nfvoJob = optional.get(); - - assertTrue(waitForProcessInstanceToFinish(nfvoJob.getProcessInstanceId())); - - mockRestServiceServer.verify(); - final HistoricProcessInstance historicProcessInstance = - getHistoricProcessInstance(nfvoJob.getProcessInstanceId()); - assertNotNull(historicProcessInstance); - - assertEquals(HistoricProcessInstance.STATE_COMPLETED, historicProcessInstance.getState()); - assertTrue(databaseServiceProvider.isNsInstExists(createNsRequest.getNsName())); - - final NfvoJob actualJob = optional.get(); - assertEquals(JobStatusEnum.FINISHED, actualJob.getStatus()); - - assertEquals(NS_NAME, nsResponse.getNsInstanceName()); - assertEquals(NsStateEnum.NOT_INSTANTIATED, nsResponse.getNsState()); - - final HistoricVariableInstance doesNsPackageExistsVar = - getVariable(nfvoJob.getProcessInstanceId(), "doesNsPackageExists"); - assertNotNull(doesNsPackageExistsVar); - assertTrue((boolean) doesNsPackageExistsVar.getValue()); - - final HistoricVariableInstance doesNsInstanceExistsVar = - getVariable(nfvoJob.getProcessInstanceId(), "doesNsInstanceExists"); - assertNotNull(doesNsInstanceExistsVar); - assertFalse((boolean) doesNsInstanceExistsVar.getValue()); - - } - - @Test - public void testCreateNsWorkflow_FailsToGetNsPackage() throws InterruptedException { - final String nsdId = UUID.randomUUID().toString(); - final String nsdName = NS_NAME + "-" + System.currentTimeMillis(); - final CreateNsRequest createNsRequest = getCreateNsRequest(nsdId, nsdName); - - mockRestServiceServer.expect(requestTo(ETSI_CATALOG_URL + "/nsd/v1/ns_descriptors/" + nsdId)) - .andExpect(method(HttpMethod.GET)).andRespond(withStatus(HttpStatus.NOT_FOUND)); - - try { - objUnderTest.runCreateNsJob(createNsRequest, GLOBAL_CUSTOMER_ID, SERVICE_TYPE); - fail("runCreateNsJob should throw exception"); - } catch (final Exception exception) { - assertEquals(NsRequestProcessingException.class, exception.getClass()); - } - - final Optional<NfvoJob> optional = getJobByResourceId(createNsRequest.getNsdId()); - assertTrue(optional.isPresent()); - final NfvoJob nfvoJob = optional.get(); - assertEquals(JobStatusEnum.ERROR, nfvoJob.getStatus()); - - assertTrue(waitForProcessInstanceToFinish(nfvoJob.getProcessInstanceId())); - - mockRestServiceServer.verify(); - final HistoricProcessInstance historicProcessInstance = - getHistoricProcessInstance(nfvoJob.getProcessInstanceId()); - assertNotNull(historicProcessInstance); - - assertEquals(HistoricProcessInstance.STATE_COMPLETED, historicProcessInstance.getState()); - - - final HistoricVariableInstance nsResponseVariable = - getVariable(nfvoJob.getProcessInstanceId(), CamundaVariableNameConstants.CREATE_NS_RESPONSE_PARAM_NAME); - assertNull(nsResponseVariable); - - final Optional<InlineResponse400> problemDetailsOptional = - workflowQueryService.getProblemDetails(nfvoJob.getProcessInstanceId()); - assertTrue(problemDetailsOptional.isPresent()); - - final InlineResponse400 problemDetails = problemDetailsOptional.get(); - assertNotNull(problemDetails); - assertNotNull(problemDetails.getDetail()); - - final HistoricVariableInstance doesNsPackageExistsVar = - getVariable(nfvoJob.getProcessInstanceId(), "doesNsPackageExists"); - assertNotNull(doesNsPackageExistsVar); - assertFalse((boolean) doesNsPackageExistsVar.getValue()); - assertEquals("Unexpected exception occured while getting ns package using nsdId: " + nsdId, - problemDetails.getDetail()); - } - - @Test - public void testCreateNsWorkflow_FailsToFindJobUsingJobId() throws InterruptedException { - final String nsdId = UUID.randomUUID().toString(); - final String nsdName = NS_NAME + "-" + System.currentTimeMillis(); - final CreateNsRequest createNsRequest = getCreateNsRequest(nsdId, nsdName); - - final String randomJobId = UUID.randomUUID().toString(); - final ProcessInstance processInstance = - executeWorkflow(CREATE_NS_WORKFLOW_NAME, randomJobId, getVariables(randomJobId, createNsRequest)); - assertTrue(waitForProcessInstanceToFinish(processInstance.getProcessInstanceId())); - - mockRestServiceServer.verify(); - final HistoricProcessInstance historicProcessInstance = - getHistoricProcessInstance(processInstance.getProcessInstanceId()); - assertNotNull(historicProcessInstance); - - assertEquals(HistoricProcessInstance.STATE_COMPLETED, historicProcessInstance.getState()); - - final HistoricVariableInstance nsResponseVariable = getVariable(processInstance.getProcessInstanceId(), - CamundaVariableNameConstants.CREATE_NS_RESPONSE_PARAM_NAME); - - assertNull(nsResponseVariable); - - final HistoricVariableInstance workflowExceptionVariable = getVariable(processInstance.getProcessInstanceId(), - CamundaVariableNameConstants.NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME); - - final InlineResponse400 problemDetails = (InlineResponse400) workflowExceptionVariable.getValue(); - assertNotNull(problemDetails); - assertNotNull(problemDetails.getDetail()); - assertEquals("Unable to find job using job id: " + randomJobId, problemDetails.getDetail()); - - } - - @Test - public void testCreateNsWorkflow_NsInstanceExistsInDb() throws InterruptedException { - final String nsdId = UUID.randomUUID().toString(); - final String nsdName = NS_NAME + "-" + System.currentTimeMillis(); - final CreateNsRequest createNsRequest = getCreateNsRequest(nsdId, nsdName); - - databaseServiceProvider.saveNfvoNsInst(new NfvoNsInst().nsInstId(nsdId).name(createNsRequest.getNsName()) - .nsPackageId(UUID.randomUUID().toString()).nsdId(nsdId).nsdInvariantId(nsdId) - .description(createNsRequest.getNsDescription()).status(State.INSTANTIATED) - .statusUpdatedTime(LocalDateTime.now()).globalCustomerId(GLOBAL_CUSTOMER_ID).serviceType(SERVICE_TYPE)); - - mockEtsiCatalogEndpoints(nsdId); - - try { - objUnderTest.runCreateNsJob(createNsRequest, GLOBAL_CUSTOMER_ID, SERVICE_TYPE); - fail("runCreateNsJob should throw exception"); - } catch (final Exception exception) { - assertEquals(NsRequestProcessingException.class, exception.getClass()); - } - - final Optional<NfvoJob> optional = getJobByResourceId(createNsRequest.getNsdId()); - assertTrue(optional.isPresent()); - final NfvoJob nfvoJob = optional.get(); - assertEquals(JobStatusEnum.ERROR, nfvoJob.getStatus()); - - assertTrue(waitForProcessInstanceToFinish(nfvoJob.getProcessInstanceId())); - - mockRestServiceServer.verify(); - final HistoricProcessInstance historicProcessInstance = - getHistoricProcessInstance(nfvoJob.getProcessInstanceId()); - assertNotNull(historicProcessInstance); - - assertEquals(HistoricProcessInstance.STATE_COMPLETED, historicProcessInstance.getState()); - assertTrue(databaseServiceProvider.isNsInstExists(createNsRequest.getNsName())); - - final HistoricVariableInstance historicVariableInstance = - getVariable(nfvoJob.getProcessInstanceId(), CamundaVariableNameConstants.CREATE_NS_RESPONSE_PARAM_NAME); - - assertNull(historicVariableInstance); - - final Optional<InlineResponse400> problemDetailsOptional = - workflowQueryService.getProblemDetails(nfvoJob.getProcessInstanceId()); - - final InlineResponse400 problemDetails = problemDetailsOptional.get(); - assertNotNull(problemDetails); - assertNotNull(problemDetails.getDetail()); - assertTrue(problemDetails.getDetail().startsWith("Ns Instance already exists in database")); - - final HistoricVariableInstance doesNsInstanceExistsVar = - getVariable(nfvoJob.getProcessInstanceId(), "doesNsInstanceExists"); - assertNotNull(doesNsInstanceExistsVar); - assertTrue((boolean) doesNsInstanceExistsVar.getValue()); - - } - - @Test - public void testCreateNsWorkflow_FailToCreateResouceInAai() throws InterruptedException { - final String nsdId = UUID.randomUUID().toString(); - final String nsdName = NS_NAME + "-" + System.currentTimeMillis(); - final CreateNsRequest createNsRequest = getCreateNsRequest(nsdId, nsdName); - - mockEtsiCatalogEndpoints(nsdId); - - final String modelEndpoint = getAaiServiceInstanceEndPoint(); - wireMockServer.stubFor(put(urlMatching(modelEndpoint)).willReturn(WireMock.serverError())); - wireMockServer.stubFor(get(urlMatching(modelEndpoint)).willReturn(WireMock.serverError())); - - try { - objUnderTest.runCreateNsJob(createNsRequest, GLOBAL_CUSTOMER_ID, SERVICE_TYPE); - fail("runCreateNsJob should throw exception"); - } catch (final Exception exception) { - assertEquals(NsRequestProcessingException.class, exception.getClass()); - } - final Optional<NfvoJob> optional = getJobByResourceId(createNsRequest.getNsdId()); - assertTrue(optional.isPresent()); - final NfvoJob nfvoJob = optional.get(); - assertEquals(JobStatusEnum.ERROR, nfvoJob.getStatus()); - - mockRestServiceServer.verify(); - final HistoricProcessInstance historicProcessInstance = - getHistoricProcessInstance(nfvoJob.getProcessInstanceId()); - assertNotNull(historicProcessInstance); - - assertEquals(HistoricProcessInstance.STATE_COMPLETED, historicProcessInstance.getState()); - assertTrue(databaseServiceProvider.isNsInstExists(createNsRequest.getNsName())); - - final Optional<InlineResponse400> problemDetailsOptional = - workflowQueryService.getProblemDetails(nfvoJob.getProcessInstanceId()); - - final InlineResponse400 problemDetails = problemDetailsOptional.get(); - assertNotNull(problemDetails); - assertEquals("Unable to Create Service Instance in AAI", problemDetails.getDetail()); - - } - - private void mockAAIEndpoints(final CreateNsRequest createNsRequest) { - final String modelEndpoint = getAaiServiceInstanceEndPoint(); - - wireMockServer.stubFor(put(urlMatching(modelEndpoint)).willReturn(ok())); - wireMockServer.stubFor(get(urlMatching(modelEndpoint)).willReturn(notFound())); - } - - private void mockEtsiCatalogEndpoints(final String nsdId) { - mockRestServiceServer.expect(requestTo(ETSI_CATALOG_URL + "/nsd/v1/ns_descriptors/" + nsdId)) - .andExpect(method(HttpMethod.GET)) - .andRespond(withSuccess(gson.toJson(getNSPackageModel(NSD_ID)), MediaType.APPLICATION_JSON)); - } - - private void mockEtsiCatalogEndpoints() { - mockEtsiCatalogEndpoints(NSD_ID);; - } - - private NsdInfo getNSPackageModel(final String nsdId) { - return new NsdInfo().id(nsdId).nsdId(nsdId).nsdInvariantId(NSD_INVARIANT_ID).nsdName("vcpe").nsdDesigner("ONAP") - .vnfPkgIds(Arrays.asList(GLOBAL_CUSTOMER_ID)); - } - - private CreateNsRequest getCreateNsRequest() { - return getCreateNsRequest(NSD_ID, NS_NAME); - } - - private CreateNsRequest getCreateNsRequest(final String nsdId, final String nsName) { - return new CreateNsRequest().nsdId(nsdId).nsName(nsName); - } - - private Map<String, Object> getVariables(final String jobId, final CreateNsRequest createNsRequest) { - final Map<String, Object> variables = new HashMap<>(); - variables.put(CamundaVariableNameConstants.JOB_ID_PARAM_NAME, jobId); - variables.put(CamundaVariableNameConstants.CREATE_NS_REQUEST_PARAM_NAME, createNsRequest); - variables.put(CamundaVariableNameConstants.GLOBAL_CUSTOMER_ID_PARAM_NAME, GLOBAL_CUSTOMER_ID); - variables.put(CamundaVariableNameConstants.SERVICE_TYPE_PARAM_NAME, SERVICE_TYPE); - - return variables; - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/DeleteNsTaskTest.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/DeleteNsTaskTest.java deleted file mode 100644 index 017bdf6b70..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/DeleteNsTaskTest.java +++ /dev/null @@ -1,177 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.workflow.engine.tasks; - -import static com.github.tomakehurst.wiremock.client.WireMock.delete; -import static com.github.tomakehurst.wiremock.client.WireMock.get; -import static com.github.tomakehurst.wiremock.client.WireMock.ok; -import static com.github.tomakehurst.wiremock.client.WireMock.okJson; -import static com.github.tomakehurst.wiremock.client.WireMock.urlMatching; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertTrue; -import java.time.LocalDateTime; -import java.util.Optional; -import java.util.UUID; -import org.camunda.bpm.engine.history.HistoricProcessInstance; -import org.junit.After; -import org.junit.Before; -import org.junit.Rule; -import org.junit.Test; -import org.junit.rules.ExpectedException; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.BaseTest; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.exceptions.NsRequestProcessingException; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.service.JobExecutorService; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJob; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.springframework.beans.factory.annotation.Autowired; - -/** - * @author Andrew Lamb (andrew.a.lamb@est.tech) - * - */ -public class DeleteNsTaskTest extends BaseTest { - - @Autowired - private JobExecutorService objUnderTest; - - @Rule - public ExpectedException expectedException = ExpectedException.none(); - - @Before - public void before() { - wireMockServer.resetAll(); - } - - @After - public void after() { - wireMockServer.resetAll(); - } - - @Test - public void testRunDeleteNsJob_nsInstanceIdNotInDatabase_throwsException() { - final String nsInstanceId = UUID.randomUUID().toString(); - assertTrue(databaseServiceProvider.getNfvoNsInst(nsInstanceId).isEmpty()); - - expectedException.expect(NsRequestProcessingException.class); - objUnderTest.runDeleteNsJob(nsInstanceId); - } - - @Test - public void testRunDeleteNsJob_nsInstanceStateInstantiated_throwsException() { - final String nsInstanceId = UUID.randomUUID().toString(); - addDummyNsToDatabase(nsInstanceId, State.INSTANTIATED); - - final Optional<NfvoNsInst> optionalNfvoNsInst = databaseServiceProvider.getNfvoNsInst(nsInstanceId); - assertTrue(optionalNfvoNsInst.isPresent()); - assertEquals(State.INSTANTIATED, optionalNfvoNsInst.get().getStatus()); - - expectedException.expect(NsRequestProcessingException.class); - objUnderTest.runDeleteNsJob(nsInstanceId); - } - - @Test - public void testRunDeleteNsJob_nsInstanceStateInstantiating_throwsException() { - final String nsInstanceId = UUID.randomUUID().toString(); - addDummyNsToDatabase(nsInstanceId, State.INSTANTIATING); - - final Optional<NfvoNsInst> optionalNfvoNsInst = databaseServiceProvider.getNfvoNsInst(nsInstanceId); - assertTrue(optionalNfvoNsInst.isPresent()); - assertEquals(State.INSTANTIATING, optionalNfvoNsInst.get().getStatus()); - - expectedException.expect(NsRequestProcessingException.class); - objUnderTest.runDeleteNsJob(nsInstanceId); - } - - @Test - public void testRunDeleteNsJob_nsInstanceStateTerminating_throwsException() { - final String nsInstanceId = UUID.randomUUID().toString(); - addDummyNsToDatabase(nsInstanceId, State.TERMINATING); - - final Optional<NfvoNsInst> optionalNfvoNsInst = databaseServiceProvider.getNfvoNsInst(nsInstanceId); - assertTrue(optionalNfvoNsInst.isPresent()); - assertEquals(State.TERMINATING, optionalNfvoNsInst.get().getStatus()); - - expectedException.expect(NsRequestProcessingException.class); - objUnderTest.runDeleteNsJob(nsInstanceId); - } - - @Test - public void testRunDeleteNsJob_nsInstanceStateFailed_throwsException() { - final String nsInstanceId = UUID.randomUUID().toString(); - addDummyNsToDatabase(nsInstanceId, State.FAILED); - - final Optional<NfvoNsInst> optionalNfvoNsInst = databaseServiceProvider.getNfvoNsInst(nsInstanceId); - assertTrue(optionalNfvoNsInst.isPresent()); - assertEquals(State.FAILED, optionalNfvoNsInst.get().getStatus()); - - expectedException.expect(NsRequestProcessingException.class); - objUnderTest.runDeleteNsJob(nsInstanceId); - } - - @Test - public void testRunDeleteNsJob_SuccessfulCase() throws InterruptedException { - final String nsInstanceId = UUID.randomUUID().toString(); - addDummyNsToDatabase(nsInstanceId, State.NOT_INSTANTIATED); - mockAaiEndpoints(); - - final Optional<NfvoNsInst> optionalNfvoNsInst = databaseServiceProvider.getNfvoNsInst(nsInstanceId); - assertTrue(optionalNfvoNsInst.isPresent()); - assertEquals(State.NOT_INSTANTIATED, optionalNfvoNsInst.get().getStatus()); - - objUnderTest.runDeleteNsJob(nsInstanceId); - - final Optional<NfvoJob> optional = getJobByResourceId(nsInstanceId); - assertTrue(optional.isPresent()); - final NfvoJob nfvoJob = optional.get(); - - // Confirm Process finishes in STATE_COMPLETED - assertTrue(waitForProcessInstanceToFinish(nfvoJob.getProcessInstanceId())); - final HistoricProcessInstance historicProcessInstance = - getHistoricProcessInstance(nfvoJob.getProcessInstanceId()); - assertNotNull(historicProcessInstance); - assertEquals(HistoricProcessInstance.STATE_COMPLETED, historicProcessInstance.getState()); - - // Confirm NS Instance no longer in database - final Optional<NfvoNsInst> optionalNfvoNsInstance = databaseServiceProvider.getNfvoNsInst(nsInstanceId); - assertTrue(optionalNfvoNsInstance.isEmpty()); - } - - private void addDummyNsToDatabase(final String nsInstanceId, final State state) { - final String nsPackageId = UUID.randomUUID().toString(); - final NfvoNsInst nfvoNsInst = new NfvoNsInst().nsInstId(nsInstanceId).name("nsName").nsPackageId(nsPackageId) - .nsdId("nsdId").nsdInvariantId("nsdId").status(state).statusUpdatedTime(LocalDateTime.now()) - .globalCustomerId(GLOBAL_CUSTOMER_ID).serviceType(SERVICE_TYPE); - databaseServiceProvider.saveNfvoNsInst(nfvoNsInst); - } - - private void mockAaiEndpoints() { - final String modelEndpoint = getAaiServiceInstanceEndPoint(); - final String resourceVersion = "12345"; - - final String body = - "{\"resource-version\": \"" + resourceVersion + "\",\n\"orchestration-status\": \"Assigned\"}"; - wireMockServer.stubFor(get(urlMatching(modelEndpoint)).willReturn(ok()).willReturn(okJson(body))); - - wireMockServer.stubFor( - delete(urlMatching(modelEndpoint + "\\?resource-version=" + resourceVersion)).willReturn(ok())); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/InstantiateNsTaskTest.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/InstantiateNsTaskTest.java deleted file mode 100644 index f1373bd4ea..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/InstantiateNsTaskTest.java +++ /dev/null @@ -1,327 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.workflow.engine.tasks; - -import static com.github.tomakehurst.wiremock.client.WireMock.get; -import static com.github.tomakehurst.wiremock.client.WireMock.notFound; -import static com.github.tomakehurst.wiremock.client.WireMock.ok; -import static com.github.tomakehurst.wiremock.client.WireMock.okJson; -import static com.github.tomakehurst.wiremock.client.WireMock.put; -import static com.github.tomakehurst.wiremock.client.WireMock.urlMatching; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertTrue; -import static org.onap.aaiclient.client.aai.AAIVersion.V19; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants.NETWORK_SERVICE_DESCRIPTOR_PARAM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.etsicatalog.EtsiCatalogServiceProviderConfiguration.ETSI_CATALOG_REST_TEMPLATE_BEAN; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.vnfm.Sol003AdapterConfiguration.SOL003_ADAPTER_REST_TEMPLATE_BEAN; -import static org.springframework.test.web.client.ExpectedCount.times; -import static org.springframework.test.web.client.match.MockRestRequestMatchers.method; -import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo; -import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess; -import java.io.File; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Paths; -import java.time.LocalDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Map.Entry; -import java.util.Optional; -import java.util.UUID; -import java.util.stream.Collectors; -import org.camunda.bpm.engine.history.HistoricProcessInstance; -import org.camunda.bpm.engine.history.HistoricVariableInstance; -import org.hamcrest.text.MatchesPattern; -import org.junit.After; -import org.junit.Before; -import org.junit.Test; -import org.onap.aaiclient.client.aai.entities.Results; -import org.onap.aaiclient.client.graphinventory.entities.Resource; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.CreateVnfResponse; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.OperationStatusRetrievalStatusEnum; -import org.onap.so.adapters.etsisol003adapter.pkgm.extclients.etsicatalog.model.NsdInfo; -import org.onap.so.adapters.etsisol003adapter.pkgm.extclients.etsicatalog.model.VnfPkgInfo; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.BaseTest; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.GsonProvider; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.nsd.NetworkServiceDescriptor; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.service.JobExecutorService; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJob; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNfInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NsLcmOpOcc; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.OperationStateEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.model.InstantiateNsRequest; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsInstancesnsInstanceIdinstantiateAdditionalParamsForVnf; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.http.HttpMethod; -import org.springframework.http.MediaType; -import org.springframework.http.converter.json.GsonHttpMessageConverter; -import org.springframework.test.web.client.MockRestServiceServer; -import org.springframework.web.client.RestTemplate; -import com.fasterxml.jackson.core.JsonProcessingException; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.google.gson.Gson; - -/** - * @author Andrew Lamb (andrew.a.lamb@est.tech) - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class InstantiateNsTaskTest extends BaseTest { - - private static final String TENANT_ID = "6ca8680feba04dad9254f423c6e28e1c"; - private static final String CLOUD_REGION = "regionOne"; - private static final String CLOUD_OWNER = "CloudOwner"; - private static final String UUID_REGEX = - "[0-9a-zA-Z]{8}\\-[0-9a-zA-Z]{4}\\-[0-9a-zA-Z]{4}\\-[0-9a-zA-Z]{4}\\-[0-9a-zA-Z]{12}"; - private static final String VCPE_VBRGEMU_VNFD_ID = "b1bb0ce7-2222-4fa7-95ed-4840d70a1102"; - private static final String VCPE_VBNG = "b1bb0ce7-2222-4fa7-95ed-4840d70a1101"; - private static final String VCPE_INFRA_VNFD_ID = "b1bb0ce7-2222-4fa7-95ed-4840d70a1100"; - private static final String VGMUX_VNFD_ID = "0408f076-e6c0-4c82-9940-272fddbb82de"; - private static final String VGW_VNFD_ID = "3fca3543-07f5-492f-812c-ed462e4f94f4"; - private static final String[] VCPE_VNFDS = - new String[] {VGW_VNFD_ID, VGMUX_VNFD_ID, VCPE_INFRA_VNFD_ID, VCPE_VBNG, VCPE_VBRGEMU_VNFD_ID}; - private static final String SAMPLE_NSD_FILE = "src/test/resources/ns.csar"; - private static final String NS_NAME = "InstantiateNetworkService"; - - @Autowired - private DatabaseServiceProvider databaseServiceProvider; - - @Autowired - @Qualifier(ETSI_CATALOG_REST_TEMPLATE_BEAN) - private RestTemplate etsiCatalogRestTemplate; - - @Autowired - @Qualifier(SOL003_ADAPTER_REST_TEMPLATE_BEAN) - private RestTemplate sol003AdapterRestTemplate; - - private MockRestServiceServer mockEtsiCatalogRestServiceServer; - - private MockRestServiceServer mockSol003AdapterRestServiceServer; - - @Autowired - private JobExecutorService objUnderTest; - - @Autowired - private GsonProvider gsonProvider; - - private Gson gson; - - private static final Map<String, String> VNFD_ID_TO_VNFPKG_ID_MAPPING = new HashMap<>(); - static { - for (final String vnfd : VCPE_VNFDS) { - VNFD_ID_TO_VNFPKG_ID_MAPPING.put(vnfd, UUID.randomUUID().toString()); - } - } - - @Before - public void before() { - wireMockServer.resetAll(); - gson = gsonProvider.getGson(); - - mockEtsiCatalogRestServiceServer = - MockRestServiceServer.bindTo(etsiCatalogRestTemplate).ignoreExpectOrder(true).build(); - mockSol003AdapterRestServiceServer = - MockRestServiceServer.bindTo(sol003AdapterRestTemplate).ignoreExpectOrder(true).build(); - - etsiCatalogRestTemplate.getMessageConverters().add(new GsonHttpMessageConverter(gson)); - sol003AdapterRestTemplate.getMessageConverters().add(new GsonHttpMessageConverter(gson)); - - } - - @After - public void after() { - wireMockServer.resetAll(); - mockEtsiCatalogRestServiceServer.reset(); - } - - @Test - public void testInstantiateNsWorkflow_JustUpdateStatus_SuccessfullCase() throws InterruptedException, IOException { - final String nsdId = UUID.randomUUID().toString(); - final String nsdName = NS_NAME + "-" + System.currentTimeMillis(); - - final NfvoNsInst newNfvoNsInst = new NfvoNsInst().nsInstId(nsdId).name(nsdName) - .nsPackageId(UUID.randomUUID().toString()).nsPackageId(nsdId).nsdId(nsdId).nsdInvariantId(nsdId) - .status(State.NOT_INSTANTIATED).statusUpdatedTime(LocalDateTime.now()); - - databaseServiceProvider.saveNfvoNsInst(newNfvoNsInst); - - mockSol003AdapterEndpoints(); - mockAAIEndpoints(nsdId); - mockEtsiCatalogEndpoints(nsdId); - - final String nsLcmOpOccId = - objUnderTest.runInstantiateNsJob(newNfvoNsInst.getNsInstId(), getInstantiateNsRequest()); - - final Optional<NfvoJob> optional = getJobByResourceId(newNfvoNsInst.getNsInstId()); - assertTrue(optional.isPresent()); - final NfvoJob nfvoJob = optional.get(); - - assertTrue(waitForProcessInstanceToFinish(nfvoJob.getProcessInstanceId())); - - final HistoricProcessInstance historicProcessInstance = - getHistoricProcessInstance(nfvoJob.getProcessInstanceId()); - assertNotNull(historicProcessInstance); - - assertEquals(HistoricProcessInstance.STATE_COMPLETED, historicProcessInstance.getState()); - - // check if value in database has updated - final Optional<NfvoNsInst> optionalNfvoNsInst = databaseServiceProvider.getNfvoNsInst(nsdId); - final NfvoNsInst nfvoNsInst = optionalNfvoNsInst.get(); - assertEquals(State.INSTANTIATED, nfvoNsInst.getStatus()); - - final HistoricVariableInstance historicVariableInstance = - getVariable(nfvoJob.getProcessInstanceId(), NETWORK_SERVICE_DESCRIPTOR_PARAM_NAME); - assertNotNull(historicVariableInstance); - final NetworkServiceDescriptor nsd = (NetworkServiceDescriptor) historicVariableInstance.getValue(); - assertNotNull(nsd); - - assertEquals(VNFD_ID_TO_VNFPKG_ID_MAPPING.size(), nsd.getVnfs().size()); - - final List<NfvoNfInst> nfvoNfInsts = databaseServiceProvider.getNfvoNfInstByNsInstId(nsdId); - assertNotNull(nsd); - assertEquals(VNFD_ID_TO_VNFPKG_ID_MAPPING.size(), nfvoNfInsts.size()); - - final Optional<NsLcmOpOcc> optionalNsLcmOpOcc = databaseServiceProvider.getNsLcmOpOcc(nsLcmOpOccId); - assertTrue(optionalNsLcmOpOcc.isPresent()); - - assertEquals(OperationStateEnum.COMPLETED, optionalNsLcmOpOcc.get().getOperationState()); - - final Map<String, NfvoNfInst> nfvoNfInstsMap = - nfvoNfInsts.stream().collect(Collectors.toMap(NfvoNfInst::getVnfdId, nfvoNfInst -> nfvoNfInst)); - - for (final Entry<String, String> entry : VNFD_ID_TO_VNFPKG_ID_MAPPING.entrySet()) { - assertTrue(nfvoNfInstsMap.containsKey(entry.getKey())); - assertEquals(State.INSTANTIATED, nfvoNfInstsMap.get(entry.getKey()).getStatus()); - - } - - } - - private void mockSol003AdapterEndpoints() { - mockSol003AdapterRestServiceServer - .expect(times(VNFD_ID_TO_VNFPKG_ID_MAPPING.size()), - requestTo(MatchesPattern.matchesPattern(SOL003_ADAPTER_ENDPOINT_URL + "/vnfs/.*"))) - .andExpect(method(HttpMethod.POST)) - .andRespond(withSuccess(gson.toJson(new CreateVnfResponse().jobId(UUID.randomUUID().toString())), - MediaType.APPLICATION_JSON)); - - mockSol003AdapterRestServiceServer - .expect(times(VNFD_ID_TO_VNFPKG_ID_MAPPING.size()), - requestTo(MatchesPattern.matchesPattern(SOL003_ADAPTER_ENDPOINT_URL + "/jobs/.*"))) - .andExpect(method(HttpMethod.GET)) - .andRespond(withSuccess(gson.toJson( - new org.onap.so.adapters.etsisol003adapter.lcm.v1.model.QueryJobResponse().operationState( - org.onap.so.adapters.etsisol003adapter.lcm.v1.model.OperationStateEnum.COMPLETED) - .operationStatusRetrievalStatus(OperationStatusRetrievalStatusEnum.STATUS_FOUND)), - MediaType.APPLICATION_JSON)); - } - - private void mockEtsiCatalogEndpoints(final String nsdId) throws IOException { - mockEtsiCatalogRestServiceServer.expect(requestTo(ETSI_CATALOG_URL + "/nsd/v1/ns_descriptors/" + nsdId)) - .andExpect(method(HttpMethod.GET)) - .andRespond(withSuccess(gson.toJson(getNSPackageModel(nsdId)), MediaType.APPLICATION_JSON)); - mockEtsiCatalogRestServiceServer - .expect(requestTo(ETSI_CATALOG_URL + "/nsd/v1/ns_descriptors/" + nsdId + "/nsd_content")) - .andExpect(method(HttpMethod.GET)).andRespond(withSuccess( - getFileContent(getAbsolutePath(SAMPLE_NSD_FILE)), MediaType.APPLICATION_OCTET_STREAM)); - - for (final Entry<String, String> entry : VNFD_ID_TO_VNFPKG_ID_MAPPING.entrySet()) { - mockEtsiCatalogRestServiceServer - .expect(requestTo(ETSI_CATALOG_URL + "/vnfpkgm/v1/vnf_packages/" + entry.getValue())) - .andExpect(method(HttpMethod.GET)).andRespond(withSuccess( - gson.toJson(getVnfPkgInfo(entry.getKey(), entry.getValue())), MediaType.APPLICATION_JSON)); - } - - } - - private VnfPkgInfo getVnfPkgInfo(final String vnfdId, final String vnfPkgId) { - return new VnfPkgInfo().id(vnfPkgId).vnfdId(vnfdId); - } - - private InstantiateNsRequest getInstantiateNsRequest() { - final Map<String, Object> additionalParams = new HashMap<>(); - additionalParams.put("vim_id", CLOUD_OWNER + "_" + CLOUD_REGION + "_" + TENANT_ID); - - final InstantiateNsRequest instantiateNsRequest = new InstantiateNsRequest().nsFlavourId("default"); - - for (final Entry<String, String> entry : VNFD_ID_TO_VNFPKG_ID_MAPPING.entrySet()) { - instantiateNsRequest - .addAdditionalParamsForVnfItem(new NsInstancesnsInstanceIdinstantiateAdditionalParamsForVnf() - .vnfProfileId(entry.getKey()).additionalParams(additionalParams)); - } - - return instantiateNsRequest; - } - - private NsdInfo getNSPackageModel(final String nsdId) { - return new NsdInfo().id(nsdId).nsdId(nsdId).nsdInvariantId(NSD_INVARIANT_ID).nsdName("vcpe").nsdDesigner("ONAP") - .vnfPkgIds(new ArrayList<>(VNFD_ID_TO_VNFPKG_ID_MAPPING.values())); - } - - private byte[] getFileContent(final String path) throws IOException { - return Files.readAllBytes(Paths.get(path)); - } - - - private String getAbsolutePath(final String path) { - return new File(path).getAbsolutePath(); - } - - private void mockAAIEndpoints(final String nsdId) throws JsonProcessingException { - final String modelEndpoint = "/aai/" + V19 + "/network/generic-vnfs/generic-vnf/" + UUID_REGEX; - - wireMockServer.stubFor( - get(urlMatching(modelEndpoint + "\\?resultIndex=0&resultSize=1&format=count")).willReturn(notFound())); - - wireMockServer.stubFor(put(urlMatching(modelEndpoint)).willReturn(ok())); - wireMockServer.stubFor(put(urlMatching(modelEndpoint + "/relationship-list/relationship")).willReturn(ok())); - - wireMockServer.stubFor(get(urlMatching(modelEndpoint)).willReturn(ok()) - .willReturn(okJson("{\"orchestration-status\": \"Created\"}"))); - - wireMockServer.stubFor(get(urlMatching("/aai/" + V19 + "/nodes/service-instances/service-instance/.*")) - .willReturn(okJson(getResourceResultsResponseAsJson(nsdId)))); - - wireMockServer.stubFor( - put(urlMatching("/aai/" + V19 + "/cloud-infrastructure/cloud-regions/cloud-region/" + CLOUD_OWNER + "/" - + CLOUD_REGION + "/tenants/tenant/" + TENANT_ID + "/relationship-list/relationship")) - .willReturn(ok())); - - } - - private String getResourceResultsResponseAsJson(final String nsdId) throws JsonProcessingException { - final Resource resource = new Resource(); - resource.setResourceType("service-instance"); - resource.setResourceLink("/aai/" + V19 + "/business/customers/customer/" + GLOBAL_CUSTOMER_ID - + "/service-subscriptions/service-subscription/NetworkService/service-instances/service-instance/" - + nsdId); - final Results<Resource> results = new Results<>(); - results.getResult().add(resource); - return new ObjectMapper().writeValueAsString(results); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/MonitorInstantiateSol003AdapterNodeTaskTest.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/MonitorInstantiateSol003AdapterNodeTaskTest.java deleted file mode 100644 index ea720cd73b..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/MonitorInstantiateSol003AdapterNodeTaskTest.java +++ /dev/null @@ -1,93 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.workflow.engine.tasks; - -import static com.github.tomakehurst.wiremock.client.WireMock.get; -import static com.github.tomakehurst.wiremock.client.WireMock.ok; -import static com.github.tomakehurst.wiremock.client.WireMock.okJson; -import static com.github.tomakehurst.wiremock.client.WireMock.urlMatching; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertTrue; -import java.util.HashMap; -import java.util.Map; -import java.util.UUID; -import org.camunda.bpm.engine.history.HistoricProcessInstance; -import org.camunda.bpm.engine.history.HistoricVariableInstance; -import org.camunda.bpm.engine.runtime.ProcessInstance; -import org.junit.Before; -import org.junit.Test; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.BaseTest; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.tasks.MonitorInstantiateSol003AdapterNodeTask; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class MonitorInstantiateSol003AdapterNodeTaskTest extends BaseTest { - - private static final String RANDOWM_GENERIC_VNF_ID = UUID.randomUUID().toString(); - private static final String MONITOR_SOL003_ADAPTER_CREATE_NODE_STATUS_WORKFLOW = - "MonitorSol003AdapterCreateNodeStatus"; - - @Before - public void before() { - wireMockServer.resetAll(); - } - - @Test - public void testMonitorSol003AdapterCreateNodeStatus_SuccessfullCase() throws InterruptedException { - - final String modelEndpoint = "/aai/v[0-9]+/network/generic-vnfs/generic-vnf/" + UUID_REGEX; - - wireMockServer.stubFor(get(urlMatching(modelEndpoint)).willReturn(ok()) - .willReturn(okJson("{\"orchestration-status\": \"Created\"}"))); - - - final ProcessInstance processInstance = executeWorkflow(MONITOR_SOL003_ADAPTER_CREATE_NODE_STATUS_WORKFLOW, - RANDOM_JOB_ID, getVariables(RANDOM_JOB_ID, RANDOWM_GENERIC_VNF_ID)); - - assertTrue(waitForProcessInstanceToFinish(processInstance.getProcessInstanceId())); - - final HistoricProcessInstance historicProcessInstance = - getHistoricProcessInstance(processInstance.getProcessInstanceId()); - assertNotNull(historicProcessInstance); - - assertEquals(HistoricProcessInstance.STATE_COMPLETED, historicProcessInstance.getState()); - - final HistoricVariableInstance nsResponseVariable = getVariable(processInstance.getProcessInstanceId(), - MonitorInstantiateSol003AdapterNodeTask.CREATE_VNF_NODE_STATUS); - - assertNotNull(nsResponseVariable); - assertTrue((boolean) nsResponseVariable.getValue()); - - } - - private Map<String, Object> getVariables(final String jobId, final String vnfId) { - final Map<String, Object> variables = new HashMap<>(); - variables.put(CamundaVariableNameConstants.JOB_ID_PARAM_NAME, jobId); - variables.put(CamundaVariableNameConstants.NF_INST_ID_PARAM_NAME, vnfId); - - return variables; - } - - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/MonitorSol003AdapterCreateJobTaskTest.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/MonitorSol003AdapterCreateJobTaskTest.java deleted file mode 100644 index aa8d8cf10e..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/MonitorSol003AdapterCreateJobTaskTest.java +++ /dev/null @@ -1,156 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.workflow.engine.tasks; - -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertNull; -import static org.junit.Assert.assertTrue; -import static org.onap.so.adapters.etsisol003adapter.lcm.v1.model.OperationStateEnum.COMPLETED; -import static org.onap.so.adapters.etsisol003adapter.lcm.v1.model.OperationStatusRetrievalStatusEnum.STATUS_FOUND; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.vnfm.Sol003AdapterConfiguration.SOL003_ADAPTER_REST_TEMPLATE_BEAN; -import static org.springframework.test.web.client.match.MockRestRequestMatchers.method; -import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo; -import static org.springframework.test.web.client.response.MockRestResponseCreators.withStatus; -import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess; -import java.util.HashMap; -import java.util.Map; -import org.camunda.bpm.engine.history.HistoricProcessInstance; -import org.camunda.bpm.engine.history.HistoricVariableInstance; -import org.camunda.bpm.engine.runtime.ProcessInstance; -import org.junit.Before; -import org.junit.Test; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.CreateVnfResponse; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.QueryJobResponse; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.BaseTest; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.GsonProvider; -import org.onap.so.etsi.nfvo.ns.lcm.model.InlineResponse400; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.converter.json.GsonHttpMessageConverter; -import org.springframework.test.web.client.MockRestServiceServer; -import org.springframework.web.client.RestTemplate; -import com.google.gson.Gson; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class MonitorSol003AdapterCreateJobTaskTest extends BaseTest { - - private static final String MONITOR_SOL003_ADAPTER_CREATE_JOB_WORKFLOW = "MonitorSol003AdapterCreateJob"; - - @Autowired - @Qualifier(SOL003_ADAPTER_REST_TEMPLATE_BEAN) - private RestTemplate restTemplate; - - @Autowired - private GsonProvider gsonProvider; - - private MockRestServiceServer mockRestServiceServer; - private Gson gson; - - @Before - public void before() { - wireMockServer.resetAll(); - final MockRestServiceServer.MockRestServiceServerBuilder builder = MockRestServiceServer.bindTo(restTemplate); - builder.ignoreExpectOrder(true); - mockRestServiceServer = builder.build(); - - gson = gsonProvider.getGson(); - restTemplate.getMessageConverters().add(new GsonHttpMessageConverter(gson)); - } - - - @Test - public void testMonitorSol003AdapterCreateJobTaskWorkflow_SuccessfullCase() throws InterruptedException { - - mockRestServiceServer.expect(requestTo(SOL003_ADAPTER_ENDPOINT_URL + "/jobs/" + RANDOM_JOB_ID)) - .andExpect(method(HttpMethod.GET)) - .andRespond(withSuccess(gson.toJson(getQueryJobResponse()), MediaType.APPLICATION_JSON)); - - final ProcessInstance processInstance = executeWorkflow(MONITOR_SOL003_ADAPTER_CREATE_JOB_WORKFLOW, - RANDOM_JOB_ID, getVariables(RANDOM_JOB_ID, new CreateVnfResponse().jobId(RANDOM_JOB_ID))); - - assertTrue(waitForProcessInstanceToFinish(processInstance.getProcessInstanceId())); - - final HistoricProcessInstance historicProcessInstance = - getHistoricProcessInstance(processInstance.getProcessInstanceId()); - assertNotNull(historicProcessInstance); - - assertEquals(HistoricProcessInstance.STATE_COMPLETED, historicProcessInstance.getState()); - - final HistoricVariableInstance nsResponseVariable = getVariable(processInstance.getProcessInstanceId(), - CamundaVariableNameConstants.OPERATION_STATUS_PARAM_NAME); - - assertNotNull(nsResponseVariable); - assertEquals(COMPLETED, nsResponseVariable.getValue()); - - } - - @Test - public void testMonitorSol003AdapterCreateJobTaskWorkflow_FailurelCase() throws InterruptedException { - - mockRestServiceServer.expect(requestTo(SOL003_ADAPTER_ENDPOINT_URL + "/jobs/" + RANDOM_JOB_ID)) - .andExpect(method(HttpMethod.GET)).andRespond(withStatus(HttpStatus.NOT_FOUND)); - - final ProcessInstance processInstance = executeWorkflow(MONITOR_SOL003_ADAPTER_CREATE_JOB_WORKFLOW, - RANDOM_JOB_ID, getVariables(RANDOM_JOB_ID, new CreateVnfResponse().jobId(RANDOM_JOB_ID))); - - assertTrue(waitForProcessInstanceToFinish(processInstance.getProcessInstanceId())); - - final HistoricProcessInstance historicProcessInstance = - getHistoricProcessInstance(processInstance.getProcessInstanceId()); - assertNotNull(historicProcessInstance); - - assertEquals(HistoricProcessInstance.STATE_COMPLETED, historicProcessInstance.getState()); - - final HistoricVariableInstance nsResponseVariable = getVariable(processInstance.getProcessInstanceId(), - CamundaVariableNameConstants.OPERATION_STATUS_PARAM_NAME); - - assertNull(nsResponseVariable); - - final HistoricVariableInstance workflowExceptionVariable = getVariable(processInstance.getProcessInstanceId(), - CamundaVariableNameConstants.NS_WORKFLOW_PROCESSING_EXCEPTION_PARAM_NAME); - - final InlineResponse400 problemDetails = (InlineResponse400) workflowExceptionVariable.getValue(); - assertNotNull(problemDetails); - assertNotNull(problemDetails.getDetail()); - } - - - private QueryJobResponse getQueryJobResponse() { - return new QueryJobResponse().id(RANDOM_JOB_ID).operationState(COMPLETED) - .operationStatusRetrievalStatus(STATUS_FOUND); - } - - private Map<String, Object> getVariables(final String jobId, final CreateVnfResponse createVnfResponse) { - final Map<String, Object> variables = new HashMap<>(); - variables.put(CamundaVariableNameConstants.JOB_ID_PARAM_NAME, jobId); - variables.put(CamundaVariableNameConstants.CREATE_VNF_RESPONSE_PARAM_NAME, createVnfResponse); - - return variables; - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/MonitorSol003AdapterTerminateJobTaskTest.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/MonitorSol003AdapterTerminateJobTaskTest.java deleted file mode 100644 index 13fff6d32b..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/MonitorSol003AdapterTerminateJobTaskTest.java +++ /dev/null @@ -1,148 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.workflow.engine.tasks; - -import com.google.gson.Gson; -import org.camunda.bpm.engine.history.HistoricProcessInstance; -import org.camunda.bpm.engine.history.HistoricVariableInstance; -import org.camunda.bpm.engine.runtime.ProcessInstance; -import org.junit.Before; -import org.junit.Test; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.DeleteVnfResponse; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.OperationStateEnum; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.QueryJobResponse; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.BaseTest; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.CamundaVariableNameConstants; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.GsonProvider; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.http.HttpMethod; -import org.springframework.http.MediaType; -import org.springframework.http.converter.json.GsonHttpMessageConverter; -import org.springframework.test.web.client.MockRestServiceServer; -import org.springframework.web.client.RestTemplate; -import java.util.HashMap; -import java.util.Map; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertTrue; -import static org.onap.so.adapters.etsisol003adapter.lcm.v1.model.OperationStateEnum.COMPLETED; -import static org.onap.so.adapters.etsisol003adapter.lcm.v1.model.OperationStateEnum.PROCESSING; -import static org.onap.so.adapters.etsisol003adapter.lcm.v1.model.OperationStatusRetrievalStatusEnum.STATUS_FOUND; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.vnfm.Sol003AdapterConfiguration.SOL003_ADAPTER_REST_TEMPLATE_BEAN; -import static org.springframework.test.web.client.match.MockRestRequestMatchers.method; -import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo; -import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * @author Andrew Lamb (andrew.a.lamb@est.tech) - * - */ -public class MonitorSol003AdapterTerminateJobTaskTest extends BaseTest { - - private static final String MONITOR_SOL003_ADAPTER_TERMINATE_JOB_WORKFLOW = "MonitorSol003AdapterTerminateJob"; - - @Autowired - @Qualifier(SOL003_ADAPTER_REST_TEMPLATE_BEAN) - private RestTemplate restTemplate; - - @Autowired - private GsonProvider gsonProvider; - - private MockRestServiceServer mockRestServiceServer; - private Gson gson; - - @Before - public void before() { - wireMockServer.resetAll(); - - final MockRestServiceServer.MockRestServiceServerBuilder builder = MockRestServiceServer.bindTo(restTemplate); - builder.ignoreExpectOrder(true); - mockRestServiceServer = builder.build(); - - gson = gsonProvider.getGson(); - restTemplate.getMessageConverters().add(new GsonHttpMessageConverter(gson)); - } - - - @Test - public void testMonitorSol003AdapterTerminateJobTaskWorkflow_SuccessfulCase() throws InterruptedException { - mockRestServiceServer.expect(requestTo(SOL003_ADAPTER_ENDPOINT_URL + "/jobs/" + RANDOM_JOB_ID)) - .andExpect(method(HttpMethod.GET)) - .andRespond(withSuccess(gson.toJson(getQueryJobResponse(COMPLETED)), MediaType.APPLICATION_JSON)); - - final ProcessInstance processInstance = executeWorkflow(MONITOR_SOL003_ADAPTER_TERMINATE_JOB_WORKFLOW, - RANDOM_JOB_ID, getVariables(RANDOM_JOB_ID, new DeleteVnfResponse().jobId(RANDOM_JOB_ID))); - assertTrue(waitForProcessInstanceToFinish(processInstance.getProcessInstanceId())); - - final HistoricProcessInstance historicProcessInstance = - getHistoricProcessInstance(processInstance.getProcessInstanceId()); - assertNotNull(historicProcessInstance); - assertEquals(HistoricProcessInstance.STATE_COMPLETED, historicProcessInstance.getState()); - - final HistoricVariableInstance nsResponseVariable = getVariable(processInstance.getProcessInstanceId(), - CamundaVariableNameConstants.OPERATION_STATUS_PARAM_NAME); - assertNotNull(nsResponseVariable); - assertEquals(COMPLETED, nsResponseVariable.getValue()); - } - - @Test - public void testMonitorSol003AdapterTerminateJobTaskWorkflow_SuccessfulCaseFollowingProcessingDelay() - throws InterruptedException { - mockRestServiceServer.expect(requestTo(SOL003_ADAPTER_ENDPOINT_URL + "/jobs/" + RANDOM_JOB_ID)) - .andExpect(method(HttpMethod.GET)) - .andRespond(withSuccess(gson.toJson(getQueryJobResponse(PROCESSING)), MediaType.APPLICATION_JSON)); - mockRestServiceServer.expect(requestTo(SOL003_ADAPTER_ENDPOINT_URL + "/jobs/" + RANDOM_JOB_ID)) - .andExpect(method(HttpMethod.GET)) - .andRespond(withSuccess(gson.toJson(getQueryJobResponse(PROCESSING)), MediaType.APPLICATION_JSON)); - mockRestServiceServer.expect(requestTo(SOL003_ADAPTER_ENDPOINT_URL + "/jobs/" + RANDOM_JOB_ID)) - .andExpect(method(HttpMethod.GET)) - .andRespond(withSuccess(gson.toJson(getQueryJobResponse(COMPLETED)), MediaType.APPLICATION_JSON)); - - final ProcessInstance processInstance = executeWorkflow(MONITOR_SOL003_ADAPTER_TERMINATE_JOB_WORKFLOW, - RANDOM_JOB_ID, getVariables(RANDOM_JOB_ID, new DeleteVnfResponse().jobId(RANDOM_JOB_ID))); - assertTrue(waitForProcessInstanceToFinish(processInstance.getProcessInstanceId())); - - final HistoricProcessInstance historicProcessInstance = - getHistoricProcessInstance(processInstance.getProcessInstanceId()); - assertNotNull(historicProcessInstance); - assertEquals(HistoricProcessInstance.STATE_COMPLETED, historicProcessInstance.getState()); - - final HistoricVariableInstance nsResponseVariable = getVariable(processInstance.getProcessInstanceId(), - CamundaVariableNameConstants.OPERATION_STATUS_PARAM_NAME); - assertNotNull(nsResponseVariable); - assertEquals(COMPLETED, nsResponseVariable.getValue()); - } - - private QueryJobResponse getQueryJobResponse(final OperationStateEnum operationState) { - return new QueryJobResponse().id(RANDOM_JOB_ID).operationState(operationState) - .operationStatusRetrievalStatus(STATUS_FOUND); - } - - private Map<String, Object> getVariables(final String jobId, final DeleteVnfResponse deleteVnfResponse) { - final Map<String, Object> variables = new HashMap<>(); - variables.put(CamundaVariableNameConstants.JOB_ID_PARAM_NAME, jobId); - variables.put(CamundaVariableNameConstants.DELETE_VNF_RESPONSE_PARAM_NAME, deleteVnfResponse); - - return variables; - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/TerminateNsTaskTest.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/TerminateNsTaskTest.java deleted file mode 100644 index 51460ec4c8..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/java/org/onap/so/etsi/nfvo/ns/workflow/engine/tasks/TerminateNsTaskTest.java +++ /dev/null @@ -1,218 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.workflow.engine.tasks; - -import static com.github.tomakehurst.wiremock.client.WireMock.delete; -import static com.github.tomakehurst.wiremock.client.WireMock.get; -import static com.github.tomakehurst.wiremock.client.WireMock.ok; -import static com.github.tomakehurst.wiremock.client.WireMock.okJson; -import static com.github.tomakehurst.wiremock.client.WireMock.urlMatching; -import static org.assertj.core.api.Assertions.assertThat; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertTrue; -import static org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.extclients.vnfm.Sol003AdapterConfiguration.SOL003_ADAPTER_REST_TEMPLATE_BEAN; -import static org.springframework.test.web.client.ExpectedCount.times; -import static org.springframework.test.web.client.match.MockRestRequestMatchers.method; -import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo; -import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess; -import java.io.IOException; -import java.time.LocalDateTime; -import java.util.List; -import java.util.Optional; -import java.util.UUID; -import org.camunda.bpm.engine.history.HistoricProcessInstance; -import org.hamcrest.text.MatchesPattern; -import org.junit.After; -import org.junit.Before; -import org.junit.Rule; -import org.junit.Test; -import org.junit.rules.ExpectedException; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.DeleteVnfResponse; -import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.OperationStatusRetrievalStatusEnum; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.BaseTest; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.GsonProvider; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.exceptions.NsRequestProcessingException; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.service.JobExecutorService; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJob; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNfInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NsLcmOpOcc; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.OperationStateEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.onap.so.etsi.nfvo.ns.lcm.model.TerminateNsRequest; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.http.HttpMethod; -import org.springframework.http.MediaType; -import org.springframework.http.converter.json.GsonHttpMessageConverter; -import org.springframework.test.web.client.MockRestServiceServer; -import org.springframework.web.client.RestTemplate; -import com.google.gson.Gson; - -/** - * @author Andrew Lamb (andrew.a.lamb@est.tech) - * - */ -public class TerminateNsTaskTest extends BaseTest { - - @Autowired - @Qualifier(SOL003_ADAPTER_REST_TEMPLATE_BEAN) - private RestTemplate sol003AdapterRestTemplate; - - private MockRestServiceServer mockSol003AdapterRestServiceServer; - - @Autowired - private JobExecutorService objUnderTest; - - @Autowired - private GsonProvider gsonProvider; - - @Rule - public ExpectedException expectedException = ExpectedException.none(); - - private Gson gson; - - @Before - public void before() { - wireMockServer.resetAll(); - gson = gsonProvider.getGson(); - mockSol003AdapterRestServiceServer = - MockRestServiceServer.bindTo(sol003AdapterRestTemplate).ignoreExpectOrder(true).build(); - sol003AdapterRestTemplate.getMessageConverters().add(new GsonHttpMessageConverter(gson)); - } - - @After - public void after() { - wireMockServer.resetAll(); - } - - @Test - public void testRunTerminateNsJob_timeSetInTerminateRequest_throwsNsRequestProcessingException() { - final String nsInstanceId = UUID.randomUUID().toString(); - final TerminateNsRequest terminateNsRequest = new TerminateNsRequest().terminationTime(LocalDateTime.now()); - final String message = "TerminateNsRequest received with terminateTime: " - + terminateNsRequest.getTerminationTime() - + "\nOnly immediate Terminate requests are currently supported \n(i.e., terminateTime field must not be set)."; - expectedException.expect(NsRequestProcessingException.class); - expectedException.expectMessage(message); - objUnderTest.runTerminateNsJob(nsInstanceId, terminateNsRequest); - } - - @Test - public void testRunTerminateNsJob_NsInstNotInDb_throwsNsRequestProcessingException() { - final String nsInstanceId = UUID.randomUUID().toString(); - final TerminateNsRequest terminateNsRequest = new TerminateNsRequest(); - final String message = "No matching NS Instance for id: " + nsInstanceId + " found in database."; - assertThat(databaseServiceProvider.getNfvoNsInst(nsInstanceId)).isEmpty(); - expectedException.expect(NsRequestProcessingException.class); - expectedException.expectMessage(message); - objUnderTest.runTerminateNsJob(nsInstanceId, terminateNsRequest); - } - - @Test - public void testTerminateNsTask_SuccessfulCase() throws InterruptedException, IOException { - final String nsInstanceId = UUID.randomUUID().toString(); - addDummyNsToDatabase(nsInstanceId); - mockSol003AdapterEndpoints(); - mockAAIEndpoints(); - - final String nsLcmOpOccId = objUnderTest.runTerminateNsJob(nsInstanceId, new TerminateNsRequest()); - - final Optional<NfvoJob> optional = getJobByResourceId(nsInstanceId); - assertTrue(optional.isPresent()); - final NfvoJob nfvoJob = optional.get(); - - // Confirm Process finishes in STATE_COMPLETED - assertTrue(waitForProcessInstanceToFinish(nfvoJob.getProcessInstanceId())); - final HistoricProcessInstance historicProcessInstance = - getHistoricProcessInstance(nfvoJob.getProcessInstanceId()); - assertNotNull(historicProcessInstance); - assertEquals(HistoricProcessInstance.STATE_COMPLETED, historicProcessInstance.getState()); - - // Confirm NS Instance set to NOT_INSTANTIATED and related NF Instances Deleted - final Optional<NfvoNsInst> optionalNfvoNsInst = databaseServiceProvider.getNfvoNsInst(nsInstanceId); - assertTrue(optionalNfvoNsInst.isPresent()); - final NfvoNsInst nfvoNsInst = optionalNfvoNsInst.get(); - assertEquals(State.NOT_INSTANTIATED, nfvoNsInst.getStatus()); - final List<NfvoNfInst> nfvoNfInsts = databaseServiceProvider.getNfvoNfInstByNsInstId(nsInstanceId); - assertTrue(nfvoNfInsts.isEmpty()); - - // Confirm NS LCM OP OCC Job set to Completed - final Optional<NsLcmOpOcc> optionalNsLcmOpOcc = databaseServiceProvider.getNsLcmOpOcc(nsLcmOpOccId); - assertTrue(optionalNsLcmOpOcc.isPresent()); - final NsLcmOpOcc nsLcmOpOcc = optionalNsLcmOpOcc.get(); - assertEquals(OperationStateEnum.COMPLETED, nsLcmOpOcc.getOperationState()); - } - - private void addDummyNsToDatabase(final String nsInstanceId) { - final String nsPackageId = UUID.randomUUID().toString(); - final NfvoNsInst nfvoNsInst = - new NfvoNsInst().nsInstId(nsInstanceId).name("nsName").nsPackageId(nsPackageId).nsdId("nsdId") - .nsdInvariantId("nsdId").status(State.INSTANTIATED).statusUpdatedTime(LocalDateTime.now()); - databaseServiceProvider.saveNfvoNsInst(nfvoNsInst); - addDummyNfToDatabase(nfvoNsInst); - addDummyNfToDatabase(nfvoNsInst); - addDummyNfToDatabase(nfvoNsInst); - } - - private void addDummyNfToDatabase(final NfvoNsInst nfvoNsInst) { - final LocalDateTime localDateTime = LocalDateTime.now(); - final String nfPackageId = UUID.randomUUID().toString(); - final NfvoNfInst nfvoNfInst = - new NfvoNfInst().status(State.INSTANTIATED).createTime(localDateTime).lastUpdateTime(localDateTime) - .name("nfName").vnfdId("vnfdId").packageId(nfPackageId).nfvoNsInst(nfvoNsInst); - databaseServiceProvider.saveNfvoNfInst(nfvoNfInst); - } - - private void mockSol003AdapterEndpoints() { - final int numTimes = 3; - - mockSol003AdapterRestServiceServer - .expect(times(numTimes), - requestTo(MatchesPattern.matchesPattern(SOL003_ADAPTER_ENDPOINT_URL + "/vnfs/.*"))) - .andExpect(method(HttpMethod.DELETE)) - .andRespond(withSuccess(gson.toJson(new DeleteVnfResponse().jobId(UUID.randomUUID().toString())), - MediaType.APPLICATION_JSON)); - - mockSol003AdapterRestServiceServer - .expect(times(numTimes), - requestTo(MatchesPattern.matchesPattern(SOL003_ADAPTER_ENDPOINT_URL + "/jobs/.*"))) - .andExpect(method(HttpMethod.GET)) - .andRespond(withSuccess(gson.toJson( - new org.onap.so.adapters.etsisol003adapter.lcm.v1.model.QueryJobResponse().operationState( - org.onap.so.adapters.etsisol003adapter.lcm.v1.model.OperationStateEnum.COMPLETED) - .operationStatusRetrievalStatus(OperationStatusRetrievalStatusEnum.STATUS_FOUND)), - MediaType.APPLICATION_JSON)); - } - - private void mockAAIEndpoints() { - final String modelEndpoint = "/aai/v[0-9]+/network/generic-vnfs/generic-vnf/" + UUID_REGEX; - final String resourceVersion = "12345"; - - final String body = - "{\"resource-version\": \"" + resourceVersion + "\",\n\"orchestration-status\": \"Assigned\"}"; - wireMockServer.stubFor(get(urlMatching(modelEndpoint)).willReturn(ok()).willReturn(okJson(body))); - - wireMockServer.stubFor( - delete(urlMatching(modelEndpoint + "\\?resource-version=" + resourceVersion)).willReturn(ok())); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/resources/application.yaml b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/resources/application.yaml deleted file mode 100644 index 5a8e250157..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/resources/application.yaml +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright © 2020 Nordix Foundation -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -spring: - main: - allow-bean-definition-overriding: true - datasource: - hikari: - camunda: - jdbcUrl: jdbc:h2:mem:example-simple;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE - driver-class-name: org.h2.Driver - pool-name: ns-lcm-bpmn-pool - registerMbeans: true - nfvo: - jdbcUrl: jdbc:h2:mem:nfvo;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE;INIT=CREATE SCHEMA IF NOT EXISTS nfvo;MODE=MYSQL;DATABASE_TO_LOWER=TRUE;CASE_INSENSITIVE_IDENTIFIERS=TRUE - driver-class-name: org.h2.Driver - pool-name: ns-lcm-bpmn-pool - registerMbeans: true - test: - database: - replace: NONE - jpa: - generate-ddl: true - dialect: org.hibernate.dialect.MySQL5Dialect - hibernate: - ddl-auto: create - database-platform: org.hibernate.dialect.MariaDBDialect -hibernate: - dialect: org.hibernate.dialect.H2Dialect - hbm2ddl: - auto: create -aai: - version: v19 - endpoint: http://localhost:${wiremock.server.port} -etsi-catalog-manager: - base: - endpoint: http://modeling-etsicatalog.onap:8806/api -so-etsi-ns-lcm-workflow-engine: - requesttimeout: - timeoutInSeconds: 120 - -logging: - level: - org.reflections.Reflections: ERROR
\ No newline at end of file diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/resources/invalid_ns.csar b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/resources/invalid_ns.csar Binary files differdeleted file mode 100644 index 63bad965b7..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/resources/invalid_ns.csar +++ /dev/null diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/resources/ns.csar b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/resources/ns.csar Binary files differdeleted file mode 100644 index eb19c762ae..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-bpmn-flows/src/test/resources/ns.csar +++ /dev/null diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/pom.xml b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/pom.xml deleted file mode 100644 index ec62b8194a..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/pom.xml +++ /dev/null @@ -1,47 +0,0 @@ -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> - <modelVersion>4.0.0</modelVersion> - <parent> - <groupId>org.onap.so.etsi.nfvo</groupId> - <artifactId>so-etsi-nfvo-ns-lcm</artifactId> - <version>1.8.0-SNAPSHOT</version> - </parent> - <artifactId>so-etsi-nfvo-ns-lcm-database-service</artifactId> - <name>SO ETSI NFVO NS LCM Database Service</name> - <dependencies> - <dependency> - <groupId>org.springframework.boot</groupId> - <artifactId>spring-boot-starter-data-jpa</artifactId> - </dependency> - <dependency> - <groupId>org.mariadb.jdbc</groupId> - <artifactId>mariadb-java-client</artifactId> - </dependency> - <dependency> - <groupId>org.flywaydb</groupId> - <artifactId>flyway-core</artifactId> - </dependency> - <dependency> - <groupId>com.h2database</groupId> - <artifactId>h2</artifactId> - <scope>test</scope> - </dependency> - <dependency> - <groupId>org.springframework.boot</groupId> - <artifactId>spring-boot-starter-test</artifactId> - <scope>test</scope> - </dependency> - <dependency> - <groupId>nl.jqno.equalsverifier</groupId> - <artifactId>equalsverifier</artifactId> - <version>${equalsverifier-version}</version> - <scope>test</scope> - </dependency> - <dependency> - <groupId>org.onap.so</groupId> - <artifactId>common</artifactId> - <version>${project.version}</version> - <scope>test</scope> - </dependency> - </dependencies> -</project>
\ No newline at end of file diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/CancelModeType.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/CancelModeType.java deleted file mode 100644 index 627250535e..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/CancelModeType.java +++ /dev/null @@ -1,28 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.beans; - -/** - * @author Andrew Lamb (andrew.a.lamb@est.tech) - * - */ -public enum CancelModeType { - GRACEFUL, FORCEFUL; -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/JobAction.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/JobAction.java deleted file mode 100644 index 8a22689f8a..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/JobAction.java +++ /dev/null @@ -1,29 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.beans; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public enum JobAction { - CREATE, INSTANTIATE, TERMINATE, DELETE; - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/JobStatusEnum.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/JobStatusEnum.java deleted file mode 100644 index c67a3cc692..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/JobStatusEnum.java +++ /dev/null @@ -1,29 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.beans; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public enum JobStatusEnum { - STARTING, STARTED, IN_PROGRESS, ERROR, FINISHED, FINISHED_WITH_ERROR; - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NfvoJob.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NfvoJob.java deleted file mode 100644 index 60b06e1061..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NfvoJob.java +++ /dev/null @@ -1,277 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.beans; - -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.utils.Utils.toIndentedString; -import java.time.LocalDateTime; -import java.util.ArrayList; -import java.util.List; -import java.util.Objects; -import java.util.UUID; -import javax.persistence.CascadeType; -import javax.persistence.Column; -import javax.persistence.Entity; -import javax.persistence.EnumType; -import javax.persistence.Enumerated; -import javax.persistence.FetchType; -import javax.persistence.Id; -import javax.persistence.OneToMany; -import javax.persistence.Table; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.utils.Utils; - - -@Entity -@Table(name = "JOB") -public class NfvoJob { - - @Id - @Column(name = "JOB_ID", nullable = false) - private String jobId; - - @Column(name = "JOB_TYPE", nullable = false) - private String jobType; - - @Enumerated(EnumType.STRING) - @Column(name = "JOB_ACTION", nullable = false) - private JobAction jobAction; - - @Column(name = "RESOURCE_ID", nullable = false) - private String resourceId; - - @Column(name = "RESOURCE_NAME") - private String resourceName; - - @Enumerated(EnumType.STRING) - @Column(name = "STATUS", nullable = false) - private JobStatusEnum status; - - @Column(name = "START_TIME") - private LocalDateTime startTime; - - @Column(name = "END_TIME") - private LocalDateTime endTime; - - @Column(name = "PROGRESS") - private int progress; - - @Column(name = "PROCESS_INSTANCE_ID") - private String processInstanceId; - - @OneToMany(mappedBy = "nfvoJob", cascade = CascadeType.ALL, fetch = FetchType.EAGER) - private List<NfvoJobStatus> nfvoJobStatuses = new ArrayList<>(); - - public NfvoJob() { - this.jobId = UUID.randomUUID().toString(); - } - - public void setJobId(final String jobId) { - this.jobId = jobId; - } - - public String getJobId() { - return jobId; - } - - public NfvoJob jobId(final String jobId) { - this.jobId = jobId; - return this; - } - - public String getJobType() { - return jobType; - } - - public void setJobType(final String jobType) { - this.jobType = jobType; - } - - public NfvoJob jobType(final String jobType) { - this.jobType = jobType; - return this; - } - - public JobAction getJobAction() { - return jobAction; - } - - public void setJobAction(final JobAction jobAction) { - this.jobAction = jobAction; - } - - public NfvoJob jobAction(final JobAction jobAction) { - this.jobAction = jobAction; - return this; - } - - public String getResourceId() { - return resourceId; - } - - public void setResourceId(final String resourceId) { - this.resourceId = resourceId; - } - - public NfvoJob resourceId(final String resourceId) { - this.resourceId = resourceId; - return this; - } - - public JobStatusEnum getStatus() { - return status; - } - - public void setStatus(final JobStatusEnum status) { - this.status = status; - } - - public NfvoJob status(final JobStatusEnum status) { - this.status = status; - return this; - } - - public LocalDateTime getStartTime() { - return startTime; - } - - public void setStartTime(final LocalDateTime startTime) { - this.startTime = startTime; - } - - public NfvoJob startTime(final LocalDateTime startTime) { - this.startTime = startTime; - return this; - } - - public LocalDateTime getEndTime() { - return endTime; - } - - public void setEndTime(final LocalDateTime endTime) { - this.endTime = endTime; - } - - public NfvoJob endTime(final LocalDateTime endTime) { - this.endTime = endTime; - return this; - } - - public int getProgress() { - return progress; - } - - public void setProgress(final int progress) { - this.progress = progress; - } - - public NfvoJob progress(final int progress) { - this.progress = progress; - return this; - } - - public String getProcessInstanceId() { - return processInstanceId; - } - - public void setProcessInstanceId(final String processInstanceId) { - this.processInstanceId = processInstanceId; - } - - public NfvoJob processInstanceId(final String processInstanceId) { - this.processInstanceId = processInstanceId; - return this; - } - - public String getResourceName() { - return resourceName; - } - - public void setResourceName(final String resourceName) { - this.resourceName = resourceName; - } - - public NfvoJob resourceName(final String resourceName) { - this.resourceName = resourceName; - return this; - } - - public List<NfvoJobStatus> getNfvoJobStatuses() { - return nfvoJobStatuses; - } - - public void setJobStatuses(final List<NfvoJobStatus> nfvoJobStatuses) { - this.nfvoJobStatuses = nfvoJobStatuses; - } - - public NfvoJob nfvoJobStatuses(final List<NfvoJobStatus> nfvoJobStatuses) { - this.nfvoJobStatuses = nfvoJobStatuses; - return this; - } - - public NfvoJob nfvoJobStatus(final NfvoJobStatus nfvoJobStatus) { - nfvoJobStatus.setNfvoJob(this); - this.nfvoJobStatuses.add(nfvoJobStatus); - return this; - } - - @Override - public int hashCode() { - return Objects.hash(jobId, processInstanceId, jobType, jobAction, startTime, endTime, status, progress, - resourceId, resourceName, nfvoJobStatuses); - } - - @Override - public boolean equals(final Object obj) { - if (this == obj) - return true; - if (obj == null || getClass() != obj.getClass()) - return false; - if (obj instanceof NfvoJob) { - final NfvoJob other = (NfvoJob) obj; - return Objects.equals(jobId, other.jobId) && Objects.equals(processInstanceId, other.processInstanceId) - && Objects.equals(jobType, other.jobType) && Objects.equals(jobAction, other.jobAction) - && Objects.equals(progress, other.progress) && Objects.equals(status, other.status) - && Objects.equals(startTime, other.startTime) && Objects.equals(endTime, other.endTime) - && Objects.equals(resourceId, other.resourceId) && Objects.equals(resourceName, other.resourceName) - && Utils.isEquals(nfvoJobStatuses, other.nfvoJobStatuses); - } - return false; - } - - @Override - public String toString() { - final StringBuilder sb = new StringBuilder(); - sb.append("class NfvoJob {\n"); - sb.append(" jobId: ").append(toIndentedString(jobId)).append("\n"); - sb.append(" processInstanceId: ").append(toIndentedString(processInstanceId)).append("\n"); - sb.append(" jobType: ").append(toIndentedString(jobType)).append("\n"); - sb.append(" jobAction: ").append(toIndentedString(jobAction)).append("\n"); - sb.append(" progress: ").append(toIndentedString(progress)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" startTime: ").append(toIndentedString(startTime)).append("\n"); - sb.append(" endTime: ").append(toIndentedString(endTime)).append("\n"); - sb.append(" resId: ").append(toIndentedString(resourceId)).append("\n"); - sb.append(" resName: ").append(toIndentedString(resourceName)).append("\n"); - sb.append(" nfvoJobStatuses: ").append(toIndentedString(nfvoJobStatuses)).append("\n"); - - sb.append("}"); - return sb.toString(); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NfvoJobStatus.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NfvoJobStatus.java deleted file mode 100644 index 66ae0e503c..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NfvoJobStatus.java +++ /dev/null @@ -1,151 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.beans; - -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.utils.Utils.toIndentedString; -import java.time.LocalDateTime; -import java.util.Objects; -import javax.persistence.Column; -import javax.persistence.Entity; -import javax.persistence.EnumType; -import javax.persistence.Enumerated; -import javax.persistence.FetchType; -import javax.persistence.GeneratedValue; -import javax.persistence.GenerationType; -import javax.persistence.Id; -import javax.persistence.JoinColumn; -import javax.persistence.ManyToOne; -import javax.persistence.Table; - -@Entity -@Table(name = "JOB_STATUS") -public class NfvoJobStatus { - - @Id - @GeneratedValue(strategy = GenerationType.IDENTITY) - @Column(name = "ID") - private int id; - - @Enumerated(EnumType.STRING) - @Column(name = "STATUS", nullable = false) - private JobStatusEnum status; - - @Column(name = "DESCRIPTION", columnDefinition = "LONGTEXT") - private String description; - - @Column(name = "UPDATED_TIME", nullable = false) - private LocalDateTime updatedTime; - - @ManyToOne(fetch = FetchType.LAZY) - @JoinColumn(name = "JOB_ID", nullable = false) - private NfvoJob nfvoJob; - - public int getId() { - return id; - } - - public JobStatusEnum getStatus() { - return status; - } - - public void setStatus(final JobStatusEnum status) { - this.status = status; - } - - public NfvoJobStatus status(final JobStatusEnum status) { - this.status = status; - return this; - } - - public String getDescription() { - return description; - } - - public void setDescription(final String description) { - this.description = description; - } - - public NfvoJobStatus description(final String description) { - this.description = description; - return this; - } - - public LocalDateTime getUpdatedTime() { - return updatedTime; - } - - public void setUpdatedTime(final LocalDateTime updatedTime) { - this.updatedTime = updatedTime; - } - - public NfvoJobStatus updatedTime(final LocalDateTime addTime) { - this.updatedTime = addTime; - return this; - } - - public NfvoJob getNfvoJob() { - return nfvoJob; - } - - public void setNfvoJob(final NfvoJob nfvoJob) { - this.nfvoJob = nfvoJob; - } - - public NfvoJobStatus nfvoJob(final NfvoJob nfvoJob) { - this.nfvoJob = nfvoJob; - return this; - } - - - @Override - public int hashCode() { - return Objects.hash(id, status, updatedTime, description, nfvoJob != null ? nfvoJob.getJobId() : 0); - } - - @Override - public boolean equals(final Object obj) { - if (this == obj) - return true; - if (obj == null || getClass() != obj.getClass()) - return false; - if (obj instanceof NfvoJobStatus) { - final NfvoJobStatus other = (NfvoJobStatus) obj; - return Objects.equals(id, other.id) && Objects.equals(status, other.status) - && Objects.equals(updatedTime, other.updatedTime) && Objects.equals(description, other.description) - && (nfvoJob == null ? other.nfvoJob == null - : other.nfvoJob != null && Objects.equals(nfvoJob.getJobId(), other.nfvoJob.getJobId())); - } - return false; - } - - @Override - public String toString() { - final StringBuilder sb = new StringBuilder(); - sb.append("class NfvoJobStatus {\n"); - sb.append(" Id: ").append(toIndentedString(id)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" descp: ").append(toIndentedString(description)).append("\n"); - sb.append(" updatedTime: ").append(toIndentedString(updatedTime)).append("\n"); - sb.append(" jobId: ").append(nfvoJob != null ? toIndentedString(nfvoJob.getJobId()) : "").append("\n"); - sb.append("}"); - return sb.toString(); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NfvoNfInst.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NfvoNfInst.java deleted file mode 100644 index 570355fb37..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NfvoNfInst.java +++ /dev/null @@ -1,215 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.beans; - -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.utils.Utils.toIndentedString; -import java.time.LocalDateTime; -import java.util.Objects; -import java.util.UUID; -import javax.persistence.Column; -import javax.persistence.Entity; -import javax.persistence.EnumType; -import javax.persistence.Enumerated; -import javax.persistence.FetchType; -import javax.persistence.Id; -import javax.persistence.JoinColumn; -import javax.persistence.ManyToOne; -import javax.persistence.Table; - -/** - * @author mukeshsharma (mukeshsharma@est.tech) - */ -@Entity -@Table(name = "NF_INST") -public class NfvoNfInst { - - @Id - @Column(name = "NF_INST_ID", nullable = false) - private String nfInstId; - - @Column(name = "NAME") - private String name; - - @Column(name = "VNFD_ID") - private String vnfdId; - - @Column(name = "PACKAGE_ID") - private String packageId; - - @ManyToOne(fetch = FetchType.LAZY) - @JoinColumn(name = "NS_INST_ID", nullable = false) - private NfvoNsInst nsInst; - - @Enumerated(EnumType.STRING) - @Column(name = "STATUS", nullable = false) - private State status; - - @Column(name = "CREATE_TIME") - private LocalDateTime createTime; - - @Column(name = "LAST_UPDATE_TIME") - private LocalDateTime lastUpdateTime; - - public NfvoNfInst() { - this.nfInstId = UUID.randomUUID().toString(); - } - - public String getNfInstId() { - return nfInstId; - } - - public void setNfInstId(final String nfInstId) { - this.nfInstId = nfInstId; - } - - public NfvoNfInst nfInstId(final String nfInstId) { - this.nfInstId = nfInstId; - return this; - } - - public String getName() { - return name; - } - - public void setName(final String name) { - this.name = name; - } - - public NfvoNfInst name(final String name) { - this.name = name; - return this; - } - - public String getVnfdId() { - return vnfdId; - } - - public void setVnfdId(final String vnfdId) { - this.vnfdId = vnfdId; - } - - public NfvoNfInst vnfdId(final String vnfdId) { - this.vnfdId = vnfdId; - return this; - } - - public String getPackageId() { - return packageId; - } - - public void setPackageId(final String packageId) { - this.packageId = packageId; - } - - public NfvoNfInst packageId(final String packageId) { - this.packageId = packageId; - return this; - } - - public NfvoNsInst getNsInst() { - return nsInst; - } - - public void setNsInst(final NfvoNsInst nsInst) { - this.nsInst = nsInst; - } - - public NfvoNfInst nfvoNsInst(final NfvoNsInst nfvoNsInst) { - this.nsInst = nfvoNsInst; - return this; - } - - public State getStatus() { - return status; - } - - public void setStatus(final State status) { - this.status = status; - } - - public NfvoNfInst status(final State status) { - this.status = status; - return this; - } - - public LocalDateTime getCreateTime() { - return createTime; - } - - public void setCreateTime(final LocalDateTime createTime) { - this.createTime = createTime; - } - - public NfvoNfInst createTime(final LocalDateTime createTime) { - this.createTime = createTime; - return this; - } - - public LocalDateTime getLastUpdateTime() { - return lastUpdateTime; - } - - public void setLastUpdateTime(final LocalDateTime lastUpdateTime) { - this.lastUpdateTime = lastUpdateTime; - } - - public NfvoNfInst lastUpdateTime(final LocalDateTime lastUpdateTime) { - this.lastUpdateTime = lastUpdateTime; - return this; - } - - @Override - public boolean equals(final Object object) { - if (this == object) - return true; - if (object == null || getClass() != object.getClass()) - return false; - final NfvoNfInst that = (NfvoNfInst) object; - return Objects.equals(nfInstId, that.nfInstId) && Objects.equals(name, that.name) - && Objects.equals(vnfdId, that.vnfdId) && Objects.equals(packageId, that.packageId) - && (nsInst == null ? that.nsInst == null : that.nsInst != null && Objects.equals(nsInst, that.nsInst)) - && Objects.equals(status, that.status) && Objects.equals(createTime, that.createTime) - && Objects.equals(lastUpdateTime, that.lastUpdateTime); - } - - @Override - public int hashCode() { - return Objects.hash(nfInstId, name, vnfdId, packageId, nsInst != null ? nsInst.getNsInstId() : 0, status, - createTime, lastUpdateTime); - } - - @Override - public String toString() { - final StringBuilder sb = new StringBuilder(); - sb.append("class NfvoNfInst {\n"); - sb.append(" nfInstId: ").append(toIndentedString(nfInstId)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" vnfdId: ").append(toIndentedString(vnfdId)).append("\n"); - sb.append(" packageId: ").append(toIndentedString(packageId)).append("\n"); - sb.append(" nsInst: ").append(nsInst != null ? toIndentedString(nsInst.getNsInstId()) : null).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" createTime: ").append(toIndentedString(createTime)).append("\n"); - sb.append(" lastUpdateTime: ").append(toIndentedString(lastUpdateTime)).append("\n"); - - sb.append("}"); - return sb.toString(); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NfvoNsInst.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NfvoNsInst.java deleted file mode 100644 index 04f988c2fc..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NfvoNsInst.java +++ /dev/null @@ -1,293 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.beans; - -import javax.persistence.CascadeType; -import javax.persistence.Column; -import javax.persistence.Entity; -import javax.persistence.EnumType; -import javax.persistence.Enumerated; -import javax.persistence.FetchType; -import javax.persistence.Id; -import javax.persistence.OneToMany; -import javax.persistence.Table; -import java.time.LocalDateTime; -import java.util.ArrayList; -import java.util.List; -import java.util.Objects; -import java.util.UUID; -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.utils.Utils.toIndentedString; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Entity -@Table(name = "NS_INST") -public class NfvoNsInst { - - @Id - @Column(name = "NS_INST_ID", nullable = false) - private String nsInstId; - - @Column(name = "NAME", nullable = false) - private String name; - - @Column(name = "NS_PACKAGE_ID") - private String nsPackageId; - - @Column(name = "NSD_ID", nullable = false) - private String nsdId; - - @Column(name = "NSD_INVARIANT_ID", nullable = false) - private String nsdInvariantId; - - @Column(name = "DESCRIPTION", columnDefinition = "LONGTEXT") - private String description; - - @Enumerated(EnumType.STRING) - @Column(name = "STATUS", nullable = false) - private State status; - - @Column(name = "STATUS_UPDATED_TIME", nullable = false) - private LocalDateTime statusUpdatedTime; - - @Column(name = "GLOBAL_CUSTOMER_ID") - private String globalCustomerId; - - @Column(name = "SERVICE_TYPE") - private String serviceType; - - @OneToMany(mappedBy = "nsInst", cascade = CascadeType.ALL, fetch = FetchType.LAZY) - private List<NfvoNfInst> nfvoNfInsts = new ArrayList<>(); - - @OneToMany(mappedBy = "nfvoNsInst", cascade = CascadeType.ALL, fetch = FetchType.LAZY) - private List<NsLcmOpOcc> nsLcmOpOccs = new ArrayList<>(); - - public NfvoNsInst() { - this.nsInstId = UUID.randomUUID().toString(); - } - - public String getNsInstId() { - return nsInstId; - } - - public void setNsInstId(final String nsInstId) { - this.nsInstId = nsInstId; - } - - public NfvoNsInst nsInstId(final String nsInstId) { - this.nsInstId = nsInstId; - return this; - } - - public String getName() { - return name; - } - - public void setName(final String name) { - this.name = name; - } - - public NfvoNsInst name(final String name) { - this.name = name; - return this; - } - - public String getNsPackageId() { - return nsPackageId; - } - - public void setNsPackageId(final String nsPackageId) { - this.nsPackageId = nsPackageId; - } - - public NfvoNsInst nsPackageId(final String nsPackageId) { - this.nsPackageId = nsPackageId; - return this; - } - - public String getNsdId() { - return nsdId; - } - - public void setNsdId(final String nsdId) { - this.nsdId = nsdId; - } - - public NfvoNsInst nsdId(final String nsdId) { - this.nsdId = nsdId; - return this; - } - - public String getNsdInvariantId() { - return nsdInvariantId; - } - - public void setNsdInvariantId(final String nsdInvariantId) { - this.nsdInvariantId = nsdInvariantId; - } - - public NfvoNsInst nsdInvariantId(final String nsdInvariantId) { - this.nsdInvariantId = nsdInvariantId; - return this; - } - - public String getDescription() { - return description; - } - - public void setDescription(final String description) { - this.description = description; - } - - public NfvoNsInst description(final String description) { - this.description = description; - return this; - } - - public State getStatus() { - return status; - } - - public void setStatus(final State status) { - this.status = status; - } - - public NfvoNsInst status(final State status) { - this.status = status; - return this; - } - - public LocalDateTime getStatusUpdatedTime() { - return statusUpdatedTime; - } - - public void setStatusUpdatedTime(final LocalDateTime statusUpdatedTime) { - this.statusUpdatedTime = statusUpdatedTime; - } - - public NfvoNsInst statusUpdatedTime(final LocalDateTime statusUpdatedTime) { - this.statusUpdatedTime = statusUpdatedTime; - return this; - } - - public String getGlobalCustomerId() { - return globalCustomerId; - } - - public void setGlobalCustomerId(final String globalCustomerId) { - this.globalCustomerId = globalCustomerId; - } - - public NfvoNsInst globalCustomerId(final String globalCustomerId) { - this.globalCustomerId = globalCustomerId; - return this; - } - - public String getServiceType() { - return serviceType; - } - - public void setServiceType(final String serviceType) { - this.serviceType = serviceType; - } - - public NfvoNsInst serviceType(final String serviceType) { - this.serviceType = serviceType; - return this; - } - - public List<NfvoNfInst> getNfvoNfInsts() { - return nfvoNfInsts; - } - - public void setNfvoNfInsts(final List<NfvoNfInst> nfvoNfInsts) { - this.nfvoNfInsts = nfvoNfInsts; - } - - public NfvoNsInst nfvoNfInsts(final NfvoNfInst nfvoNfInsts) { - nfvoNfInsts.nfvoNsInst(this); - this.nfvoNfInsts.add(nfvoNfInsts); - return this; - } - - public List<NsLcmOpOcc> getNsLcmOpOccs() { - return nsLcmOpOccs; - } - - public void setNsLcmOpOccs(final List<NsLcmOpOcc> nsLcmOpOccs) { - this.nsLcmOpOccs = nsLcmOpOccs; - } - - public NfvoNsInst nsLcmOpOccs(final NsLcmOpOcc nsLcmOpOcc) { - nsLcmOpOcc.nfvoNsInst(this); - this.nsLcmOpOccs.add(nsLcmOpOcc); - return this; - } - - @Override - public int hashCode() { - return Objects.hash(nsInstId, name, nsPackageId, nsdId, nsdInvariantId, description, status, statusUpdatedTime, - globalCustomerId, serviceType, nfvoNfInsts, nsLcmOpOccs); - } - - @Override - public boolean equals(final Object obj) { - if (this == obj) - return true; - if (obj == null || getClass() != obj.getClass()) - return false; - if (obj instanceof NfvoNsInst) { - final NfvoNsInst other = (NfvoNsInst) obj; - return Objects.equals(nsInstId, other.nsInstId) && Objects.equals(name, other.name) - && Objects.equals(nsPackageId, other.nsPackageId) && Objects.equals(nsdId, other.nsdId) - && Objects.equals(nsdInvariantId, other.nsdInvariantId) - && Objects.equals(description, other.description) && Objects.equals(status, other.status) - && Objects.equals(statusUpdatedTime, other.statusUpdatedTime) - && Objects.equals(globalCustomerId, other.globalCustomerId) - && Objects.equals(serviceType, other.serviceType) && Objects.equals(nfvoNfInsts, other.nfvoNfInsts) - && Objects.equals(nsLcmOpOccs, other.nsLcmOpOccs); - } - return false; - } - - @Override - public String toString() { - final StringBuilder sb = new StringBuilder(); - sb.append("class NfvoNsInst {\n"); - sb.append(" nsInstId: ").append(toIndentedString(nsInstId)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" nsPackageId: ").append(toIndentedString(nsPackageId)).append("\n"); - sb.append(" nsdId: ").append(toIndentedString(nsdId)).append("\n"); - sb.append(" nsdInvariantId: ").append(toIndentedString(nsdInvariantId)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" statusUpdatedTime: ").append(toIndentedString(statusUpdatedTime)).append("\n"); - sb.append(" globalCustomerId: ").append(toIndentedString(globalCustomerId)).append("\n"); - sb.append(" serviceType: ").append(toIndentedString(serviceType)).append("\n"); - sb.append(" nfvoNfInsts: ").append(toIndentedString(nfvoNfInsts)).append("\n"); - sb.append(" nsLcmOpOccs: ").append(toIndentedString(nsLcmOpOccs)).append("\n"); - - sb.append("}"); - return sb.toString(); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NsLcmOpOcc.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NsLcmOpOcc.java deleted file mode 100644 index 4846e5a361..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NsLcmOpOcc.java +++ /dev/null @@ -1,253 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.beans; - -import static org.onap.so.etsi.nfvo.ns.lcm.database.beans.utils.Utils.toIndentedString; -import java.time.LocalDateTime; -import java.util.Objects; -import java.util.UUID; -import javax.persistence.Column; -import javax.persistence.Entity; -import javax.persistence.EnumType; -import javax.persistence.Enumerated; -import javax.persistence.FetchType; -import javax.persistence.Id; -import javax.persistence.JoinColumn; -import javax.persistence.ManyToOne; -import javax.persistence.Table; - -/** - * @author mukeshsharma(mukeshsharma@est.tech) - */ -@Entity -@Table(name = "NS_LCM_OP_OCCS") -public class NsLcmOpOcc { - - @Id - @Column(name = "ID", nullable = false) - private String id; - - @Enumerated(EnumType.STRING) - @Column(name = "OPERATION_STATE", nullable = false) - private OperationStateEnum operationState; - - @Column(name = "STATE_ENTERED_TIME") - private LocalDateTime stateEnteredTime; - - @Column(name = "START_TIME") - private LocalDateTime startTime; - - @ManyToOne(fetch = FetchType.LAZY) - @JoinColumn(name = "NS_INST_ID", nullable = false) - private NfvoNsInst nfvoNsInst; - - @Enumerated(EnumType.STRING) - @Column(name = "OPERATION", nullable = false) - private NsLcmOpType operation; - - @Column(name = "IS_AUTO_INVOCATION", nullable = false) - private boolean isAutoInvocation; - - @Column(name = "OPERATION_PARAMS", columnDefinition = "LONGTEXT", nullable = false) - private String operationParams; - - @Column(name = "IS_CANCEL_PENDING", nullable = false) - private boolean isCancelPending; - - @Enumerated(EnumType.STRING) - @Column(name = "CANCEL_MODE") - private CancelModeType cancelMode; - - public NsLcmOpOcc() { - this.id = UUID.randomUUID().toString(); - } - - public String getId() { - return id; - } - - public void setId(final String id) { - this.id = id; - } - - public NsLcmOpOcc id(final String id) { - this.id = id; - return this; - } - - public OperationStateEnum getOperationState() { - return operationState; - } - - public void setOperationState(final OperationStateEnum operationState) { - this.operationState = operationState; - } - - public NsLcmOpOcc operationState(final OperationStateEnum operationState) { - this.operationState = operationState; - return this; - } - - public LocalDateTime getStateEnteredTime() { - return stateEnteredTime; - } - - public void setStateEnteredTime(final LocalDateTime stateEnteredTime) { - this.stateEnteredTime = stateEnteredTime; - } - - public NsLcmOpOcc stateEnteredTime(final LocalDateTime stateEnteredTime) { - this.stateEnteredTime = stateEnteredTime; - return this; - } - - public LocalDateTime getStartTime() { - return startTime; - } - - public void setStartTime(final LocalDateTime startTime) { - this.startTime = startTime; - } - - public NsLcmOpOcc startTime(final LocalDateTime startTime) { - this.startTime = startTime; - return this; - } - - public NfvoNsInst getNfvoNsInst() { - return nfvoNsInst; - } - - public void setNfvoNsInst(final NfvoNsInst nfvoNsInst) { - this.nfvoNsInst = nfvoNsInst; - } - - public NsLcmOpOcc nfvoNsInst(final NfvoNsInst nfvoNsInst) { - this.nfvoNsInst = nfvoNsInst; - return this; - } - - public NsLcmOpType getOperation() { - return operation; - } - - public void setOperation(final NsLcmOpType operation) { - this.operation = operation; - } - - public NsLcmOpOcc operation(final NsLcmOpType operation) { - this.operation = operation; - return this; - } - - public boolean getIsAutoInvocation() { - return isAutoInvocation; - } - - public void setIsAutoInvocation(final boolean isAutoInvocation) { - this.isAutoInvocation = isAutoInvocation; - } - - public NsLcmOpOcc isAutoInvocation(final boolean isAutoInvocation) { - this.isAutoInvocation = isAutoInvocation; - return this; - } - - public CancelModeType getCancelMode() { - return cancelMode; - } - - public void setCancelMode(final CancelModeType cancelMode) { - this.cancelMode = cancelMode; - } - - public NsLcmOpOcc cancelMode(final CancelModeType cancelMode) { - this.cancelMode = cancelMode; - return this; - } - - public String getOperationParams() { - return operationParams; - } - - public void setOperationParams(final String operationParams) { - this.operationParams = operationParams; - } - - public NsLcmOpOcc operationParams(final String operationParams) { - this.operationParams = operationParams; - return this; - } - - public boolean getIsCancelPending() { - return isCancelPending; - } - - public void setIsCancelPending(final boolean isCancelPending) { - this.isCancelPending = isCancelPending; - } - - public NsLcmOpOcc isCancelPending(final boolean isCancelPending) { - this.isCancelPending = isCancelPending; - return this; - } - - @Override - public boolean equals(final Object obj) { - if (this == obj) - return true; - if (obj == null || getClass() != obj.getClass()) - return false; - final NsLcmOpOcc that = (NsLcmOpOcc) obj; - return Objects.equals(id, that.id) && Objects.equals(operationState, that.operationState) - && Objects.equals(stateEnteredTime, that.stateEnteredTime) && Objects.equals(startTime, that.startTime) - && (nfvoNsInst == null ? that.nfvoNsInst == null - : that.nfvoNsInst != null && Objects.equals(nfvoNsInst, that.nfvoNsInst)) - && Objects.equals(operation, that.operation) && Objects.equals(isAutoInvocation, that.isAutoInvocation) - && Objects.equals(operationParams, that.operationParams) - && Objects.equals(isCancelPending, that.isCancelPending) && Objects.equals(cancelMode, that.cancelMode); - } - - @Override - public int hashCode() { - return Objects.hash(id, operationState, stateEnteredTime, startTime, - nfvoNsInst != null ? nfvoNsInst.getNsInstId() : 0, operation, isAutoInvocation, operationParams, - isCancelPending, cancelMode); - } - - @Override - public String toString() { - final StringBuilder sb = new StringBuilder(); - sb.append("class NsLcmOpOcc {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" operationState: ").append(toIndentedString(operationState)).append("\n"); - sb.append(" stateEnteredTime: ").append(toIndentedString(stateEnteredTime)).append("\n"); - sb.append(" startTime: ").append(toIndentedString(startTime)).append("\n"); - sb.append(" nfvoNsInst: ").append(nfvoNsInst != null ? toIndentedString(nfvoNsInst.getNsInstId()) : null) - .append("\n"); - sb.append(" operation: ").append(toIndentedString(operation)).append("\n"); - sb.append(" isAutoInvocation: ").append(toIndentedString(isAutoInvocation)).append("\n"); - sb.append(" operationParams: ").append(toIndentedString(operationParams)).append("\n"); - sb.append(" isCancelPending: ").append(toIndentedString(isCancelPending)).append("\n"); - sb.append(" cancelMode: ").append(toIndentedString(cancelMode)).append("\n"); - sb.append("}"); - return sb.toString(); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NsLcmOpType.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NsLcmOpType.java deleted file mode 100644 index 351f9611c5..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/NsLcmOpType.java +++ /dev/null @@ -1,28 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.beans; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public enum NsLcmOpType { - INSTANTIATE, TERMINATE, SCALE, UPDATE, HEAL; -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/OperationStateEnum.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/OperationStateEnum.java deleted file mode 100644 index 236652e027..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/OperationStateEnum.java +++ /dev/null @@ -1,29 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.beans; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public enum OperationStateEnum { - PROCESSING, COMPLETED, PARTIALLY_COMPLETED, FAILED_TEMP, FAILED, ROLLING_BACK, ROLLED_BACK; - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/State.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/State.java deleted file mode 100644 index ce917dd771..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/State.java +++ /dev/null @@ -1,29 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.beans; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public enum State { - NOT_INSTANTIATED, INSTANTIATING, INSTANTIATED, FAILED, TERMINATING; - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/utils/Utils.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/utils/Utils.java deleted file mode 100644 index b84f95aa50..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/utils/Utils.java +++ /dev/null @@ -1,59 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.beans.utils; - -import java.util.List; -import java.util.Objects; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class Utils { - - private Utils() {} - - public static final String toIndentedString(final Object object) { - return object == null ? "null" : object.toString().replace("\n", "\n "); - } - - - public static boolean isEquals(final List<?> first, List<?> second) { - if (first == null) { - return second == null; - } - - if (first.isEmpty()) { - return second.isEmpty(); - } - if ((first != null && second != null) && (first.size() == second.size())) { - for (int index = 0; index < first.size(); index++) { - if (!Objects.equals(first.get(index), second.get(index))) { - return false; - } - } - return true; - - } - return false; - } - - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/config/NfvoDatabaseConfiguration.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/config/NfvoDatabaseConfiguration.java deleted file mode 100644 index 1b4e40985a..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/config/NfvoDatabaseConfiguration.java +++ /dev/null @@ -1,95 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.config; - -import static org.slf4j.LoggerFactory.getLogger; -import javax.persistence.EntityManagerFactory; -import javax.sql.DataSource; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJob; -import org.slf4j.Logger; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.boot.autoconfigure.flyway.FlywayDataSource; -import org.springframework.boot.context.properties.ConfigurationProperties; -import org.springframework.boot.orm.jpa.EntityManagerFactoryBuilder; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.context.annotation.Primary; -import org.springframework.data.jpa.repository.config.EnableJpaRepositories; -import org.springframework.jmx.export.MBeanExporter; -import org.springframework.orm.jpa.JpaTransactionManager; -import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean; -import org.springframework.transaction.PlatformTransactionManager; -import org.springframework.transaction.annotation.EnableTransactionManagement; -import com.zaxxer.hikari.HikariConfig; -import com.zaxxer.hikari.HikariDataSource; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Configuration -@EnableTransactionManagement -@EnableJpaRepositories(entityManagerFactoryRef = "entityManagerFactory", - basePackages = {"org.onap.so.etsi.nfvo.ns.lcm.database.repository"}) -public class NfvoDatabaseConfiguration { - private static final Logger logger = getLogger(NfvoDatabaseConfiguration.class); - - private static final String PERSISTENCE_UNIT = "nfvo"; - private static final String NFVO_DATA_SOURCE_QUALIFIER = "nfvoDataSource"; - - @Autowired(required = false) - private MBeanExporter mBeanExporter; - - @Bean - @ConfigurationProperties(prefix = "spring.datasource.hikari.nfvo") - public HikariConfig nfvoDbConfig() { - logger.debug("Creating NFVO HikariConfig bean ... "); - return new HikariConfig(); - } - - @Primary - @FlywayDataSource - @Bean(name = NFVO_DATA_SOURCE_QUALIFIER) - public DataSource dataSource() { - if (mBeanExporter != null) { - mBeanExporter.addExcludedBean(NFVO_DATA_SOURCE_QUALIFIER); - } - logger.debug("Creating NFVO HikariDataSource bean ... "); - final HikariConfig hikariConfig = this.nfvoDbConfig(); - return new HikariDataSource(hikariConfig); - } - - @Primary - @Bean(name = "entityManagerFactory") - public LocalContainerEntityManagerFactoryBean entityManagerFactory(final EntityManagerFactoryBuilder builder, - @Qualifier(NFVO_DATA_SOURCE_QUALIFIER) final DataSource dataSource) { - return builder.dataSource(dataSource).packages(NfvoJob.class.getPackage().getName()) - .persistenceUnit(PERSISTENCE_UNIT).build(); - } - - @Primary - @Bean(name = "transactionManager") - public PlatformTransactionManager transactionManager( - @Qualifier("entityManagerFactory") final EntityManagerFactory entityManagerFactory) { - return new JpaTransactionManager(entityManagerFactory); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NSLcmOpOccRepository.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NSLcmOpOccRepository.java deleted file mode 100644 index d7f2f4cefa..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NSLcmOpOccRepository.java +++ /dev/null @@ -1,42 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.repository; - -import java.util.Optional; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NsLcmOpOcc; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.OperationStateEnum; -import org.springframework.data.jpa.repository.JpaRepository; -import org.springframework.data.jpa.repository.Modifying; -import org.springframework.data.jpa.repository.Query; -import org.springframework.data.repository.query.Param; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * @author mukeshsharma(mukeshsharma@est.tech) - */ -public interface NSLcmOpOccRepository extends JpaRepository<NsLcmOpOcc, String> { - - Optional<NsLcmOpOcc> findById(final String id); - - @Modifying(clearAutomatically = true) - @Query("UPDATE NsLcmOpOcc SET operationState = (:operationState) WHERE id = (:id)") - int updateNsLcmOpOccOperationState(@Param("id") final String id, - @Param("operationState") final OperationStateEnum operationState); -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NfvoJobRepository.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NfvoJobRepository.java deleted file mode 100644 index 220902c631..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NfvoJobRepository.java +++ /dev/null @@ -1,35 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.repository; - -import java.util.Optional; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJob; -import org.springframework.data.jpa.repository.JpaRepository; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public interface NfvoJobRepository extends JpaRepository<NfvoJob, String>, RefreshableRepository<NfvoJob> { - - Optional<NfvoJob> findByResourceId(final String resourceId); - - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NfvoJobStatusRepository.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NfvoJobStatusRepository.java deleted file mode 100644 index c3fe469ff6..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NfvoJobStatusRepository.java +++ /dev/null @@ -1,30 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.repository; - -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJobStatus; -import org.springframework.data.repository.CrudRepository; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public interface NfvoJobStatusRepository extends CrudRepository<NfvoJobStatus, Integer> { -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NfvoNfInstRepository.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NfvoNfInstRepository.java deleted file mode 100644 index f91a85f2e6..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NfvoNfInstRepository.java +++ /dev/null @@ -1,50 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.repository; - -import java.util.List; -import java.util.Optional; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNfInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.springframework.data.jpa.repository.JpaRepository; -import org.springframework.data.jpa.repository.Modifying; -import org.springframework.data.jpa.repository.Query; -import org.springframework.data.repository.query.Param; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * @author mukeshsharma(mukeshsharma@est.tech) - */ -public interface NfvoNfInstRepository extends JpaRepository<NfvoNfInst, String> { - - Optional<NfvoNfInst> findByNfInstId(final String nfInstId); - - List<NfvoNfInst> findByNsInstNsInstId(final String nsInstId); - - List<NfvoNfInst> findByNsInstNsInstIdAndName(final String nsInstId, final String name); - - @Modifying(clearAutomatically = true) - @Query("UPDATE NfvoNfInst SET status = (:state) WHERE nfInstId = (:nfInstId)") - int updateNfInstState(@Param("nfInstId") final String nfInstId, @Param("state") final State state); - - @Modifying(clearAutomatically = true) - @Query("DELETE FROM NfvoNfInst WHERE nfInstId = (:nfInstId)") - void deleteNfvoNfInstUsingNfInstId(@Param("nfInstId") final String nfInstId); -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NfvoNsInstRepository.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NfvoNsInstRepository.java deleted file mode 100644 index a64cf9bdd5..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/NfvoNsInstRepository.java +++ /dev/null @@ -1,46 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.repository; - -import java.util.Optional; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.springframework.data.jpa.repository.JpaRepository; -import org.springframework.data.jpa.repository.Modifying; -import org.springframework.data.jpa.repository.Query; -import org.springframework.data.repository.query.Param; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public interface NfvoNsInstRepository extends JpaRepository<NfvoNsInst, String> { - - Optional<NfvoNsInst> findByName(final String name); - - Optional<NfvoNsInst> findByNsInstId(final String nsInstId); - - boolean existsNfvoNsInstByName(final String name); - - @Modifying(clearAutomatically = true) - @Query("UPDATE NfvoNsInst SET status = (:state) WHERE nsInstId = (:nsInstId)") - int updateNsInstState(@Param("nsInstId") final String nsInstId, @Param("state") final State state); - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/RefreshableRepository.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/RefreshableRepository.java deleted file mode 100644 index efa7130d26..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/RefreshableRepository.java +++ /dev/null @@ -1,30 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.repository; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public interface RefreshableRepository<T> { - - void refreshEntity(T entity); - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/RefreshableRepositoryImpl.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/RefreshableRepositoryImpl.java deleted file mode 100644 index abd095f3c3..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/repository/RefreshableRepositoryImpl.java +++ /dev/null @@ -1,42 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.repository; - -import javax.persistence.EntityManager; -import javax.persistence.PersistenceContext; -import org.springframework.stereotype.Repository; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Repository -public class RefreshableRepositoryImpl<T> implements RefreshableRepository<T> { - - @PersistenceContext - private EntityManager entityManager; - - @Override - public void refreshEntity(final T entity) { - entityManager.refresh(entity); - - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/service/DatabaseServiceProvider.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/service/DatabaseServiceProvider.java deleted file mode 100644 index ec8777d0fa..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/database/service/DatabaseServiceProvider.java +++ /dev/null @@ -1,183 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.service; - -import java.util.List; -import java.util.Optional; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJob; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNfInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NsLcmOpOcc; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.OperationStateEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.onap.so.etsi.nfvo.ns.lcm.database.repository.NSLcmOpOccRepository; -import org.onap.so.etsi.nfvo.ns.lcm.database.repository.NfvoJobRepository; -import org.onap.so.etsi.nfvo.ns.lcm.database.repository.NfvoNfInstRepository; -import org.onap.so.etsi.nfvo.ns.lcm.database.repository.NfvoNsInstRepository; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Service; -import org.springframework.transaction.annotation.Isolation; -import org.springframework.transaction.annotation.Propagation; -import org.springframework.transaction.annotation.Transactional; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ - -@Service -public class DatabaseServiceProvider { - private static final Logger logger = LoggerFactory.getLogger(DatabaseServiceProvider.class); - - private final NfvoJobRepository nfvoJobRepository; - - private final NfvoNsInstRepository nfvoNsInstRepository; - - private final NfvoNfInstRepository nfvoNfInstRepository; - - private final NSLcmOpOccRepository nsLcmOpOccRepository; - - @Autowired - public DatabaseServiceProvider(final NfvoJobRepository nfvoJobRepository, - final NfvoNsInstRepository nfvoNsInstRepository, final NfvoNfInstRepository nfvoNfInstRepository, - final NSLcmOpOccRepository nsLcmOpOccRepository) { - this.nfvoJobRepository = nfvoJobRepository; - this.nfvoNsInstRepository = nfvoNsInstRepository; - this.nfvoNfInstRepository = nfvoNfInstRepository; - this.nsLcmOpOccRepository = nsLcmOpOccRepository; - } - - public boolean addJob(final NfvoJob job) { - logger.info("Adding NfvoJob: {} to database", job); - return nfvoJobRepository.saveAndFlush(job) != null; - } - - public Optional<NfvoJob> getJob(final String jobId) { - logger.info("Querying database for NfvoJob using jobId: {}", jobId); - return nfvoJobRepository.findById(jobId); - } - - @Transactional(propagation = Propagation.REQUIRES_NEW, isolation = Isolation.REPEATABLE_READ, readOnly = true) - public Optional<NfvoJob> getRefreshedJob(final String jobId) { - logger.info("Querying database for NfvoJob using jobId: {}", jobId); - final Optional<NfvoJob> optional = getJob(jobId); - if (optional.isPresent()) { - nfvoJobRepository.refreshEntity(optional.get()); - } - return optional; - } - - public Optional<NfvoJob> getJobByResourceId(final String resourceId) { - logger.info("Querying database for NfvoJob using resourceId: {}", resourceId); - return nfvoJobRepository.findByResourceId(resourceId); - } - - public boolean isNsInstExists(final String name) { - logger.info("Checking if NfvoNsInst entry exists in database using name: {}", name); - return nfvoNsInstRepository.existsNfvoNsInstByName(name); - } - - public boolean isNsInstExists(final String nsInstId, final String nfName) { - logger.info("Checking if NfvoNfInst entry exists in database using nsInstId: {} and nfName: {}", nsInstId, - nfName); - return nfvoNfInstRepository.findByNsInstNsInstIdAndName(nsInstId, nfName).isEmpty(); - } - - public boolean saveNfvoNsInst(final NfvoNsInst nfvoNsInst) { - logger.info("Saving NfvoNsInst: {} to database", nfvoNsInst); - return nfvoNsInstRepository.saveAndFlush(nfvoNsInst) != null; - } - - @Transactional(propagation = Propagation.REQUIRES_NEW) - public boolean updateNsInstState(final String nsInstId, final State state) { - logger.info("Updating NfvoNsInst: {} State to {}", nsInstId, state); - return nfvoNsInstRepository.updateNsInstState(nsInstId, state) > 0; - } - - public Optional<NfvoNsInst> getNfvoNsInst(final String nsInstId) { - logger.info("Querying database for NfvoNsInst using nsInstId: {}", nsInstId); - return nfvoNsInstRepository.findById(nsInstId); - } - - public Optional<NfvoNsInst> getNfvoNsInstByName(final String name) { - logger.info("Querying database for NfvoNsInst using name: {}", name); - return nfvoNsInstRepository.findByName(name); - } - - public boolean saveNfvoNfInst(final NfvoNfInst nfvoNfInst) { - logger.info("Saving NfvoNfInst: {} to database", nfvoNfInst); - return nfvoNfInstRepository.saveAndFlush(nfvoNfInst) != null; - } - - @Transactional(propagation = Propagation.REQUIRES_NEW) - public boolean updateNfInstState(final String nfInstId, final State state) { - logger.info("Updating NfvoNfInst: {} State to {}", nfInstId, state); - return nfvoNfInstRepository.updateNfInstState(nfInstId, state) > 0; - } - - public List<NfvoNfInst> getNfvoNfInstByNsInstId(final String nsInstId) { - logger.info("Querying database for NfvoNfInst using nsInstId: {}", nsInstId); - return nfvoNfInstRepository.findByNsInstNsInstId(nsInstId); - } - - public List<NfvoNfInst> getNfvoNfInstByNsInstIdAndNfName(final String nsInstId, final String name) { - logger.info("Querying database for NfvoNfInst using nsInstId: {} and name : {} ", nsInstId, name); - return nfvoNfInstRepository.findByNsInstNsInstIdAndName(nsInstId, name); - } - - public Optional<NfvoNfInst> getNfvoNfInst(final String nfInstId) { - logger.info("Querying database for NfvoNfInst using nfInstId: {}", nfInstId); - return nfvoNfInstRepository.findByNfInstId(nfInstId); - } - - public boolean isNfInstExists(final String nfInstId) { - logger.info("Checking if NfvoNfInst entry exists in database using nfInstId: {}", nfInstId); - return nfvoNfInstRepository.findByNfInstId(nfInstId).isPresent(); - } - - @Transactional(propagation = Propagation.REQUIRES_NEW) - public void deleteNfvoNfInst(final String nfInstId) { - logger.info("Deleting NfvoNfInst with nfInstId: {} from database", nfInstId); - nfvoNfInstRepository.deleteNfvoNfInstUsingNfInstId(nfInstId); - } - - public boolean addNSLcmOpOcc(final NsLcmOpOcc nsLcmOpOcc) { - logger.info("Adding NSLcmOpOcc: {} to database", nsLcmOpOcc); - return nsLcmOpOccRepository.saveAndFlush(nsLcmOpOcc) != null; - } - - @Transactional(propagation = Propagation.REQUIRES_NEW) - public boolean updateNsLcmOpOccOperationState(final String id, final OperationStateEnum operationState) { - logger.info("Updating NsLcmOpOcc: {} operationState to {}", id, operationState); - return nsLcmOpOccRepository.updateNsLcmOpOccOperationState(id, operationState) > 0; - } - - public Optional<NsLcmOpOcc> getNsLcmOpOcc(final String id) { - logger.info("Querying database for NsLcmOpOcc using id: {}", id); - return nsLcmOpOccRepository.findById(id); - } - - public void deleteNfvoNsInst(final String nsInstId) { - logger.info("Deleting NfvoNsInst with nsInstId: {}", nsInstId); - nfvoNsInstRepository.deleteById(nsInstId); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/resources/db/migration/V1_1__create_nfvo_tables.sql b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/resources/db/migration/V1_1__create_nfvo_tables.sql deleted file mode 100644 index 7f50c791f6..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/main/resources/db/migration/V1_1__create_nfvo_tables.sql +++ /dev/null @@ -1,70 +0,0 @@ -use nfvo; - -CREATE TABLE IF NOT EXISTS `JOB` ( - `JOB_ID` varchar(255) PRIMARY KEY NOT NULL, - `JOB_TYPE` varchar(255) NOT NULL, - `JOB_ACTION` varchar(255) NOT NULL, - `RESOURCE_ID` varchar(255) NOT NULL, - `RESOURCE_NAME` varchar(255) DEFAULT NULL, - `STATUS` varchar(255) NOT NULL, - `START_TIME` DATETIME DEFAULT NULL, - `END_TIME` DATETIME DEFAULT NULL, - `PROGRESS` int(11) DEFAULT NULL, - `PROCESS_INSTANCE_ID` varchar(255) DEFAULT NULL -) ENGINE=InnoDB DEFAULT CHARSET=utf8; - - - -CREATE TABLE IF NOT EXISTS `JOB_STATUS` ( - `ID` INT NOT NULL PRIMARY KEY AUTO_INCREMENT, - `UPDATED_TIME` DATETIME NOT NULL, - `DESCRIPTION` longtext DEFAULT NULL, - `STATUS` varchar(255) NOT NULL, - `JOB_ID` varchar(255) NOT NULL, - FOREIGN KEY (JOB_ID) - REFERENCES JOB(JOB_ID) - ON UPDATE CASCADE ON DELETE CASCADE -) ENGINE=InnoDB DEFAULT CHARSET=utf8; - -CREATE TABLE IF NOT EXISTS `NS_INST` ( - `NS_INST_ID` varchar(255) PRIMARY KEY NOT NULL, - `NAME` varchar(255) NOT NULL, - `NS_PACKAGE_ID` varchar(255) DEFAULT NULL, - `NSD_ID` varchar(255) NOT NULL, - `NSD_INVARIANT_ID` varchar(255) NOT NULL, - `DESCRIPTION` longtext DEFAULT NULL, - `STATUS` varchar(255) NOT NULL, - `STATUS_UPDATED_TIME` DATETIME NOT NULL, - `GLOBAL_CUSTOMER_ID` varchar(255) DEFAULT NULL, - `SERVICE_TYPE` varchar(255) DEFAULT NULL -) ENGINE=InnoDB DEFAULT CHARSET=utf8; - -CREATE TABLE IF NOT EXISTS `NF_INST` ( - `NF_INST_ID` varchar(255) PRIMARY KEY NOT NULL, - `NAME` varchar(255) DEFAULT NULL, - `VNFD_ID` varchar(255) DEFAULT NULL, - `PACKAGE_ID` varchar(255) DEFAULT NULL, - `NS_INST_ID` varchar(255) NOT NULL, - `STATUS` varchar(255) NOT NULL, - `CREATE_TIME` DATETIME DEFAULT NULL, - `LAST_UPDATE_TIME` DATETIME DEFAULT NULL, - FOREIGN KEY (NS_INST_ID) - REFERENCES NS_INST(NS_INST_ID) - ON UPDATE CASCADE ON DELETE CASCADE -) ENGINE=InnoDB DEFAULT CHARSET=utf8; - -CREATE TABLE IF NOT EXISTS `NS_LCM_OP_OCCS` ( - `ID` varchar(255) PRIMARY KEY NOT NULL, - `OPERATION_STATE` varchar(255) NOT NULL, - `STATE_ENTERED_TIME` DATETIME DEFAULT NULL, - `START_TIME` DATETIME DEFAULT NULL, - `NS_INST_ID` varchar(255) NOT NULL, - `OPERATION` varchar(255) NOT NULL, - `IS_AUTO_INVOCATION` varchar(255) NOT NULL, - `OPERATION_PARAMS` longtext NOT NULL, - `IS_CANCEL_PENDING` varchar(255) NOT NULL, - `CANCEL_MODE` varchar(255) DEFAULT NULL, - FOREIGN KEY (NS_INST_ID) - REFERENCES NS_INST(NS_INST_ID) - ON UPDATE CASCADE ON DELETE CASCADE -) ENGINE=InnoDB DEFAULT CHARSET=utf8; diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/database/DatabaseServiceProviderTest.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/database/DatabaseServiceProviderTest.java deleted file mode 100644 index b9858a8dd5..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/database/DatabaseServiceProviderTest.java +++ /dev/null @@ -1,181 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database; - -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; -import java.time.LocalDateTime; -import java.time.temporal.ChronoUnit; -import java.util.List; -import java.util.Optional; -import java.util.UUID; -import org.junit.Test; -import org.junit.runner.RunWith; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobAction; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.JobStatusEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJob; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJobStatus; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNfInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NsLcmOpOcc; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NsLcmOpType; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.OperationStateEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.test.context.SpringBootTest; -import org.springframework.test.context.ActiveProfiles; -import org.springframework.test.context.junit4.SpringRunner; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@RunWith(SpringRunner.class) -@SpringBootTest(classes = TestApplication.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) -@ActiveProfiles("test") -public class DatabaseServiceProviderTest { - - private static final String RANDOM_ID = UUID.randomUUID().toString(); - private static final String DUMMY_NAME = "NAME"; - private static final LocalDateTime CURRENT_DATE_TIME = LocalDateTime.now().truncatedTo(ChronoUnit.MILLIS); - @Autowired - private DatabaseServiceProvider databaseServiceProvider; - - @Test - public void testAddJob_StoredInDatabase() { - final NfvoJob expected = new NfvoJob().jobType("TYPE").jobAction(JobAction.CREATE).resourceId(RANDOM_ID) - .resourceName(DUMMY_NAME).startTime(CURRENT_DATE_TIME).status(JobStatusEnum.STARTED); - databaseServiceProvider.addJob(expected); - - Optional<NfvoJob> actual = databaseServiceProvider.getJob(expected.getJobId()); - assertEquals(expected, actual.get()); - - actual = databaseServiceProvider.getRefreshedJob(expected.getJobId()); - assertEquals(expected, actual.get()); - - } - - @Test - public void testAddJobWithJobStatus_StoredInDatabase() { - final NfvoJob job = new NfvoJob().jobType("TYPE").jobAction(JobAction.CREATE).resourceId(RANDOM_ID) - .resourceName(DUMMY_NAME).startTime(CURRENT_DATE_TIME).status(JobStatusEnum.STARTED); - databaseServiceProvider.addJob(job); - - final NfvoJobStatus jobStatus = new NfvoJobStatus().status(JobStatusEnum.STARTED) - .description("Create NS workflow process started").updatedTime(CURRENT_DATE_TIME); - databaseServiceProvider.addJob(job.nfvoJobStatus(jobStatus)); - - final Optional<NfvoJob> actual = databaseServiceProvider.getJob(job.getJobId()); - final NfvoJob actualNfvoJob = actual.get(); - - assertEquals(job.getJobId(), actualNfvoJob.getJobId()); - assertFalse(actualNfvoJob.getNfvoJobStatuses().isEmpty()); - assertEquals(job.getJobId(), actualNfvoJob.getNfvoJobStatuses().get(0).getNfvoJob().getJobId()); - - } - - @Test - public void testAddNsInst_StoredInDatabase_ableTofindByQuery() { - - final NfvoNsInst nsInst = new NfvoNsInst().name(DUMMY_NAME).nsdId(RANDOM_ID).status(State.NOT_INSTANTIATED) - .nsdInvariantId(RANDOM_ID).statusUpdatedTime(CURRENT_DATE_TIME); - - databaseServiceProvider.saveNfvoNsInst(nsInst); - - Optional<NfvoNsInst> actual = databaseServiceProvider.getNfvoNsInst(nsInst.getNsInstId()); - NfvoNsInst actualNfvoNsInst = actual.get(); - assertEquals(nsInst.getNsInstId(), actualNfvoNsInst.getNsInstId()); - assertEquals(RANDOM_ID, actualNfvoNsInst.getNsdId()); - assertEquals(State.NOT_INSTANTIATED, actualNfvoNsInst.getStatus()); - assertEquals(RANDOM_ID, actualNfvoNsInst.getNsdInvariantId()); - assertEquals(CURRENT_DATE_TIME, actualNfvoNsInst.getStatusUpdatedTime()); - - actual = databaseServiceProvider.getNfvoNsInstByName(DUMMY_NAME); - actualNfvoNsInst = actual.get(); - - assertEquals(nsInst.getNsInstId(), actualNfvoNsInst.getNsInstId()); - assertEquals(RANDOM_ID, actualNfvoNsInst.getNsdId()); - assertEquals(State.NOT_INSTANTIATED, actualNfvoNsInst.getStatus()); - assertEquals(RANDOM_ID, actualNfvoNsInst.getNsdInvariantId()); - assertEquals(CURRENT_DATE_TIME, actualNfvoNsInst.getStatusUpdatedTime()); - - - assertTrue(databaseServiceProvider.isNsInstExists(DUMMY_NAME)); - } - - @Test - public void testAddNfInst_StoredInDatabase_ableTofindByQuery() { - - final NfvoNsInst nsInst = new NfvoNsInst().name(DUMMY_NAME).nsdId(RANDOM_ID).status(State.NOT_INSTANTIATED) - .nsdInvariantId(RANDOM_ID).statusUpdatedTime(CURRENT_DATE_TIME); - - databaseServiceProvider.saveNfvoNsInst(nsInst); - - final NfvoNfInst nfInst = new NfvoNfInst().nfvoNsInst(nsInst).name(DUMMY_NAME).vnfdId(RANDOM_ID) - .status(State.NOT_INSTANTIATED).createTime(CURRENT_DATE_TIME).lastUpdateTime(CURRENT_DATE_TIME); - databaseServiceProvider.saveNfvoNfInst(nfInst); - - final Optional<NfvoNfInst> actual = databaseServiceProvider.getNfvoNfInst(nfInst.getNfInstId()); - final NfvoNfInst actualNfvoNfInst = actual.get(); - assertEquals(nsInst.getNsInstId(), actualNfvoNfInst.getNsInst().getNsInstId()); - assertEquals(nfInst.getNfInstId(), actualNfvoNfInst.getNfInstId()); - assertEquals(nfInst.getName(), actualNfvoNfInst.getName()); - assertEquals(nfInst.getVnfdId(), actualNfvoNfInst.getVnfdId()); - assertEquals(nfInst.getStatus(), actualNfvoNfInst.getStatus()); - assertEquals(nfInst.getCreateTime(), actualNfvoNfInst.getCreateTime()); - assertEquals(nfInst.getLastUpdateTime(), actualNfvoNfInst.getLastUpdateTime()); - - - List<NfvoNfInst> nfvoNfInstList = databaseServiceProvider.getNfvoNfInstByNsInstId(nsInst.getNsInstId()); - assertFalse(nfvoNfInstList.isEmpty()); - assertEquals(nsInst.getNsInstId(), nfvoNfInstList.get(0).getNsInst().getNsInstId()); - - nfvoNfInstList = databaseServiceProvider.getNfvoNfInstByNsInstIdAndNfName(nsInst.getNsInstId(), DUMMY_NAME); - - assertFalse(nfvoNfInstList.isEmpty()); - assertEquals(nsInst.getNsInstId(), nfvoNfInstList.get(0).getNsInst().getNsInstId()); - assertEquals(DUMMY_NAME, nfvoNfInstList.get(0).getName()); - } - - @Test - public void testAddNsLcmOpOcc_StoredInDatabase_ableTofindByQuery() { - - final NfvoNsInst nsInst = new NfvoNsInst().name(DUMMY_NAME).nsdId(RANDOM_ID).status(State.NOT_INSTANTIATED) - .nsdInvariantId(RANDOM_ID).statusUpdatedTime(CURRENT_DATE_TIME); - - databaseServiceProvider.saveNfvoNsInst(nsInst); - - final NsLcmOpOcc nsLcmOpOcc = new NsLcmOpOcc().nfvoNsInst(nsInst).operationState(OperationStateEnum.PROCESSING) - .isCancelPending(false).isAutoInvocation(false).operation(NsLcmOpType.INSTANTIATE) - .startTime(CURRENT_DATE_TIME).stateEnteredTime(CURRENT_DATE_TIME).operationParams(""); - - - databaseServiceProvider.addNSLcmOpOcc(nsLcmOpOcc); - - final Optional<NsLcmOpOcc> actual = databaseServiceProvider.getNsLcmOpOcc(nsLcmOpOcc.getId()); - final NsLcmOpOcc actualLcmOpOcc = actual.get(); - assertEquals(nsLcmOpOcc.getId(), actualLcmOpOcc.getId()); - - assertEquals(nsInst.getNsInstId(), actualLcmOpOcc.getNfvoNsInst().getNsInstId()); - - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/database/PojoClassesTests.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/database/PojoClassesTests.java deleted file mode 100644 index 5f033a2438..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/database/PojoClassesTests.java +++ /dev/null @@ -1,93 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database; - -import javax.persistence.Entity; -import javax.persistence.Id; -import org.junit.Test; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJob; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoJobStatus; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNfInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NsLcmOpOcc; -import org.onap.so.openpojo.rules.ToStringTester; -import com.openpojo.reflection.filters.FilterPackageInfo; -import com.openpojo.validation.Validator; -import com.openpojo.validation.ValidatorBuilder; -import com.openpojo.validation.test.impl.GetterTester; -import com.openpojo.validation.test.impl.SetterTester; -import nl.jqno.equalsverifier.EqualsVerifier; -import nl.jqno.equalsverifier.Warning; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - */ -public class PojoClassesTests { - - @Test - public void test_database_beans() throws ClassNotFoundException { - - final Validator validator = ValidatorBuilder.create().with(new SetterTester()).with(new GetterTester()) - .with(new ToStringTester()).build(); - validator.validate(NfvoNsInst.class.getPackageName(), new FilterPackageInfo()); - } - - @Test - public void test_database_nfvoJob_equalAndHashMethod() throws ClassNotFoundException { - EqualsVerifier.forClass(NfvoJob.class) - .suppress(Warning.STRICT_INHERITANCE, Warning.NONFINAL_FIELDS, Warning.INHERITED_DIRECTLY_FROM_OBJECT) - .withPrefabValues(NfvoJobStatus.class, new NfvoJobStatus().nfvoJob(new NfvoJob()), - new NfvoJobStatus().nfvoJob(new NfvoJob())) - .withIgnoredAnnotations(Entity.class, Id.class).verify(); - } - - @Test - public void test_database_nfvoJobStatus_equalAndHashMethod() throws ClassNotFoundException { - EqualsVerifier.forClass(NfvoJobStatus.class) - .suppress(Warning.STRICT_INHERITANCE, Warning.NONFINAL_FIELDS, Warning.INHERITED_DIRECTLY_FROM_OBJECT) - .withPrefabValues(NfvoJob.class, new NfvoJob(), new NfvoJob()) - .withIgnoredAnnotations(Entity.class, Id.class).verify(); - } - - @Test - public void test_database_nfvoNsInst_equalAndHashMethod() throws ClassNotFoundException { - EqualsVerifier.forClass(NfvoNsInst.class) - .suppress(Warning.STRICT_INHERITANCE, Warning.NONFINAL_FIELDS, Warning.INHERITED_DIRECTLY_FROM_OBJECT) - .withPrefabValues(NfvoNfInst.class, new NfvoNfInst(), new NfvoNfInst()) - .withPrefabValues(NsLcmOpOcc.class, new NsLcmOpOcc(), new NsLcmOpOcc()) - .withIgnoredAnnotations(Entity.class, Id.class).verify(); - } - - @Test - public void test_database_nfvoNfInst_equalAndHashMethod() throws ClassNotFoundException { - EqualsVerifier.forClass(NfvoNfInst.class) - .suppress(Warning.STRICT_INHERITANCE, Warning.NONFINAL_FIELDS, Warning.INHERITED_DIRECTLY_FROM_OBJECT) - .withPrefabValues(NfvoNsInst.class, new NfvoNsInst(), new NfvoNsInst()) - .withIgnoredAnnotations(Entity.class, Id.class).verify(); - } - - @Test - public void test_database_nsLcmOpOcc_equalAndHashMethod() throws ClassNotFoundException { - EqualsVerifier.forClass(NsLcmOpOcc.class) - .suppress(Warning.STRICT_INHERITANCE, Warning.NONFINAL_FIELDS, Warning.INHERITED_DIRECTLY_FROM_OBJECT) - .withPrefabValues(NfvoNsInst.class, new NfvoNsInst(), new NfvoNsInst()) - .withIgnoredAnnotations(Entity.class, Id.class).verify(); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/database/TestApplication.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/database/TestApplication.java deleted file mode 100644 index 921cae2343..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/database/TestApplication.java +++ /dev/null @@ -1,45 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.so.etsi.nfvo.ns.lcm.database; - -import org.springframework.boot.SpringApplication; -import org.springframework.boot.autoconfigure.EnableAutoConfiguration; -import org.springframework.boot.autoconfigure.SpringBootApplication; -import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration; -import org.springframework.context.annotation.ComponentScan; -import org.springframework.context.annotation.FilterType; -import org.springframework.context.annotation.ComponentScan.Filter; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@SpringBootApplication(scanBasePackages = {"org.onap.so"}) -@EnableAutoConfiguration(exclude = {JacksonAutoConfiguration.class}) -@ComponentScan(basePackages = {"org.onap"}, - excludeFilters = {@Filter(type = FilterType.ANNOTATION, classes = SpringBootApplication.class)}) -public class TestApplication { - - public static void main(final String[] args) { - new SpringApplication(TestApplication.class).run(args); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/utils/UtilsTest.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/utils/UtilsTest.java deleted file mode 100644 index 632bda937c..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/database/beans/utils/UtilsTest.java +++ /dev/null @@ -1,65 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.database.beans.utils; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; -import java.util.Arrays; -import java.util.Collections; -import org.junit.Test; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class UtilsTest { - - @Test - public void testTwoEmptyLists_equal() { - assertTrue(Utils.isEquals(Collections.emptyList(), Collections.emptyList())); - } - - @Test - public void testEmptyListAndNonEmpty_notEqual() { - assertFalse(Utils.isEquals(Collections.emptyList(), Arrays.asList("A"))); - } - - @Test - public void testTwoNullLists_equal() { - assertTrue(Utils.isEquals(null, null)); - } - - @Test - public void testNullListAndEmptyList_notEqual() { - assertFalse(Utils.isEquals(null, Collections.emptyList())); - } - - @Test - public void testTwoNotEmptyListsContainSameObjects_equal() { - assertTrue(Utils.isEquals(Arrays.asList("A"), Arrays.asList("A"))); - } - - @Test - public void testTwoNotEmptyListsContainsDifferentObjects_equal() { - assertFalse(Utils.isEquals(Arrays.asList("A"), Arrays.asList(1))); - } - - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/resources/application.yaml b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/resources/application.yaml deleted file mode 100644 index 478a5b5ac7..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-database-service/src/test/resources/application.yaml +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright © 2020 Nordix Foundation -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -spring: - main: - web-application-type: none - datasource: - hikari: - nfvo: - jdbcUrl: jdbc:h2:mem:nfvo;DB_CLOSE_DELAY=-1;INIT=CREATE SCHEMA IF NOT EXISTS nfvo;MODE=MYSQL;DATABASE_TO_LOWER=TRUE;CASE_INSENSITIVE_IDENTIFIERS=TRUE - driver-class-name: org.h2.Driver - pool-name: ns-lcm-bpmn-pool - registerMbeans: true - test: - database: - replace: NONE - jpa: - generate-ddl: true - dialect: org.hibernate.dialect.MySQL5Dialect - hibernate: - ddl-auto: create - database-platform: org.hibernate.dialect.MariaDBDialect -hibernate: - dialect: org.hibernate.dialect.H2Dialect - hbm2ddl: - auto: create
\ No newline at end of file diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/pom.xml b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/pom.xml deleted file mode 100644 index dd2590b03e..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/pom.xml +++ /dev/null @@ -1,78 +0,0 @@ -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> - <modelVersion>4.0.0</modelVersion> - <parent> - <groupId>org.onap.so.etsi.nfvo</groupId> - <artifactId>so-etsi-nfvo-ns-lcm</artifactId> - <version>1.8.0-SNAPSHOT</version> - </parent> - <artifactId>so-etsi-nfvo-ns-lcm-service</artifactId> - <name>SO ETSI NFVO NS LCM Service</name> - - <dependencies> - <dependency> - <groupId>org.onap.so.etsi.nfvo</groupId> - <artifactId>so-etsi-nfvo-ns-lcm-api</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> - <groupId>org.onap.so.etsi.nfvo</groupId> - <artifactId>so-etsi-nfvo-ns-lcm-bpmn-flows</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> - <groupId>org.springframework.boot</groupId> - <artifactId>spring-boot-starter-web</artifactId> - <exclusions> - <exclusion> - <groupId>com.fasterxml.jackson.core</groupId> - <artifactId>jackson-databind</artifactId> - </exclusion> - </exclusions> - </dependency> - <dependency> - <groupId>org.springframework.boot</groupId> - <artifactId>spring-boot-starter-security</artifactId> - <exclusions> - <exclusion> - <groupId>org.springframework.boot</groupId> - <artifactId>spring-boot-starter-tomcat</artifactId> - </exclusion> - </exclusions> - </dependency> - <dependency> - <groupId>org.springframework.boot</groupId> - <artifactId>spring-boot-starter-actuator</artifactId> - </dependency> - <dependency> - <groupId>org.springframework.boot</groupId> - <artifactId>spring-boot-starter-test</artifactId> - <scope>test</scope> - </dependency> - <dependency> - <groupId>org.onap.so</groupId> - <artifactId>common</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> - <groupId>org.onap.so.etsi.nfvo</groupId> - <artifactId>so-etsi-nfvo-ns-lcm-bpmn-flows</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> - <groupId>com.h2database</groupId> - <artifactId>h2</artifactId> - <scope>test</scope> - </dependency> - <dependency> - <groupId>junit</groupId> - <artifactId>junit</artifactId> - <scope>test</scope> - </dependency> - <dependency> - <groupId>com.h2database</groupId> - <artifactId>h2</artifactId> - <scope>test</scope> - </dependency> - </dependencies> -</project>
\ No newline at end of file diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/Constants.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/Constants.java deleted file mode 100644 index d330df3bae..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/Constants.java +++ /dev/null @@ -1,39 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -public class Constants { - - public static final String SERVICE_NAME = "so-etsi-nfvo-ns-lcm"; - public static final String SERVICE_VERSION = "v1"; - public static final String BASE_URL = "/so/" + SERVICE_NAME + "/" + SERVICE_VERSION + "/api"; - public static final String NS_LIFE_CYCLE_MANAGEMENT_BASE_URL = BASE_URL + "/nslcm/v1"; - - public static final String HTTP_GLOBAL_CUSTOMER_ID_HTTP_HEADER_PARM_NAME = "HTTP_GLOBALCUSTOMERID"; - public static final String HTTP_SERVICETYPE_HEADER_PARM_NAME = "HTTP_SERVICETYPE"; - public static final String HTTP_SERVICETYPE_HEADER_DEFAULT_VALUE = "NetworkService"; - - private Constants() {} - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/EtsiSoNsLcmManagerUrlProvider.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/EtsiSoNsLcmManagerUrlProvider.java deleted file mode 100644 index 80ec60468f..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/EtsiSoNsLcmManagerUrlProvider.java +++ /dev/null @@ -1,53 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm; - -import java.net.URI; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.context.annotation.Configuration; - - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Configuration -public class EtsiSoNsLcmManagerUrlProvider { - - private final String etsiNsLcmManagerEndpoint; - - @Autowired - public EtsiSoNsLcmManagerUrlProvider( - @Value("${so-etsi-nfvo-ns-lcm.endpoint:http://so-etsi-nfvo-ns-lcm.onap:9095}") final String etsiNsLcmManagerEndpoint) { - this.etsiNsLcmManagerEndpoint = etsiNsLcmManagerEndpoint; - } - - public URI getCreatedNsResourceUri(final String nsInstanceId) { - return URI.create(etsiNsLcmManagerEndpoint + Constants.NS_LIFE_CYCLE_MANAGEMENT_BASE_URL + "/ns_instances/" - + nsInstanceId); - } - - public URI getNsLcmOpOccUri(final String nsLcmOpOccId) { - return URI.create(etsiNsLcmManagerEndpoint + Constants.NS_LIFE_CYCLE_MANAGEMENT_BASE_URL + "/ns_lcm_op_occs/" - + nsLcmOpOccId); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/GsonSerializerConfiguration.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/GsonSerializerConfiguration.java deleted file mode 100644 index 2e11adae01..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/GsonSerializerConfiguration.java +++ /dev/null @@ -1,42 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm; - -import java.time.LocalDateTime; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.utils.LocalDateTimeTypeAdapter; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import com.google.gson.GsonBuilder; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Configuration -public class GsonSerializerConfiguration { - - @Bean - public GsonBuilder gsonBuilder() { - return new GsonBuilder().registerTypeAdapter(LocalDateTime.class, new LocalDateTimeTypeAdapter()); - } - -} - - diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/lifecycle/NsLcmOperationOccurrenceManager.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/lifecycle/NsLcmOperationOccurrenceManager.java deleted file mode 100644 index 8a5cee6d75..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/lifecycle/NsLcmOperationOccurrenceManager.java +++ /dev/null @@ -1,122 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.lifecycle; - -import static org.slf4j.LoggerFactory.getLogger; -import org.onap.so.etsi.nfvo.ns.lcm.EtsiSoNsLcmManagerUrlProvider; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NsLcmOpOcc; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsInstancesNsInstanceLinksSelf; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsLcmOpOccsNsLcmOpOcc; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsLcmOpOccsNsLcmOpOccLinks; -import org.slf4j.Logger; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Service; -import java.util.Optional; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * @author Andrew Lamb (andrew.a.lamb@est.tech) - * - */ -@Service -public class NsLcmOperationOccurrenceManager { - - private static final Logger logger = getLogger(NsLcmOperationOccurrenceManager.class); - - private final DatabaseServiceProvider databaseServiceProvider; - private final EtsiSoNsLcmManagerUrlProvider etsiSoNsLcmManagerUrlProvider; - - @Autowired - public NsLcmOperationOccurrenceManager(final DatabaseServiceProvider databaseServiceProvider, - final EtsiSoNsLcmManagerUrlProvider etsiSoNsLcmManagerUrlProvider) { - this.databaseServiceProvider = databaseServiceProvider; - this.etsiSoNsLcmManagerUrlProvider = etsiSoNsLcmManagerUrlProvider; - } - - public Optional<NsLcmOpOccsNsLcmOpOcc> getNsLcmOperationOccurrence(final String nsLcmOpOccId) { - logger.info("Getting NS LCM Operation Occurrence Operation for id: {}", nsLcmOpOccId); - final Optional<NsLcmOpOcc> optionalNsLcmOpOcc = databaseServiceProvider.getNsLcmOpOcc(nsLcmOpOccId); - - if (optionalNsLcmOpOcc.isEmpty()) { - logger.info("No NS LCM Operation Occurrence found for id: {}", nsLcmOpOccId); - return Optional.empty(); - } - - logger.info("Found NS LCM Operation Occurrence for id: {}", nsLcmOpOccId); - final NsLcmOpOcc nsLcmOpOcc = optionalNsLcmOpOcc.get(); - final NsLcmOpOccsNsLcmOpOcc nsLcmOpOccsNsLcmOpOcc = convertToNsLcmOpOccsNsLcmOpOcc(nsLcmOpOcc); - return Optional.of(nsLcmOpOccsNsLcmOpOcc); - } - - private NsLcmOpOccsNsLcmOpOcc convertToNsLcmOpOccsNsLcmOpOcc(final NsLcmOpOcc nsLcmOpOcc) { - logger.info("Converting Database NsLcmOpOcc to API NsLcmOpOcc... "); - final NsLcmOpOccsNsLcmOpOcc nsLcmOpOccsNsLcmOpOcc = - new NsLcmOpOccsNsLcmOpOcc().id(nsLcmOpOcc.getId()).statusEnteredTime(nsLcmOpOcc.getStateEnteredTime()) - .startTime(nsLcmOpOcc.getStartTime()).isAutomaticInvocation(nsLcmOpOcc.getIsAutoInvocation()) - .isCancelPending(nsLcmOpOcc.getIsCancelPending()); - - if (nsLcmOpOcc.getNfvoNsInst() != null) { - nsLcmOpOccsNsLcmOpOcc.setNsInstanceId(nsLcmOpOcc.getNfvoNsInst().getNsInstId()); - } - - if (nsLcmOpOcc.getOperationState() != null) { - nsLcmOpOccsNsLcmOpOcc.setOperationState( - NsLcmOpOccsNsLcmOpOcc.OperationStateEnum.fromValue(nsLcmOpOcc.getOperationState().toString())); - } - - if (nsLcmOpOcc.getOperation() != null) { - nsLcmOpOccsNsLcmOpOcc.setLcmOperationType( - NsLcmOpOccsNsLcmOpOcc.LcmOperationTypeEnum.fromValue(nsLcmOpOcc.getOperation().toString())); - } - - if (nsLcmOpOcc.getOperationParams() != null) { - nsLcmOpOccsNsLcmOpOcc.setOperationParams(nsLcmOpOcc.getOperationParams()); - } - - if (nsLcmOpOcc.getCancelMode() != null) { - nsLcmOpOccsNsLcmOpOcc.setCancelMode( - NsLcmOpOccsNsLcmOpOcc.CancelModeEnum.fromValue(nsLcmOpOcc.getCancelMode().toString())); - } - - nsLcmOpOccsNsLcmOpOcc.setLinks(generateLinks(nsLcmOpOcc)); - - logger.info("Database NsLcmOpOcc converted to API NsLcmOpOcc successfully... {}", nsLcmOpOccsNsLcmOpOcc); - return nsLcmOpOccsNsLcmOpOcc; - } - - private NsLcmOpOccsNsLcmOpOccLinks generateLinks(final NsLcmOpOcc nsLcmOpOcc) { - logger.info("Generating links..."); - final String nsLcmOpOccId = nsLcmOpOcc.getId(); - final NsInstancesNsInstanceLinksSelf linksSelfNsLcmOpOcc = new NsInstancesNsInstanceLinksSelf() - .href(etsiSoNsLcmManagerUrlProvider.getNsLcmOpOccUri(nsLcmOpOccId).toString()); - final NsLcmOpOccsNsLcmOpOccLinks links = new NsLcmOpOccsNsLcmOpOccLinks().self(linksSelfNsLcmOpOcc); - - if (nsLcmOpOcc.getNfvoNsInst() != null) { - final String nsInstId = nsLcmOpOcc.getNfvoNsInst().getNsInstId(); - final NsInstancesNsInstanceLinksSelf linksSelfNsInst = new NsInstancesNsInstanceLinksSelf() - .href(etsiSoNsLcmManagerUrlProvider.getCreatedNsResourceUri(nsInstId).toString()); - links.setNsInstance(linksSelfNsInst); - } - - return links; - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/lifecycle/NsLifeCycleManager.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/lifecycle/NsLifeCycleManager.java deleted file mode 100644 index ae9f55e1c5..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/lifecycle/NsLifeCycleManager.java +++ /dev/null @@ -1,90 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.lifecycle; - -import static org.slf4j.LoggerFactory.getLogger; -import java.net.URI; -import org.apache.commons.lang3.tuple.ImmutablePair; -import org.onap.so.etsi.nfvo.ns.lcm.EtsiSoNsLcmManagerUrlProvider; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.service.JobExecutorService; -import org.onap.so.etsi.nfvo.ns.lcm.model.CreateNsRequest; -import org.onap.so.etsi.nfvo.ns.lcm.model.InstantiateNsRequest; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsInstancesNsInstance; -import org.onap.so.etsi.nfvo.ns.lcm.model.TerminateNsRequest; -import org.slf4j.Logger; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.stereotype.Service; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Service -public class NsLifeCycleManager { - private static final Logger logger = getLogger(NsLifeCycleManager.class); - - private final JobExecutorService jobExecutorService; - - @Value("${etsi-so-ns-workflow-engine.requesttimeout.create.timeoutInSeconds:300}") - private int timeOutInSeconds; - - private final EtsiSoNsLcmManagerUrlProvider etsiSoNsLcmManagerUrlProvider; - - @Autowired - public NsLifeCycleManager(final JobExecutorService jobExecutorService, - final EtsiSoNsLcmManagerUrlProvider etsiSoNsLcmManagerUrlProvider) { - this.jobExecutorService = jobExecutorService; - this.etsiSoNsLcmManagerUrlProvider = etsiSoNsLcmManagerUrlProvider; - } - - public ImmutablePair<URI, NsInstancesNsInstance> createNs(final CreateNsRequest createNsRequest, - final String globalCustomerId, final String serviceType) { - logger.info("Will execute Create Ns for CreateNsRequest: {}, globalCustomerId: {} and serviceType: {}", - createNsRequest, globalCustomerId, serviceType); - final NsInstancesNsInstance nsInstanceResponse = - jobExecutorService.runCreateNsJob(createNsRequest, globalCustomerId, serviceType); - - return ImmutablePair.of(etsiSoNsLcmManagerUrlProvider.getCreatedNsResourceUri(nsInstanceResponse.getId()), - nsInstanceResponse); - } - - public URI instantiateNs(final String nsInstanceId, final InstantiateNsRequest instantiateNsRequest) { - logger.info("Will execute Instantiate Ns for InstantiateNsRequest: {} and nsInstanceId: {}", - instantiateNsRequest, nsInstanceId); - final String nsLcmOpOccId = jobExecutorService.runInstantiateNsJob(nsInstanceId, instantiateNsRequest); - - return etsiSoNsLcmManagerUrlProvider.getNsLcmOpOccUri(nsLcmOpOccId); - - } - - public URI terminateNs(final String nsInstanceId, final TerminateNsRequest terminateNsRequest) { - logger.info("Will execute Terminate Ns for TerminateNsRequest: {} and nsInstanceId: {}", terminateNsRequest, - nsInstanceId); - final String nsLcmOpOccId = jobExecutorService.runTerminateNsJob(nsInstanceId, terminateNsRequest); - - return etsiSoNsLcmManagerUrlProvider.getNsLcmOpOccUri(nsLcmOpOccId); - } - - public void deleteNs(final String nsInstanceId) { - logger.info("Will execute Delete Ns for nsInstanceId: {}", nsInstanceId); - jobExecutorService.runDeleteNsJob(nsInstanceId); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/rest/NsLcmOperationOccurrencesController.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/rest/NsLcmOperationOccurrencesController.java deleted file mode 100644 index 207f0ff387..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/rest/NsLcmOperationOccurrencesController.java +++ /dev/null @@ -1,85 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.rest; - -import static org.onap.so.etsi.nfvo.ns.lcm.Constants.NS_LIFE_CYCLE_MANAGEMENT_BASE_URL; -import static org.slf4j.LoggerFactory.getLogger; -import javax.ws.rs.core.MediaType; -import org.onap.so.etsi.nfvo.ns.lcm.lifecycle.NsLcmOperationOccurrenceManager; -import org.onap.so.etsi.nfvo.ns.lcm.model.InlineResponse400; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsLcmOpOccsNsLcmOpOcc; -import org.slf4j.Logger; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.http.HttpStatus; -import org.springframework.http.ResponseEntity; -import org.springframework.stereotype.Controller; -import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.PathVariable; -import org.springframework.web.bind.annotation.RequestMapping; -import java.util.Optional; - -/** - * Controller for handling NS lifecycle management operation occurrence requests see clause 6.4.9 and 6.4.10 in - * https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf - * - * @author Waqas Ikram (waqas.ikram@est.tech) - * @author Andrew Lamb (andrew.a.lamb@est.tech) - * - */ -@Controller -@RequestMapping(value = NS_LIFE_CYCLE_MANAGEMENT_BASE_URL) -public class NsLcmOperationOccurrencesController { - private static final Logger logger = getLogger(NsLcmOperationOccurrencesController.class); - - private final NsLcmOperationOccurrenceManager nsLcmOperationOccurrenceManager; - - @Autowired - public NsLcmOperationOccurrencesController(final NsLcmOperationOccurrenceManager nsLcmOperationOccurrenceManager) { - this.nsLcmOperationOccurrenceManager = nsLcmOperationOccurrenceManager; - } - - /** - * The GET method to retrieve status information about a NS lifecycle management operation occurrence by reading an - * individual "NS LCM operation occurrence" resource. - * - * @param nsLcmOpOccId Identifier of a NS lifecycle management operation occurrence - * @return "200 OK" with {@link NsLcmOpOccsNsLcmOpOcc NsLcmOpOcc} Information about a NS LCM operation occurrence - * was queried successfully. The response body shall contain status information about a NS lifecycle - * management operation occurrence (see clause 6.5.2.3). - */ - @GetMapping(value = "/ns_lcm_op_occs/{nsLcmOpOccId}", - produces = {MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) - public ResponseEntity<?> getOperationStatus(@PathVariable("nsLcmOpOccId") final String nsLcmOpOccId) { - logger.info("Received request to retrieve operation status for nsLcmOpOccId: {}", nsLcmOpOccId); - final Optional<NsLcmOpOccsNsLcmOpOcc> optionalNsLcmOpOccs = - nsLcmOperationOccurrenceManager.getNsLcmOperationOccurrence(nsLcmOpOccId); - - if (optionalNsLcmOpOccs.isPresent()) { - final NsLcmOpOccsNsLcmOpOcc nsLcmOpOcc = optionalNsLcmOpOccs.get(); - logger.info("Sending back NsLcmOpOcc: {}", nsLcmOpOcc); - return ResponseEntity.ok().body(nsLcmOpOcc); - } - - final String errorMessage = "Unable to retrieve operation occurrence status for nsLcmOpOccId: " + nsLcmOpOccId; - logger.error(errorMessage); - return ResponseEntity.status(HttpStatus.NOT_FOUND).body(new InlineResponse400().detail(errorMessage)); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/rest/NsLifecycleManagementController.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/rest/NsLifecycleManagementController.java deleted file mode 100644 index 4d6f92c373..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/rest/NsLifecycleManagementController.java +++ /dev/null @@ -1,156 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.rest; - -import static org.onap.so.etsi.nfvo.ns.lcm.Constants.HTTP_GLOBAL_CUSTOMER_ID_HTTP_HEADER_PARM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.Constants.HTTP_SERVICETYPE_HEADER_DEFAULT_VALUE; -import static org.onap.so.etsi.nfvo.ns.lcm.Constants.HTTP_SERVICETYPE_HEADER_PARM_NAME; -import static org.onap.so.etsi.nfvo.ns.lcm.Constants.NS_LIFE_CYCLE_MANAGEMENT_BASE_URL; -import static org.slf4j.LoggerFactory.getLogger; -import java.net.URI; -import javax.ws.rs.core.MediaType; -import org.apache.commons.lang3.tuple.ImmutablePair; -import org.onap.so.etsi.nfvo.ns.lcm.lifecycle.NsLifeCycleManager; -import org.onap.so.etsi.nfvo.ns.lcm.model.Body; -import org.onap.so.etsi.nfvo.ns.lcm.model.CreateNsRequest; -import org.onap.so.etsi.nfvo.ns.lcm.model.InstantiateNsRequest; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsInstancesNsInstance; -import org.onap.so.etsi.nfvo.ns.lcm.model.TerminateNsRequest; -import org.slf4j.Logger; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.http.ResponseEntity; -import org.springframework.stereotype.Controller; -import org.springframework.web.bind.annotation.DeleteMapping; -import org.springframework.web.bind.annotation.PathVariable; -import org.springframework.web.bind.annotation.PostMapping; -import org.springframework.web.bind.annotation.RequestBody; -import org.springframework.web.bind.annotation.RequestHeader; -import org.springframework.web.bind.annotation.RequestMapping; - -/** - * Controller for handling the NS Lifecycle Management. For further information please read: - * https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf Use the section number - * above each endpoint to find the corresponding section in the above document. - * - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@Controller -@RequestMapping(value = NS_LIFE_CYCLE_MANAGEMENT_BASE_URL) -public class NsLifecycleManagementController { - private static final Logger logger = getLogger(NsLifecycleManagementController.class); - - private final NsLifeCycleManager nsLifeCycleManager; - - @Autowired - public NsLifecycleManagementController(final NsLifeCycleManager nsLifeCycleManager) { - this.nsLifeCycleManager = nsLifeCycleManager; - } - - /** - * The POST method creates new {@link Body new NS instance resource} request. See Section Number: 6.3.1 for more - * detail - * - * @param globalCustomerId The global customer ID - * @param serviceType The service type - * @param createNsRequest create network service request (see clause 6.5.2.9) - * @return "201 Created" response containing a representation of the NS instance resource - * {@link NsInstancesNsInstance} just created by the NFVO, and provides the URI of the newly-created - * resource in the "Location:" HTTP header - */ - @PostMapping(value = "/ns_instances", produces = {MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}, - consumes = {MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) - public ResponseEntity<NsInstancesNsInstance> createNs( - @RequestHeader(value = HTTP_GLOBAL_CUSTOMER_ID_HTTP_HEADER_PARM_NAME, - required = true) final String globalCustomerId, - @RequestHeader(value = HTTP_SERVICETYPE_HEADER_PARM_NAME, required = false, - defaultValue = HTTP_SERVICETYPE_HEADER_DEFAULT_VALUE) final String serviceType, - @RequestBody final CreateNsRequest createNsRequest) { - logger.info("Received Create NS Request: {}\n with globalCustomerId: {}\n serviceType: {}\n", createNsRequest, - globalCustomerId, serviceType); - - final ImmutablePair<URI, NsInstancesNsInstance> nsInstance = - nsLifeCycleManager.createNs(createNsRequest, globalCustomerId, serviceType); - - final URI resourceUri = nsInstance.getLeft(); - final NsInstancesNsInstance createdNsresponse = nsInstance.getRight(); - - logger.info("NS resource created successfully. Resource location: {}, response: {}", resourceUri, - createdNsresponse); - - return ResponseEntity.created(resourceUri).body(createdNsresponse); - } - - /** - * The DELETE method delete NS instance - * - * @param nsInstanceId Identifier of the NS instance to be deleted. - * @return "202 Accepted" response with an empty entity body - */ - @DeleteMapping(value = "/ns_instances/{nsInstanceId}", - produces = {MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) - public ResponseEntity<Void> deleteNs(@PathVariable("nsInstanceId") final String nsInstanceId) { - logger.debug("Received delete NS request for nsInstanceId: {}", nsInstanceId); - nsLifeCycleManager.deleteNs(nsInstanceId); - logger.info("Successfully deleted NS for nsInstanceId: {}", nsInstanceId); - return ResponseEntity.noContent().build(); - } - - /** - * The POST method instantiate NS instance - * - * @param nsInstanceId Identifier of the NS instance to be instantiated. - * @param instantiateNsRequest Instantiate network service request (see clause 6.5.2.11) - * @return "202 Accepted" response with an empty entity body and a "Location" HTTP header that points to the new "NS - * Lifecycle Operation Occurrence" resource - */ - @PostMapping(value = "/ns_instances/{nsInstanceId}/instantiate", - produces = {MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}, - consumes = {MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) - public ResponseEntity<Void> instantiateNs(@PathVariable("nsInstanceId") final String nsInstanceId, - @RequestBody final InstantiateNsRequest instantiateNsRequest) { - logger.debug("Received instantiate NS request: {}\n with nsInstanceId: {}", instantiateNsRequest, nsInstanceId); - final URI resourceUri = nsLifeCycleManager.instantiateNs(nsInstanceId, instantiateNsRequest); - logger.info("{} Ns Instantiation started successfully. Resource Operation Occurrence uri: {}", nsInstanceId, - resourceUri); - return ResponseEntity.accepted().location(resourceUri).build(); - } - - /** - * The POST method terminate NS instance - * - * @param nsInstanceId Identifier of the NS instance to be terminated. - * @param terminateNsRequest The terminate NS request parameters (see clause 6.5.2.15) - * @return "202 Accepted" response with an empty entity body and a "Location" HTTP header that points to the new "NS - * Lifecycle Operation Occurrence" resource - */ - @PostMapping(value = "/ns_instances/{nsInstanceId}/terminate", - produces = {MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}, - consumes = {MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) - public ResponseEntity<Void> terminateNs(@PathVariable("nsInstanceId") final String nsInstanceId, - @RequestBody(required = false) final TerminateNsRequest terminateNsRequest) { - logger.debug("Received terminate NS request: {}\n with nsInstanceId: {}", terminateNsRequest, nsInstanceId); - final URI resourceUri = nsLifeCycleManager.terminateNs(nsInstanceId, terminateNsRequest); - logger.info("{} Ns Terminate started successfully. Resource Operation Occurrence uri: {}", nsInstanceId, - resourceUri); - return ResponseEntity.accepted().location(resourceUri).build(); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/rest/exceptions/NsLcmControllerExceptionHandler.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/rest/exceptions/NsLcmControllerExceptionHandler.java deleted file mode 100644 index 3db04fcfe8..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/main/java/org/onap/so/etsi/nfvo/ns/lcm/rest/exceptions/NsLcmControllerExceptionHandler.java +++ /dev/null @@ -1,58 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.rest.exceptions; - -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.exceptions.NsRequestProcessingException; -import org.onap.so.etsi.nfvo.ns.lcm.model.InlineResponse400; -import org.onap.so.etsi.nfvo.ns.lcm.rest.NsLifecycleManagementController; -import org.springframework.http.HttpStatus; -import org.springframework.http.ResponseEntity; -import org.springframework.web.bind.annotation.ControllerAdvice; -import org.springframework.web.bind.annotation.ExceptionHandler; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@ControllerAdvice(assignableTypes = NsLifecycleManagementController.class) -public class NsLcmControllerExceptionHandler { - - @ExceptionHandler(NsRequestProcessingException.class) - public ResponseEntity<InlineResponse400> handleNsRequestProcessingException( - final NsRequestProcessingException nsRequestProcessingException) { - return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR) - .body(getInlineResponse400(nsRequestProcessingException)); - } - - @ExceptionHandler(Exception.class) - public ResponseEntity<InlineResponse400> handleNsRequestProcessingException(final Exception exception) { - return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(new InlineResponse400() - .status(HttpStatus.INTERNAL_SERVER_ERROR.value()).detail(exception.getMessage())); - } - - private InlineResponse400 getInlineResponse400(final NsRequestProcessingException nsRequestProcessingException) { - if (nsRequestProcessingException.getProblemDetails() != null) { - return nsRequestProcessingException.getProblemDetails(); - } - return new InlineResponse400().status(HttpStatus.INTERNAL_SERVER_ERROR.value()) - .detail(nsRequestProcessingException.getMessage()); - } - -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/TestApplication.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/TestApplication.java deleted file mode 100644 index d6f4a83811..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/TestApplication.java +++ /dev/null @@ -1,37 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm; - -import org.springframework.boot.SpringApplication; -import org.springframework.boot.autoconfigure.EnableAutoConfiguration; -import org.springframework.boot.autoconfigure.SpringBootApplication; -import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@SpringBootApplication(scanBasePackages = {"org.onap.so"}) -@EnableAutoConfiguration(exclude = {JacksonAutoConfiguration.class}) -public class TestApplication { - public static void main(final String[] args) { - new SpringApplication(TestApplication.class).run(args); - } -} diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/rest/NsLcmOperationOccurrencesControllerTest.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/rest/NsLcmOperationOccurrencesControllerTest.java deleted file mode 100644 index c5862569f2..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/rest/NsLcmOperationOccurrencesControllerTest.java +++ /dev/null @@ -1,133 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.rest; - -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertTrue; -import java.time.LocalDateTime; -import java.util.Optional; -import java.util.UUID; -import org.junit.Before; -import org.junit.Test; -import org.junit.runner.RunWith; -import org.onap.so.etsi.nfvo.ns.lcm.Constants; -import org.onap.so.etsi.nfvo.ns.lcm.TestApplication; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.GsonProvider; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NfvoNsInst; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NsLcmOpOcc; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.NsLcmOpType; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.OperationStateEnum; -import org.onap.so.etsi.nfvo.ns.lcm.database.beans.State; -import org.onap.so.etsi.nfvo.ns.lcm.database.service.DatabaseServiceProvider; -import org.onap.so.etsi.nfvo.ns.lcm.model.InlineResponse400; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsLcmOpOccsNsLcmOpOcc; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.test.context.SpringBootTest; -import org.springframework.boot.test.web.client.TestRestTemplate; -import org.springframework.boot.web.client.RestTemplateBuilder; -import org.springframework.boot.web.server.LocalServerPort; -import org.springframework.http.HttpEntity; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.ResponseEntity; -import org.springframework.http.converter.json.GsonHttpMessageConverter; -import org.springframework.test.context.ActiveProfiles; -import org.springframework.test.context.junit4.SpringRunner; -import com.google.gson.Gson; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * @author Andrew Lamb (andrew.a.lamb@est.tech) - * - */ - -@RunWith(SpringRunner.class) -@SpringBootTest(classes = TestApplication.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) -@ActiveProfiles("test") -public class NsLcmOperationOccurrencesControllerTest { - - private static final String NS_LCM_OP_OCCS = "/ns_lcm_op_occs/"; - - @LocalServerPort - private int port; - - @Autowired - private DatabaseServiceProvider databaseServiceProvider; - - @Autowired - private GsonProvider gsonProvider; - - private TestRestTemplate testRestTemplate; - - @Before - public void setUp() { - final Gson gson = gsonProvider.getGson(); - testRestTemplate = new TestRestTemplate( - new RestTemplateBuilder().additionalMessageConverters(new GsonHttpMessageConverter(gson))); - } - - @Test - public void testGetOperationStatus_validNsLcmOpOccId_returnsNsLcmOpOcc() { - final String nsLcmOpOccId = addDummyNsLcmOpOccToDatabase(); - final String baseUrl = getNsLcmBaseUrl() + NS_LCM_OP_OCCS + nsLcmOpOccId; - final HttpEntity<?> request = new HttpEntity<>(new HttpHeaders()); - final ResponseEntity<NsLcmOpOccsNsLcmOpOcc> responseEntity = - testRestTemplate.exchange(baseUrl, HttpMethod.GET, request, NsLcmOpOccsNsLcmOpOcc.class); - assertEquals(HttpStatus.OK, responseEntity.getStatusCode()); - assertTrue(responseEntity.hasBody()); - assertNotNull(responseEntity.getBody()); - } - - @Test - public void testGetOperationStatus_nsLcmOpOccIdNotFound_returnsInlineResponse400() { - final String nsLcmOpOccId = UUID.randomUUID().toString(); - final Optional<NsLcmOpOcc> optionalNsLcmOpOcc = databaseServiceProvider.getNsLcmOpOcc(nsLcmOpOccId); - assertTrue(optionalNsLcmOpOcc.isEmpty()); - final String baseUrl = getNsLcmBaseUrl() + NS_LCM_OP_OCCS + nsLcmOpOccId; - final HttpEntity<?> request = new HttpEntity<>(new HttpHeaders()); - final ResponseEntity<InlineResponse400> responseEntity = - testRestTemplate.exchange(baseUrl, HttpMethod.GET, request, InlineResponse400.class); - assertEquals(HttpStatus.NOT_FOUND, responseEntity.getStatusCode()); - assertTrue(responseEntity.hasBody()); - assertNotNull(responseEntity.getBody()); - } - - private String addDummyNsLcmOpOccToDatabase() { - final LocalDateTime currentDateTime = LocalDateTime.now(); - - final NfvoNsInst nsInst = new NfvoNsInst().name("name").nsdId("id").status(State.NOT_INSTANTIATED) - .nsdInvariantId("id").statusUpdatedTime(currentDateTime); - databaseServiceProvider.saveNfvoNsInst(nsInst); - - final NsLcmOpOcc nsLcmOpOcc = new NsLcmOpOcc().nfvoNsInst(nsInst).operationState(OperationStateEnum.PROCESSING) - .isCancelPending(false).isAutoInvocation(false).operation(NsLcmOpType.INSTANTIATE) - .startTime(currentDateTime).stateEnteredTime(currentDateTime).operationParams(""); - databaseServiceProvider.addNSLcmOpOcc(nsLcmOpOcc); - - return nsLcmOpOcc.getId(); - } - - private String getNsLcmBaseUrl() { - return "http://localhost:" + port + Constants.NS_LIFE_CYCLE_MANAGEMENT_BASE_URL; - } -} - diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/rest/NsLifecycleManagementControllerTest.java b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/rest/NsLifecycleManagementControllerTest.java deleted file mode 100644 index 585b0e1811..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/test/java/org/onap/so/etsi/nfvo/ns/lcm/rest/NsLifecycleManagementControllerTest.java +++ /dev/null @@ -1,288 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ -package org.onap.so.etsi.nfvo.ns.lcm.rest; - -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertTrue; -import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.Mockito.doNothing; -import static org.mockito.Mockito.doThrow; -import static org.mockito.Mockito.when; -import java.net.URISyntaxException; -import java.util.List; -import java.util.UUID; -import org.junit.Before; -import org.junit.Test; -import org.junit.runner.RunWith; -import org.onap.so.etsi.nfvo.ns.lcm.Constants; -import org.onap.so.etsi.nfvo.ns.lcm.TestApplication; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.GsonProvider; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.exceptions.NsRequestProcessingException; -import org.onap.so.etsi.nfvo.ns.lcm.bpmn.flows.service.JobExecutorService; -import org.onap.so.etsi.nfvo.ns.lcm.model.CreateNsRequest; -import org.onap.so.etsi.nfvo.ns.lcm.model.InlineResponse400; -import org.onap.so.etsi.nfvo.ns.lcm.model.InstantiateNsRequest; -import org.onap.so.etsi.nfvo.ns.lcm.model.NsInstancesNsInstance; -import org.onap.so.etsi.nfvo.ns.lcm.model.TerminateNsRequest; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.test.context.SpringBootTest; -import org.springframework.boot.test.mock.mockito.MockBean; -import org.springframework.boot.test.web.client.TestRestTemplate; -import org.springframework.boot.web.client.RestTemplateBuilder; -import org.springframework.boot.web.server.LocalServerPort; -import org.springframework.http.HttpEntity; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.ResponseEntity; -import org.springframework.http.converter.json.GsonHttpMessageConverter; -import org.springframework.test.context.ActiveProfiles; -import org.springframework.test.context.junit4.SpringRunner; -import com.google.gson.Gson; - -/** - * @author Waqas Ikram (waqas.ikram@est.tech) - * - */ -@RunWith(SpringRunner.class) -@SpringBootTest(classes = TestApplication.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) -@ActiveProfiles("test") -public class NsLifecycleManagementControllerTest { - private static final String EXPECTED_BASE_URL = - "http://so-etsi-nfvo-ns-lcm.onap:9095/so/so-etsi-nfvo-ns-lcm/v1/api/nslcm/v1"; - private static final String RANDOM_NS_LCM_OP_OCC_ID = UUID.randomUUID().toString(); - private static final String RANDOM_NS_INST_ID = UUID.randomUUID().toString(); - private static final String SERVICE_TYPE = "NetworkService"; - private static final String GLOBAL_CUSTOMER_ID = UUID.randomUUID().toString(); - private static final String EXPECTED_CREATE_REQ_LOCATION_URL = - EXPECTED_BASE_URL + "/ns_instances/" + RANDOM_NS_INST_ID; - private static final String EXPECTED_NS_LCM_OP_OCC_REQ_LOCATION_URL = - EXPECTED_BASE_URL + "/ns_lcm_op_occs/" + RANDOM_NS_LCM_OP_OCC_ID; - - @LocalServerPort - private int port; - - private TestRestTemplate testRestTemplate; - - @Autowired - private GsonProvider gsonProvider; - - @MockBean - private JobExecutorService mockedJobExecutorService; - - @Before - public void setUp() { - final Gson gson = gsonProvider.getGson(); - testRestTemplate = new TestRestTemplate( - new RestTemplateBuilder().additionalMessageConverters(new GsonHttpMessageConverter(gson))); - } - - @Test - public void testCreateNs_ValidCreateNsRequest() throws URISyntaxException { - - final CreateNsRequest createNsRequest = getCreateNsRequest(); - - when(mockedJobExecutorService.runCreateNsJob(eq(createNsRequest), eq(GLOBAL_CUSTOMER_ID), eq(SERVICE_TYPE))) - .thenReturn(new NsInstancesNsInstance().id(RANDOM_NS_INST_ID)); - - final String baseUrl = getNsLcmBaseUrl() + "/ns_instances"; - final HttpHeaders headers = new HttpHeaders(); - headers.add(Constants.HTTP_GLOBAL_CUSTOMER_ID_HTTP_HEADER_PARM_NAME, GLOBAL_CUSTOMER_ID); - final HttpEntity<?> request = new HttpEntity<>(createNsRequest, headers); - final ResponseEntity<NsInstancesNsInstance> responseEntity = - testRestTemplate.exchange(baseUrl, HttpMethod.POST, request, NsInstancesNsInstance.class); - assertEquals(HttpStatus.CREATED, responseEntity.getStatusCode()); - assertTrue(responseEntity.hasBody()); - assertNotNull(responseEntity.getBody()); - - final HttpHeaders httpHeaders = responseEntity.getHeaders(); - assertTrue(httpHeaders.containsKey(HttpHeaders.LOCATION)); - final List<String> actual = httpHeaders.get(HttpHeaders.LOCATION); - assertEquals(1, actual.size()); - assertEquals(EXPECTED_CREATE_REQ_LOCATION_URL, actual.get(0)); - } - - @Test - public void testCreateNs_createNsRequest_nsRequestProcessingExceptionThrown_returnInlineResponse400() - throws URISyntaxException { - - final CreateNsRequest createNsRequest = getCreateNsRequest(); - - final String message = "Unable to process request"; - when(mockedJobExecutorService.runCreateNsJob(eq(createNsRequest), eq(GLOBAL_CUSTOMER_ID), eq(SERVICE_TYPE))) - .thenThrow(new NsRequestProcessingException(message, new InlineResponse400().detail(message))); - - final String baseUrl = getNsLcmBaseUrl() + "/ns_instances"; - final HttpHeaders headers = new HttpHeaders(); - headers.add(Constants.HTTP_GLOBAL_CUSTOMER_ID_HTTP_HEADER_PARM_NAME, GLOBAL_CUSTOMER_ID); - final HttpEntity<?> request = new HttpEntity<>(createNsRequest, headers); - final ResponseEntity<InlineResponse400> responseEntity = - testRestTemplate.exchange(baseUrl, HttpMethod.POST, request, InlineResponse400.class); - assertEquals(HttpStatus.INTERNAL_SERVER_ERROR, responseEntity.getStatusCode()); - assertTrue(responseEntity.hasBody()); - assertNotNull(responseEntity.getBody()); - - final InlineResponse400 body = responseEntity.getBody(); - assertEquals(message, body.getDetail()); - - } - - @Test - public void testCreateNs_createNsRequest_exceptionThrown_returnInlineResponse400() throws URISyntaxException { - - final CreateNsRequest createNsRequest = getCreateNsRequest(); - - final String message = "Unable to process request"; - when(mockedJobExecutorService.runCreateNsJob(eq(createNsRequest), eq(GLOBAL_CUSTOMER_ID), eq(SERVICE_TYPE))) - .thenThrow(new RuntimeException(message)); - - final String baseUrl = getNsLcmBaseUrl() + "/ns_instances"; - final HttpHeaders headers = new HttpHeaders(); - headers.add(Constants.HTTP_GLOBAL_CUSTOMER_ID_HTTP_HEADER_PARM_NAME, GLOBAL_CUSTOMER_ID); - final HttpEntity<?> request = new HttpEntity<>(createNsRequest, headers); - final ResponseEntity<InlineResponse400> responseEntity = - testRestTemplate.exchange(baseUrl, HttpMethod.POST, request, InlineResponse400.class); - assertEquals(HttpStatus.INTERNAL_SERVER_ERROR, responseEntity.getStatusCode()); - assertTrue(responseEntity.hasBody()); - assertNotNull(responseEntity.getBody()); - - final InlineResponse400 body = responseEntity.getBody(); - assertEquals(message, body.getDetail()); - - } - - @Test - public void testDeleteNs_SuccessfulCase() { - final String nsInstId = UUID.randomUUID().toString(); - doNothing().when(mockedJobExecutorService).runDeleteNsJob(eq(nsInstId)); - - final String baseUrl = getNsLcmBaseUrl() + "/ns_instances/" + nsInstId; - final ResponseEntity<Void> responseEntity = - testRestTemplate.exchange(baseUrl, HttpMethod.DELETE, null, Void.class); - assertEquals(HttpStatus.NO_CONTENT, responseEntity.getStatusCode()); - } - - @Test - public void testDeleteNs_nsRequestProcessingExceptionThrown_returnInlineResponse400() { - final String nsInstId = UUID.randomUUID().toString(); - final String message = "Unable to process request"; - doThrow(new NsRequestProcessingException(message, new InlineResponse400().detail(message))) - .when(mockedJobExecutorService).runDeleteNsJob(eq(nsInstId)); - - final String baseUrl = getNsLcmBaseUrl() + "/ns_instances/" + nsInstId; - final ResponseEntity<InlineResponse400> responseEntity = - testRestTemplate.exchange(baseUrl, HttpMethod.DELETE, null, InlineResponse400.class); - - assertEquals(HttpStatus.INTERNAL_SERVER_ERROR, responseEntity.getStatusCode()); - assertTrue(responseEntity.hasBody()); - assertNotNull(responseEntity.getBody()); - } - - @Test - public void testInstantiateNs_ValidInstantiateNsRequest() { - - final InstantiateNsRequest instantiateNsRequest = getInstantiateNsRequest(); - when(mockedJobExecutorService.runInstantiateNsJob(eq(RANDOM_NS_INST_ID), eq(instantiateNsRequest))) - .thenReturn(RANDOM_NS_LCM_OP_OCC_ID); - - final String baseUrl = getNsLcmBaseUrl() + "/ns_instances/" + RANDOM_NS_INST_ID + "/instantiate"; - final HttpEntity<?> request = new HttpEntity<>(instantiateNsRequest); - final ResponseEntity<Void> responseEntity = - testRestTemplate.exchange(baseUrl, HttpMethod.POST, request, Void.class); - assertEquals(HttpStatus.ACCEPTED, responseEntity.getStatusCode()); - - final HttpHeaders httpHeaders = responseEntity.getHeaders(); - assertTrue(httpHeaders.containsKey(HttpHeaders.LOCATION)); - final List<String> actual = httpHeaders.get(HttpHeaders.LOCATION); - assertEquals(1, actual.size()); - assertEquals(EXPECTED_NS_LCM_OP_OCC_REQ_LOCATION_URL, actual.get(0)); - } - - @Test - public void testInstantiateNs_instantiateNsRequest_nsRequestProcessingExceptionThrown_returnInlineResponse400() { - final String message = "Unable to process request"; - final InstantiateNsRequest instantiateNsRequest = getInstantiateNsRequest(); - when(mockedJobExecutorService.runInstantiateNsJob(eq(RANDOM_NS_INST_ID), eq(instantiateNsRequest))) - .thenThrow(new NsRequestProcessingException(message, new InlineResponse400().detail(message))); - - final String baseUrl = getNsLcmBaseUrl() + "/ns_instances/" + RANDOM_NS_INST_ID + "/instantiate"; - final HttpEntity<?> request = new HttpEntity<>(instantiateNsRequest); - final ResponseEntity<InlineResponse400> responseEntity = - testRestTemplate.exchange(baseUrl, HttpMethod.POST, request, InlineResponse400.class); - - assertEquals(HttpStatus.INTERNAL_SERVER_ERROR, responseEntity.getStatusCode()); - assertTrue(responseEntity.hasBody()); - assertNotNull(responseEntity.getBody()); - } - - @Test - public void testTerminateNs_ValidTerminateNsRequest_Success() { - final TerminateNsRequest terminateNsRequest = getTerminateNsRequest(); - when(mockedJobExecutorService.runTerminateNsJob(eq(RANDOM_NS_INST_ID), eq(terminateNsRequest))) - .thenReturn(RANDOM_NS_LCM_OP_OCC_ID); - - final String baseUrl = getNsLcmBaseUrl() + "/ns_instances/" + RANDOM_NS_INST_ID + "/terminate"; - final HttpEntity<?> request = new HttpEntity<>(terminateNsRequest); - final ResponseEntity<Void> responseEntity = - testRestTemplate.exchange(baseUrl, HttpMethod.POST, request, Void.class); - assertEquals(HttpStatus.ACCEPTED, responseEntity.getStatusCode()); - - final HttpHeaders httpHeaders = responseEntity.getHeaders(); - assertTrue(httpHeaders.containsKey(HttpHeaders.LOCATION)); - final List<String> actual = httpHeaders.get(HttpHeaders.LOCATION); - assertEquals(1, actual.size()); - assertEquals(EXPECTED_NS_LCM_OP_OCC_REQ_LOCATION_URL, actual.get(0)); - } - - @Test - public void testTerminateNs_ValidTerminateNsRequest_nsRequestProcessingExceptionThrown_returnInlineResponse400() { - final String errorMessage = "ERROR MESSAGE"; - final TerminateNsRequest terminateNsRequest = getTerminateNsRequest(); - when(mockedJobExecutorService.runTerminateNsJob(eq(RANDOM_NS_INST_ID), eq(terminateNsRequest))) - .thenThrow(new NsRequestProcessingException(errorMessage)); - - final String baseUrl = getNsLcmBaseUrl() + "/ns_instances/" + RANDOM_NS_INST_ID + "/terminate"; - final HttpEntity<?> request = new HttpEntity<>(terminateNsRequest); - final ResponseEntity<InlineResponse400> responseEntity = - testRestTemplate.exchange(baseUrl, HttpMethod.POST, request, InlineResponse400.class); - assertEquals(HttpStatus.INTERNAL_SERVER_ERROR, responseEntity.getStatusCode()); - assertTrue(responseEntity.hasBody()); - assertNotNull(responseEntity.getBody()); - } - - private TerminateNsRequest getTerminateNsRequest() { - // Only support for the immediate Terminate request; i.e., terminateTime field is empty (not set) - return new TerminateNsRequest(); - } - - private InstantiateNsRequest getInstantiateNsRequest() { - return new InstantiateNsRequest().nsFlavourId("FLAVOUR_ID"); - } - - private CreateNsRequest getCreateNsRequest() { - return new CreateNsRequest().nsdId(RANDOM_NS_INST_ID); - } - - private String getNsLcmBaseUrl() { - return "http://localhost:" + port + Constants.NS_LIFE_CYCLE_MANAGEMENT_BASE_URL; - } -} - diff --git a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/test/resources/application.yaml b/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/test/resources/application.yaml deleted file mode 100644 index 608cde2471..0000000000 --- a/so-etsi-nfvo/so-etsi-nfvo-ns-lcm/so-etsi-nfvo-ns-lcm-service/src/test/resources/application.yaml +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright © 2020 Nordix Foundation -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -spring: - main: - allow-bean-definition-overriding: true - flyway: - baseline-on-migrate: false - datasource: - hikari: - camunda: - jdbcUrl: jdbc:h2:mem:example-simple;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE - driver-class-name: org.h2.Driver - pool-name: ns-lcm-bpmn-pool - registerMbeans: true - nfvo: - jdbcUrl: jdbc:h2:mem:NFVO;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE;INIT=CREATE SCHEMA IF NOT EXISTS NFVO;MODE=MYSQL;DATABASE_TO_LOWER=TRUE;CASE_INSENSITIVE_IDENTIFIERS=TRUE - driver-class-name: org.h2.Driver - pool-name: ns-lcm-nfvo-pool - registerMbeans: true - test: - database: - replace: NONE - jpa: - generate-ddl: true - dialect: org.hibernate.dialect.MySQL5Dialect - hibernate: - ddl-auto: create - database-platform: org.hibernate.dialect.MariaDBDialect -logging: - level: - org.reflections.Reflections: ERROR - -etsi-catalog-manager: - base: - endpoint: http://modeling-etsicatalog.onap:8806/api |