8 REST SS specification template
32.1583GPPDesign rules for REpresentational State Transfer (REST) Solution Sets (SS)Management and orchestrationRelease 17TS
This clause contains the REST SS specification template.
W RESTful HTTP-based solution set
W.1 Mapping of operations
W.1.1 Introduction
The IS operations are mapped to SS equivalents according to table W.1.1-1.
Table W.1.1-1: Mapping of IS operations to SS equivalents
|
IS operation |
HTTP Method |
Resource URI |
S |
W.1.2 Operation <operation 1>
The IS operation parameters are mapped to SS equivalents according to table W.1.2-1 and table W.1.2-2.
Table W.1.2-1: Mapping of IS operation input parameters to SS equivalents (<HTTP method>)
|
IS parameter name |
SS parameter location |
SS parameter name |
SS parameter type |
S |
Table W.1.2-2: Mapping of IS operation output parameters to SS equivalents (<HTTP method>)
|
IS parameter name |
SS parameter location |
SS parameter name |
SS parameter type |
S |
W.1.3 Operation <operation 2>
Same as for <operation 1>.
W.2 Mapping of notifications
W.2.1 Introduction
The IS notifications are mapped to SS equivalents according to table W.2.1-1.
Table W.2.1-1: Mapping of IS operations to SS equivalents
|
IS notification |
HTTP Method |
Resource URI |
S |
W.2.2 Notification <notification 1>
The IS notification parameters are mapped to SS equivalents according to table W.2.2-1.
Table W.2.2-1: Mapping of IS notification parameters to SS equivalents
|
IS parameter name |
SS parameter location |
SS parameter name |
SS parameter type |
S |
W.2.3 Notification <notification 2>
Same as for <notification 1>.
W.3 Usage of HTTP
W.4 Resources
W.4.1 Resource structure
W.4.1.1 Resource structure on the MnS producer
Figure W.4.1.1-1 shows the resource structure of the <XYZ> MnS on the MnS producer.
<Figure>
Figure W.4.1.1-1: Resource URI structure of the <XYZ> MnS on the MnS producer
Table W.4.1.1-1 provides an overview of the resources and applicable HTTP methods.
Table W.4.1.1-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method |
Description |
W.4.1.2 Resource structure on the MnS consumer
Figure W.4.1.2-1 shows the resource structure of the <XYZ> MnS on the MnS consumer.
<Figure>
Figure W.4.1.2-1: Resource URI structure of the <XYZ> MnS on the MnS consumer
Table W.4.1.2-1 provides an overview of the resources and applicable HTTP methods.
Table W.4.1.2-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method |
Description |
W.4.2 Resource definitions
W.4.2.1 Resource <resource 1>
W.4.2.1.1 Description
Description of the resource.
W.4.2.1.2 URI
Resource URI: <URI>
The resource URI variables are defined in table W.4.2.1.2-1.
Table W.4.2.1.2-1: URI variables
|
Name |
Definition |
W.4.2.1.3 HTTP methods
W.4.2.1.3.1 <method 1>
This method shall support the URI query parameters specified in table W.2.1.3.1-1.
Table W.2.1.3.1-1: URI query parameters supported by the <method 1> on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
This method shall support the request data structures specified in table W.2.1.3.1-2 and the response data structures and response codes specified in table W.2.1.3.1-3.
Table W.2.1.3.1-2: Data structures supported by the <method 1> request body on this resource
|
Data type |
P |
Cardinality |
Description |
Table W.2.1.3.1-3: Data structures supported by the <method 1> response body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
W.4.2.1.3.2 <method 2>
Same as for <method 1>.
W.4.2.2 Resource <resource 2>
Same as for <resource 1>.
W.5 Data type definitions
W.5.1 General
This clause defines the data types used by the <XYZ> MnS. Table W.4.1-1 specifies the data types defined in the present document and table W.4.1-2 the data types imported
Table W.4.1-1: Data types defined in the present document
|
Data type |
Reference |
Description |
Table W.4.1-2: Data types imported
|
Data type |
Reference |
Description |
W.5.2 Structured data types
W.5.2.1 Type <TypeName 1>
Table W.4.2.1-1: Definition of type <TypeName 1>
|
Attribute name |
Data type |
P |
Cardinality |
Description |
W.5.2.2 Type <TypeName 2>
Same as for <TypeName 1>.
W.5.3 Simple data types and enumerations
W.5.3.1 General
This clause defines simple data types and enumerations that are used by the data structures defined in the previous clauses.
W.5.3.2 Simple data types
Table W.5.3.2-1: Simple data types
|
Type Name |
Type Definition |
Description |
W.5.3.3 Enumeration <EnumType1>
Table W.5.3.3-1: Enumeration < EnumType1>
|
Enumeration value |
Description |
W.5.3.4 Enumeration <EnumType2>
Annex A (normative)
OpenAPI definition
A.1 Introduction
This clause contains the OpenAPI definition of the <XYZ> MnS in YAML format.
A.2 OpenAPI document "<ABC>.yaml"
OpenAPI definition
Annex A (informative):
Examples