Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
== Model /Users/philip-iii/Dev/git/etsi-labs/ide/plugins/org.etsi.mts.tdl.standalone/examples/openapi/ExampleAPI.yaml
# Generated Documentation
## Requirements
### API: Examples for RESTful API guide
| Identifier | Reference | Type | Applicability | Requirement | Context |
| ---------- | ---------- | ---- | ------------- | ------------ | ------- |
| RQ_RESOURCE_ID_GET_001 | Path: /resource/{id} | M | RESOURCE_ID | Read a resource; Read full contents of a resource with specific ID | getResource |
| RQ_RESOURCE_POST_001 | Path: /resource | M | RESOURCE | Create new resource; | postResource |
| RQ_RESOURCE_ID_FILE_PUT_001 | Path: /resource/{id}/file | M | RESOURCE_ID_FILE | Upload a file for a resource; | uploadResourceFile |
| RQ_SEARCH_GET_001 | Path: /search | M | SEARCH | Search resource; | searchResource |
| RQ_SUBSCRIPTION_POST_001 | Path: /subscription | M | SUBSCRIPTION | Subscribe to authenticated notifications; | subscribeNotifications |
| RQ_SERVICE_GET_001 | Path: /service | M | SERVICE | | getService |
[Table X.Y: Extracted requirements]{custom-style="FL"}
## Implementation Conformance Statements
#### Detail
| ID | Resource | Reference | Method | Type | Request | Response |
| -- | --------- | --------- | ------ | ----- | ------- | -------- |
| D_RESOURCE_ID_GET_200_001 | /resource/{id} | Path: /resource/{id} : getResource | GET | M | (fill in request) | 200 |
| D_RESOURCE_ID_GET_401_002 | /resource/{id} | Path: /resource/{id} : getResource | GET | M | (fill in request) | 401 |
| D_RESOURCE_ID_GET_404_003 | /resource/{id} | Path: /resource/{id} : getResource | GET | M | (fill in request) | 404 |
| D_RESOURCE_POST_204_001 | /resource | Path: /resource : postResource | POST | M | (fill in request) | 204 |
| D_RESOURCE_ID_FILE_PUT_204_001 | /resource/{id}/file | Path: /resource/{id}/file : uploadResourceFile | PUT | M | (fill in request) | 204 |
| D_SEARCH_GET_200_001 | /search | Path: /search : searchResource | GET | M | (fill in request) | 200 |
| D_SUBSCRIPTION_POST_201_001 | /subscription | Path: /subscription : subscribeNotifications | POST | M | (fill in request) | 201 |
| D_SERVICE_GET_200_001 | /service | Path: /service : getService | GET | M | (fill in request) | 200 |
[Table X.Y: Extracted ICS (Detail)]{custom-style="FL"}
#### Method
| ID | Resource | Reference | Method | Type | Request | Response |
| -- | --------- | --------- | ------ | ----- | ------- | -------- |
| M1 | /resource/{id} | Path: /resource/{id} : getResource | GET | M | (fill in request) | 200,401,404 |
| M2 | /resource | Path: /resource : postResource | POST | M | (fill in request) | 204 |
| M3 | /resource/{id}/file | Path: /resource/{id}/file : uploadResourceFile | PUT | M | (fill in request) | 204 |
| M4 | /search | Path: /search : searchResource | GET | M | (fill in request) | 200 |
| M5 | /subscription | Path: /subscription : subscribeNotifications | POST | M | (fill in request) | 201 |
| M6 | /service | Path: /service : getService | GET | M | (fill in request) | 200 |
[Table X.Y: Extracted ICS (Method)]{custom-style="FL"}
#### Path
| ID | Resource | Reference | Method | Type | Request | Response |
| -- | --------- | --------- | ------ | ----- | ------- | -------- |
| P1 | /resource/{id} | Path: /resource/{id} : getResource | GET | M | (fill in request) | 200,401,404 |
| P2 | /resource | Path: /resource : postResource | POST | M | (fill in request) | 204 |
| P3 | /resource/{id}/file | Path: /resource/{id}/file : uploadResourceFile | PUT | M | (fill in request) | 204 |
| P4 | /search | Path: /search : searchResource | GET | M | (fill in request) | 200 |
| P5 | /subscription | Path: /subscription : subscribeNotifications | POST | M | (fill in request) | 201 |
| P6 | /service | Path: /service : getService | GET | M | (fill in request) | 200 |
[Table X.Y: Extracted ICS (Path)]{custom-style="FL"}
#### Hierarchical
| ID | Resource | Reference | Method | Type | Request | Response |
| -- | --------- | --------- | ------ | ----- | ------- | -------- |
| P1 | /resource/{id} | Path: /resource/{id} : getResource | GET | M | (fill in request) | 200,401,404 |
| P1_M1 | /resource/{id} | Path: /resource/{id} : getResource | GET | M | (fill in request) | 200,401,404 |
| P1_M1_R1 | /resource/{id} | Path: /resource/{id} : getResource | GET | M | (fill in request) | 200 |
| P1_M1_R2 | /resource/{id} | Path: /resource/{id} : getResource | GET | M | (fill in request) | 401 |
| P1_M1_R3 | /resource/{id} | Path: /resource/{id} : getResource | GET | M | (fill in request) | 404 |
| P2 | /resource | Path: /resource : postResource | POST | M | (fill in request) | 204 |
| P2_M1 | /resource | Path: /resource : postResource | POST | M | (fill in request) | 204 |
| P2_M1_R1 | /resource | Path: /resource : postResource | POST | M | (fill in request) | 204 |
| P3 | /resource/{id}/file | Path: /resource/{id}/file : uploadResourceFile | PUT | M | (fill in request) | 204 |
| P3_M1 | /resource/{id}/file | Path: /resource/{id}/file : uploadResourceFile | PUT | M | (fill in request) | 204 |
| P3_M1_R1 | /resource/{id}/file | Path: /resource/{id}/file : uploadResourceFile | PUT | M | (fill in request) | 204 |
| P4 | /search | Path: /search : searchResource | GET | M | (fill in request) | 200 |
| P4_M1 | /search | Path: /search : searchResource | GET | M | (fill in request) | 200 |
| P4_M1_R1 | /search | Path: /search : searchResource | GET | M | (fill in request) | 200 |
| P5 | /subscription | Path: /subscription : subscribeNotifications | POST | M | (fill in request) | 201 |
| P5_M1 | /subscription | Path: /subscription : subscribeNotifications | POST | M | (fill in request) | 201 |
| P5_M1_R1 | /subscription | Path: /subscription : subscribeNotifications | POST | M | (fill in request) | 201 |
| P6 | /service | Path: /service : getService | GET | M | (fill in request) | 200 |
| P6_M1 | /service | Path: /service : getService | GET | M | (fill in request) | 200 |
| P6_M1_R1 | /service | Path: /service : getService | GET | M | (fill in request) | 200 |
[Table X.Y: Extracted ICS (Hierarchical)]{custom-style="FL"}
## Test Suite Structure
* API: Examples for RESTful API guide
* RESOURCE_ID
* GET
* GET_200
* GET_401
* GET_404
* RESOURCE
* POST
* POST_204
* RESOURCE_ID_FILE
* PUT
* PUT_204
* SEARCH
* GET
* GET_200
* SUBSCRIPTION
* POST
* POST_201
* SERVICE
* GET
* GET_200
------