Skip to content
Snippets Groups Projects
Commit 6249ded4 authored by Elian Kraja's avatar Elian Kraja Committed by Giacomo Bernini
Browse files

Adding schemas and json body requests

parent b34553ca
No related branches found
No related tags found
2 merge requests!230Merging "3.5.1 dev" into "Release 3",!207SOL005 NS LCM Coordination - Implementation of deltas between v3.5.1 and v3.3.1
Hide whitespace changes
Inline Side-by-side
SOL005/NSLCMCoord-API/NSLCMCoord.robot
+ 88
− 45
View file @ 6249ded4
*** Settings ***
Documentation This Clause defines the "cancel" operation related to an individual coordination action for the NS LCM Coordination interface
Documentation This Clause defines all the resources and methods provided by the NS LCM coordination interface.
Library JSONSchemaLibrary schemas/
Resource environment/variables.txt # Generic Parameters
Resource NSLCMCoordKeywords.robot
......@@ -8,94 +8,137 @@ Library REST ${NFVO_SCHEMA}://${NFVO_HOST}:${NFVO_PORT} ssl_veri
Library OperatingSystem
*** Test Cases ***
Request a cancellation of an ongoing coordination action
Request a Coordination of an LCM operation occurrence synchronously
[Documentation] # Test ID: 5.3.1.1.11
... Test title: Request a cancellation of an ongoing coordination action
... Test objective: The objective is to test the request for teh cancellation of an ongoing coordination task
... Pre-conditions: An ongoing coordination action is available
... Reference: Clause 12.4.4.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Test title: Request a Coordination of an LCM operation occurrence synchronously
... Test objective: The objective is to test the synchronous request for the coordination of an LCM operation occurrence and perform the JSON schema validation of the returned structure
... Pre-conditions: none
... Reference: Clause 12.4.2.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: A Individual coordination action resource is successfully created on the NFVO
Send Post Request for coordination of an LCM operation occurrence
Check HTTP Response Status Code Is 201
Check HTTP Response Header Contains Location
Check HTTP Response Body Json Schema Is LcmCoord
Check Postcondition LcmCoord Exists
Request a Coordination of an LCM operation occurrence asynchronously
[Documentation] # Test ID: 5.3.1.1.11
... Test title: Request a Coordination of an LCM operation occurrence asynchronously
... Test objective: The objective is to test the asynchronous request for the coordination of an LCM operation occurrence and perform the validation of the headers returned
... Pre-conditions: none
... Reference: Clause 12.4.2.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
Send Post Request for cancellation of an ongoing coordination action
... Post-Conditions: none
Send Post Request for coordination of an LCM operation occurrence
Check HTTP Response Status Code Is 202
Check HTTP Response Header Contains Location
Request a cancellation of a finished coordination action
Request a Coordination of an LCM operation occurrence - CONFLICT # TO BE COMPLETED
[Documentation] # Test ID: 5.3.1.1.11
... Test title: Request a cancellation of aterminated coordination action
... Test objective: The objective is to test the request for the cancellation of a finished coordination action
... Pre-conditions: A finished coordination action is available
... Reference: Clause 12.4.4.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Test title: Request a Coordination of an LCM operation occurrence synchronously ...
... Test objective: The objective is to test the failure of a request for the coordination of an LCM operation occurrence ...
... Pre-conditions: none
... Reference: Clause 12.4.2.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
Send Post Request for cancellation of a finished coordination action
... Post-Conditions: none
Send Post Request for coordination of an LCM operation occurrence - conflict
Check HTTP Response Status Code Is 409
Check HTTP Response Body Json Schema Is ProblemDetails
Request a Coordination of an LCM operation occurrence synchronously - Service Unavailable # TO BE COMPLETED
[Documentation] # Test ID: 5.3.1.1.11
... Test title: Request a Coordination of an LCM operation occurrence synchronously with the NFVO that is not able to perform the request immediately
... Test objective: The objective is to test the request for the coordination of an LCM operation occurrence and the verify that the NFVO cannot perform immediately teh request, but can perform it sometime in the future.
... Pre-conditions: none
... Reference: Clause 12.4.2.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
Send Post Request for coordination of an LCM operation occurrence synchronously - service unavailable
Check HTTP Response Status Code Is 503
Check HTTP Response Header Contains Retry-After
Request a cancellation of an ongoing coordination action without authentication
Request a Coordination of an LCM operation occurrence without authentication
[Documentation] # Test ID: 5.3.1.1.11
... Test title: Reques a cancellation of an ongoing coordination action without using authentication
... Test objective: The objective is to test the failure of the request for a cancellation of a coordination task when no authentication is used
... Test title: Reques a Coordination of an LCM operation occurrence without using authentication
... Test objective: The objective is to test teh failure of the request for the coordination of an LCM operation occurrence without providing an authentication token
... Pre-conditions: none
... Reference: Clause 12.4.4.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Reference: Clause 12.4.2.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
Send Post Request for cancellation of an ongoing coordination action without authorization token
Send Post Request for coordination of an LCM operation occurrence without authorization token
Check HTTP Response Status Code Is 401
GET information about a cancellation of an ongoing coordination action - method not implemented
Request a Coordination of an LCM operation occurrence with malformed request
[Documentation] # Test ID: 5.3.1.1.11
... Test title: Reques a Coordination of an LCM operation occurrence with malformed request
... Test objective: The objective is to test the failure of the request for the coordination of an LCM operation occurrence providing a malformed LcmCoordRequest body
... Pre-conditions: none
... Reference: Clause 12.4.2.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
Send Post Request for coordination of an LCM operation occurrence with malformed request
Check HTTP Response Status Code Is 400
Check HTTP Response Body Json Schema Is ProblemDetails
GET all Coordinations of an LCM operation occurrence - method not implemented
[Documentation] # Test ID: 5.3.1.1.1
... Test title: GET information about a cancellation of an ongoing coordination action
... Test objective: The objective is to test that the GET method is not allowed to retrieve cancellation details of an ongoing coordination action
... Pre-conditions: A cancellation task has been activated
... Reference: Clause 12.4.4.3.2 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Test title: GET all Coordinations of an LCM operation occurrence
... Test objective: The objective is to test that the GET method is not allowed to retrieve coordination requests information
... Pre-conditions: One or more LCM Coordinations have been requested
... Reference: Clause 12.4.2.3.2 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
GET information about a cancellation of an ongoing coordination action
GET all Coordinations of an LCM operation occurrence
Check HTTP Response Status Code Is 405
PUT information about a cancellation of an ongoing coordination action - method not implemented
PUT all Coordinations of an LCM operation occurrence - method not implemented
[Documentation] # Test ID: 5.3.1.1.1
... Test title: PUT information about a cancellation of an ongoing coordination action
... Test objective: The objective is to test that the PUT method is not allowed to modify cancellation details of an ongoing coordination action
... Pre-conditions: A cancellation task has been activated
... Reference: Clause 12.4.4.3.3 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Test title: PUT all Coordinations of an LCM operation occurrence
... Test objective: The objective is to test that the PUT method is not allowed to modify coordination requests information
... Pre-conditions: One or more LCM Coordinations have been requested
... Reference: Clause 12.4.2.3.3 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
PUT information about a cancellation of an ongoing coordination action
PUT all Coordinations of an LCM operation occurrence
Check HTTP Response Status Code Is 405
PATCH information about a cancellation of an ongoing coordination action - method not implemented
PATCH all Coordinations of an LCM operation occurrence - method not implemented
[Documentation] # Test ID: 5.3.1.1.1
... Test title: PATCH information about a cancellation of an ongoing coordination action
... Test objective: he objective is to test that the PATCH method is not allowed to modify cancellation details of an ongoing coordination action
... Pre-conditions: A cancellation task has been activated
... Reference: Clause 12.4.4.3.4 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Test title: PATCH all Coordinations of an LCM operation occurrence
... Test objective: The objective is to test that the PATCH method is not allowed to modify coordination requests information
... Pre-conditions: One or more LCM Coordinations have been requested
... Reference: Clause 12.4.2.3.4 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
PATCH information about a cancellation of an ongoing coordination action
PATCH all Coordinations of an LCM operation occurrence
Check HTTP Response Status Code Is 405
DELETE information about a cancellation of an ongoing coordination action - method not implemented
DELETE all Coordinations of an LCM operation occurrence - method not implemented
[Documentation] # Test ID: 5.3.1.1.1
... Test title: DELETE information about a cancellation of an ongoing coordination action
... Test objective: The objective is to test that the DELETE method is not allowed to remove cancellation details of an ongoing coordination action
... Pre-conditions: A cancellation task has been activated
... Reference: Clause 12.4.4.3.5 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Test title: DELETE all Coordinations of an LCM operation occurrence
... Test objective: The objective is to test that the DELETE method is not allowed to remove coordination requests information
... Pre-conditions: One or more LCM Coordinations have been requested
... Reference: Clause 12.4.2.3.5 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
DELETE information about a cancellation of an ongoing coordination action
DELETE all Coordinations of an LCM operation occurrence
Check HTTP Response Status Code Is 405
\ No newline at end of file
SOL005/NSLCMCoord-API/NSLCMCoordCancelTask.robot
+ 45
− 88
View file @ 6249ded4
*** Settings ***
Documentation This Clause defines all the resources and methods provided by the NS LCM coordination interface.
Documentation This Clause defines the "cancel" operation related to an individual coordination action for the NS LCM Coordination interface
Library JSONSchemaLibrary schemas/
Resource environment/variables.txt # Generic Parameters
Resource NSLCMCoordKeywords.robot
......@@ -8,137 +8,94 @@ Library REST ${NFVO_SCHEMA}://${NFVO_HOST}:${NFVO_PORT} ssl_veri
Library OperatingSystem
*** Test Cases ***
Request a Coordination of an LCM operation occurrence synchronously
Request a cancellation of an ongoing coordination action
[Documentation] # Test ID: 5.3.1.1.11
... Test title: Request a Coordination of an LCM operation occurrence synchronously
... Test objective: The objective is to test the synchronous request for the coordination of an LCM operation occurrence and perform the JSON schema validation of the returned structure
... Pre-conditions: none
... Reference: Clause 12.4.2.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: A Individual coordination action resource is successfully created on the NFVO
Send Post Request for coordination of an LCM operation occurrence
Check HTTP Response Status Code Is 201
Check HTTP Response Header Contains Location
Check HTTP Response Body Json Schema Is LcmCoord
Check Postcondition LcmCoord Exists
Request a Coordination of an LCM operation occurrence asynchronously
[Documentation] # Test ID: 5.3.1.1.11
... Test title: Request a Coordination of an LCM operation occurrence asynchronously
... Test objective: The objective is to test the asynchronous request for the coordination of an LCM operation occurrence and perform the validation of the headers returned
... Pre-conditions: none
... Reference: Clause 12.4.2.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Test title: Request a cancellation of an ongoing coordination action
... Test objective: The objective is to test the request for teh cancellation of an ongoing coordination task
... Pre-conditions: An ongoing coordination action is available
... Reference: Clause 12.4.4.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
Send Post Request for coordination of an LCM operation occurrence
... Post-Conditions: none
Send Post Request for cancellation of an ongoing coordination action
Check HTTP Response Status Code Is 202
Check HTTP Response Header Contains Location
Request a Coordination of an LCM operation occurrence - CONFLICT # TO BE COMPLETED
Request a cancellation of a finished coordination action
[Documentation] # Test ID: 5.3.1.1.11
... Test title: Request a Coordination of an LCM operation occurrence synchronously ...
... Test objective: The objective is to test the failure of a request for the coordination of an LCM operation occurrence ...
... Pre-conditions: none
... Reference: Clause 12.4.2.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Test title: Request a cancellation of aterminated coordination action
... Test objective: The objective is to test the request for the cancellation of a finished coordination action
... Pre-conditions: A finished coordination action is available
... Reference: Clause 12.4.4.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
Send Post Request for coordination of an LCM operation occurrence - conflict
... Post-Conditions: none
Send Post Request for cancellation of a finished coordination action
Check HTTP Response Status Code Is 409
Check HTTP Response Body Json Schema Is ProblemDetails
Request a Coordination of an LCM operation occurrence synchronously - Service Unavailable # TO BE COMPLETED
[Documentation] # Test ID: 5.3.1.1.11
... Test title: Request a Coordination of an LCM operation occurrence synchronously with the NFVO that is not able to perform the request immediately
... Test objective: The objective is to test the request for the coordination of an LCM operation occurrence and the verify that the NFVO cannot perform immediately teh request, but can perform it sometime in the future.
... Pre-conditions: none
... Reference: Clause 12.4.2.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
Send Post Request for coordination of an LCM operation occurrence synchronously - service unavailable
Check HTTP Response Status Code Is 503
Check HTTP Response Header Contains Retry-After
Request a Coordination of an LCM operation occurrence without authentication
Request a cancellation of an ongoing coordination action without authentication
[Documentation] # Test ID: 5.3.1.1.11
... Test title: Reques a Coordination of an LCM operation occurrence without using authentication
... Test objective: The objective is to test teh failure of the request for the coordination of an LCM operation occurrence without providing an authentication token
... Test title: Reques a cancellation of an ongoing coordination action without using authentication
... Test objective: The objective is to test the failure of the request for a cancellation of a coordination task when no authentication is used
... Pre-conditions: none
... Reference: Clause 12.4.2.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Reference: Clause 12.4.4.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
Send Post Request for coordination of an LCM operation occurrence without authorization token
Send Post Request for cancellation of an ongoing coordination action without authorization token
Check HTTP Response Status Code Is 401
Request a Coordination of an LCM operation occurrence with malformed request
[Documentation] # Test ID: 5.3.1.1.11
... Test title: Reques a Coordination of an LCM operation occurrence with malformed request
... Test objective: The objective is to test the failure of the request for the coordination of an LCM operation occurrence providing a malformed LcmCoordRequest body
... Pre-conditions: none
... Reference: Clause 12.4.2.3.1 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
Send Post Request for coordination of an LCM operation occurrence with malformed request
Check HTTP Response Status Code Is 400
Check HTTP Response Body Json Schema Is ProblemDetails
GET all Coordinations of an LCM operation occurrence - method not implemented
GET information about a cancellation of an ongoing coordination action - method not implemented
[Documentation] # Test ID: 5.3.1.1.1
... Test title: GET all Coordinations of an LCM operation occurrence
... Test objective: The objective is to test that the GET method is not allowed to retrieve coordination requests information
... Pre-conditions: One or more LCM Coordinations have been requested
... Reference: Clause 12.4.2.3.2 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Test title: GET information about a cancellation of an ongoing coordination action
... Test objective: The objective is to test that the GET method is not allowed to retrieve cancellation details of an ongoing coordination action
... Pre-conditions: A cancellation task has been activated
... Reference: Clause 12.4.4.3.2 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
GET all Coordinations of an LCM operation occurrence
GET information about a cancellation of an ongoing coordination action
Check HTTP Response Status Code Is 405
PUT all Coordinations of an LCM operation occurrence - method not implemented
PUT information about a cancellation of an ongoing coordination action - method not implemented
[Documentation] # Test ID: 5.3.1.1.1
... Test title: PUT all Coordinations of an LCM operation occurrence
... Test objective: The objective is to test that the PUT method is not allowed to modify coordination requests information
... Pre-conditions: One or more LCM Coordinations have been requested
... Reference: Clause 12.4.2.3.3 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Test title: PUT information about a cancellation of an ongoing coordination action
... Test objective: The objective is to test that the PUT method is not allowed to modify cancellation details of an ongoing coordination action
... Pre-conditions: A cancellation task has been activated
... Reference: Clause 12.4.4.3.3 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
PUT all Coordinations of an LCM operation occurrence
PUT information about a cancellation of an ongoing coordination action
Check HTTP Response Status Code Is 405
PATCH all Coordinations of an LCM operation occurrence - method not implemented
PATCH information about a cancellation of an ongoing coordination action - method not implemented
[Documentation] # Test ID: 5.3.1.1.1
... Test title: PATCH all Coordinations of an LCM operation occurrence
... Test objective: The objective is to test that the PATCH method is not allowed to modify coordination requests information
... Pre-conditions: One or more LCM Coordinations have been requested
... Reference: Clause 12.4.2.3.4 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Test title: PATCH information about a cancellation of an ongoing coordination action
... Test objective: he objective is to test that the PATCH method is not allowed to modify cancellation details of an ongoing coordination action
... Pre-conditions: A cancellation task has been activated
... Reference: Clause 12.4.4.3.4 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
PATCH all Coordinations of an LCM operation occurrence
PATCH information about a cancellation of an ongoing coordination action
Check HTTP Response Status Code Is 405
DELETE all Coordinations of an LCM operation occurrence - method not implemented
DELETE information about a cancellation of an ongoing coordination action - method not implemented
[Documentation] # Test ID: 5.3.1.1.1
... Test title: DELETE all Coordinations of an LCM operation occurrence
... Test objective: The objective is to test that the DELETE method is not allowed to remove coordination requests information
... Pre-conditions: One or more LCM Coordinations have been requested
... Reference: Clause 12.4.2.3.5 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Test title: DELETE information about a cancellation of an ongoing coordination action
... Test objective: The objective is to test that the DELETE method is not allowed to remove cancellation details of an ongoing coordination action
... Pre-conditions: A cancellation task has been activated
... Reference: Clause 12.4.4.3.5 - ETSI GS NFV-SOL 005 [3] v3.5.1
... Config ID: Config_prod_NFVO
... Applicability: none
... Post-Conditions: none
DELETE all Coordinations of an LCM operation occurrence
DELETE information about a cancellation of an ongoing coordination action
Check HTTP Response Status Code Is 405
\ No newline at end of file
SOL005/NSLCMCoord-API/jsons/createLcmCoordRequest.json
+ 15
− 1
View file @ 6249ded4
{}
\ No newline at end of file
{
"nsInstanceId": "string",
"nsLcmOpOccId": "string",
"lcmOperationType": "INSTANTIATE",
"coordinationActionName": "string",
"inputParams": {},
"_links": {
"nsLcmOpOcc": {
"href": "string"
},
"nsInstance": {
"href": "string"
}
}
}
\ No newline at end of file
SOL005/NSLCMCoord-API/jsons/createLcmCoordRequestMalformed.json 0 → 100644
+ 15
− 0
View file @ 6249ded4
{
"nsInstance": "string",
"nsLcmOpOccId": "string",
"lcmOperationType": "INSTANTIATE",
"coordinationActionName": "string",
"inputParams": {},
"_links": {
"nsLcmOpOcc": {
"href": "string"
},
"nsInstance": {
"href": "string"
}
}
}
\ No newline at end of file
SOL005/NSLCMCoord-API/schemas/LcmCoord.schema.json
+ 143
− 0
View file @ 6249ded4
{
"description": "This type represents an LCM coordination result. It shall comply with the provisions \ndefined in table 12.5.2.3-1.\n\nNOTE: How to determine the supported coordination actions is outside the scope of the \n present version of this document.\n",
"required": [
"id",
"coordinationResult",
"nsInstanceId",
"nsLcmOpOccId",
"lcmOperationType",
"coordinationActionName",
"_links"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"coordinationResult": {
"description": "The enumeration LcmCoordResultType defines the permitted values to represent the result \nof executing an LCM coordination action. The coordination result also implies the action \nto be performed by the NFVO as the follow-up to this coordination. The LcmCoordResultType \nshall comply with the provisions defined in table 12.5.4.3.-1.\n\n- CONTINUE: The related LCM operation shall be continued, staying in the state \"PROCESSING\".\n- ABORT: The related LCM operation shall be aborted by transitioning into the state \"FAILED_TEMP\".\n- CANCELLED: The coordination action has been cancelled upon request of the API consumer, \n i.e. the NFVO. The related LCM operation shall be aborted by transitioning into \n the state \"FAILED_TEMP\".\n",
"type": "string",
"enum": [
"CONTINUE",
"ABORT",
"CACELLED"
]
},
"nsInstanceId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"nsLcmOpOccId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"lcmOperationType": {
"description": "The enumeration LcmOperationForCoordType defines the permitted values to represent \nNS lifecycle operation types in NS LCM operation coordination actions. \nIt shall comply with the provisions defined in table 12.5.4.3-1.\n\n- INSTANTIATE: Represents the \"Instantiate NS\" LCM operation.\n- SCALE: Represents the \"Scale NS\" LCM operation.\n- UPDATE: Represents the \"Update NS\" LCM operation.\n- TERMINATE: Represents the \"Terminate NS\" LCM operation. \n- HEAL: Represents the \"Heal NS\" LCM operation.\n",
"type": "string",
"enum": [
"INSTANTIATE",
"SCALE",
"UPDATE",
"TERMINATE",
"HEAL"
]
},
"coordinationActionName": {
"description": "A string as defined in IETF RFC 8259.\n",
"type": "string"
},
"outputParams": {
"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"
},
"warnings": {
"description": "A string as defined in IETF RFC 8259.\n",
"type": "string"
},
"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"
}
}
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self",
"nsLcmOpOcc",
"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"
}
}
},
"nsLcmOpOcc": {
"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"
}
}
}
}
}
}
}
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment