forked from EasyDynamics/oscal-rest
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
2946 lines (2930 loc) · 86.4 KB
/
openapi.yaml
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
openapi: 3.0.1
info:
title: OSCAL REST
description: |
A draft proposal from [Easy Dynamics](https://www.easydynamics.com) of a REST API specification for interacting
with [OSCAL](https://pages.nist.gov/OSCAL/) models.
Standardized data models like OSCAL lay the groundwork for interoperability of systems, and an ecosystem of
meaningful integrations can be brought to life through a standardized REST API. That interface needs to define
simple CRUD operations, but should also describe how to manipulate relationships and make partial changes.
Such an API will likely see the most success across various vendors and projects when maintained by a
standards body or community, and we're looking to get that conversation started with this effort.
## Identifier Scope
Note that all object identifiers are **scoped to the system** implementing the REST API
and are expected to be unique.
<details>
<summary>Example</summary>
To associate a Party with a known Component Definition with a UUID you might:
1. Search for the Party:
```
GET /parties/search?query=bob
```
```
[
{
"uuid": "d834ed5e-9652-4b78-87e7-a9f8686f4e60",
"type": "person",
"name": "Bob Johnson"
}
]
```
2. Use the found Party's ID to associate with the component definition:
```
PUT /component-definitions/599b6fa5-3e18-4580-bd8f-8a181776c6e8/parties/d834ed5e-9652-4b78-87e7-a9f8686f4e60
```
</details>
## Partial Payloads in PATCH Requests
A `PATCH` should be used when an existing object needs a partial modification. It accepts a partial
payload with the updated fields and corresponding field names, then modifies the specified
fields accordingly. Additionally, it is solely additive when updating lists and will not replace
existing list items. In most cases, a `PATCH` is more convenient than a `PUT`, which only accepts
a full payload to completely replace the existing object with new updates.
All updates to 'root' OSCAL objects via `PATCH` requests should accept a partial payload containing
only the changed data and the entire updated object should be returned.
The UUID of the root object must not change in the payload and implementations should throw an error
if such a request is made.
<details>
<summary>Example</summary>
Example request:
```
PATCH /system-security-plans/cff8385f-108e-40a5-8f7a-82f3dc0eaba8
{
"system-security-plan": {
"uuid": "cff8385f-108e-40a5-8f7a-82f3dc0eaba8",
"metadata": {
"title": "Some New Title"
"revisions": [
{ "version": "220220517" }
]
}
}
}
```
In this example, the title is being updated and the version is being added to the list of
revisions. No other changes are being made to the original metadata object, so the rest of its
fields will remain the same. The list of revisions will still contain its previous items,
along with the new version item.
</details>
For guidance on handling UUIDs in `POST` and `PUT` operations, please review
[handling-uuids-on-post-put.md](https://github.com/EasyDynamics/oscal-rest/blob/develop/docs/handling-uuids-on-post-put.md).
contact:
email: [email protected]
version: 0.1.0
externalDocs:
description: Find out more about OSCAL
url: https://pages.nist.gov/OSCAL
servers:
- url: http://localhost:8080/oscal/v1
tags:
- name: OSCAL Component Definition
externalDocs:
description: Find out more
url: https://pages.nist.gov/OSCAL/concepts/layer/implementation/component-definition/
- name: OSCAL Profile
externalDocs:
description: Find out more
url: https://pages.nist.gov/OSCAL/concepts/layer/control/profile/
- name: OSCAL System Security Plan
externalDocs:
description: Find out more
url: https://pages.nist.gov/OSCAL/concepts/layer/implementation/ssp/
- name: OSCAL Catalog
externalDocs:
description: Find out more
url: https://pages.nist.gov/OSCAL/concepts/layer/control/catalog/
- name: OSCAL Party
externalDocs:
description: Find out more
url: https://pages.nist.gov/OSCAL
- name: OSCAL Plan of Action and Milestones
externalDocs:
description: Find out more
url: https://pages.nist.gov/OSCAL/concepts/layer/assessment/poam/
- name: OSCAL Assessment Plan
externalDocs:
description: Find out more
url: https://pages.nist.gov/OSCAL/concepts/layer/assessment/assessment-plan/
- name: OSCAL Assessment Result
externalDocs:
description: Find out more
url: https://pages.nist.gov/OSCAL/concepts/layer/assessment/assessment-results/
paths:
/catalogs:
get:
tags:
- OSCAL Catalog
summary: Returns all OSCAL control catalogs
operationId: getCatalogs
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/OSCALCatalog"
security:
- oscal_auth:
- read:catalogs
post:
tags:
- OSCAL Catalog
summary: Adds a new OSCAL control catalog
operationId: addCatalog
requestBody:
description: OSCAL catalog object to be added
content:
application/json:
schema:
$ref: "#/components/schemas/OSCALCatalog"
multipart/form-data:
schema:
type: object
properties:
url:
type: string
format: binary
fileName:
type: string
format: binary
required: true
responses:
405:
description: Invalid input
content: {}
security:
- oscal_auth:
- write:catalogs
- read:catalogs
x-codegen-request-body-name: body
/catalogs/{catalogId}:
get:
tags:
- OSCAL Catalog
summary: Finds an OSCAL control catalog by ID
description: Returns a single OSCAL control catalog
operationId: getCatalogById
parameters:
- name: catalogId
in: path
description: ID of catalog to return
required: true
schema:
type: string
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/OSCALCatalog"
400:
description: Invalid ID supplied
content: {}
404:
description: Catalog not found
content: {}
security:
- oscal_auth:
- read:catalogs
patch:
tags:
- OSCAL Catalog
summary: Updates an existing OSCAL control catalog
operationId: updateCatalog
parameters:
- name: catalogId
in: path
description: ID of catalog to return
required: true
schema:
type: string
requestBody:
description: Catalog object to be updated
content:
application/json:
schema:
$ref: "#/components/schemas/OSCALCatalogUpdateExample"
required: true
responses:
400:
description: Invalid ID supplied
content: {}
404:
description: Catalog not found
content: {}
405:
description: Validation exception
content: {}
409:
description: Conflict with current state
security:
- oscal_auth:
- write:catalogs
- read:catalogs
x-codegen-request-body-name: body
put:
tags:
- OSCAL Catalog
summary: Replaces an existing OSCAL catalog
operationId: replaceCatalog
parameters:
- name: catalogId
in: path
description: ID of catalog to replace
schema:
type: string
requestBody:
description: Catalog object to be replaced
content:
application/json:
schema:
$ref: "#/components/schemas/OSCALCatalog"
required: true
responses:
200:
description: Updated catalog
content:
application/json:
schema:
$ref: "#/components/schemas/OSCALCatalog"
400:
description: Bad Request
404:
description: Catalog not found
409:
description: Conflict with current state
415:
description: Unsupported media type
security:
- oscal_auth:
- write:catalogs
- read:catalogs
x-codegen-request-body-name: body
delete:
tags:
- OSCAL Catalog
summary: Deletes an OSCAL control catalog
operationId: deleteCatalog
parameters:
- name: api_key
in: header
schema:
type: string
- name: catalogId
in: path
description: Catalog ID to delete
required: true
schema:
type: string
responses:
400:
description: Invalid ID supplied
content: {}
404:
description: Catalog not found
content: {}
security:
- oscal_auth:
- write:catalogs
- read:catalogs
/catalogs/search:
get:
tags:
- OSCAL Catalog
summary: Searches for OSCAL control catalogs by name
operationId: findCatalogsByName
parameters:
- name: query
in: query
description: Terms to search for in catalog names
required: true
schema:
type: string
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/OSCALCatalog"
400:
description: Invalid status value
content: {}
security:
- oscal_auth:
- read:catalogs
/profiles:
get:
tags:
- OSCAL Profile
summary: Returns all OSCAL profiles
operationId: getProfiles
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/OSCALProfile"
security:
- oscal_auth:
- read:profiles
patch:
tags:
- OSCAL Profile
summary: Updates an existing OSCAL profile
operationId: updateProfile
requestBody:
description: Catalog object to be updated
content:
application/json:
schema:
$ref: "#/components/schemas/OSCALProfileUpdateExample"
required: true
responses:
400:
description: Invalid ID supplied
content: {}
404:
description: Catalog not found
content: {}
405:
description: Validation exception
content: {}
409:
description: Conflict with current state
security:
- oscal_auth:
- write:profiles
- read:profiles
x-codegen-request-body-name: body
post:
tags:
- OSCAL Profile
summary: Adds a new OSCAL profile
operationId: addProfile
requestBody:
description: OSCAL profile to be added
content:
application/json:
schema:
$ref: "#/components/schemas/OSCALProfile"
required: true
responses:
405:
description: Invalid input
content: {}
security:
- oscal_auth:
- write:profiles
- read:profiles
x-codegen-request-body-name: body
/profiles/{profileId}:
get:
tags:
- OSCAL Profile
summary: Finds an OSCAL profile by ID
description: Returns a single OSCAL profile
operationId: getProfileById
parameters:
- name: profileId
in: path
description: ID of profile to return
required: true
schema:
type: string
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/OSCALProfile"
400:
description: Invalid ID supplied
content: {}
404:
description: Profile not found
content: {}
security:
- oscal_auth:
- read:profiles
put:
tags:
- OSCAL Profile
summary: Replaces an existing OSCAL profile
operationId: replaceProfile
parameters:
- name: profileId
in: path
description: ID of profile to replace
required: true
schema:
type: string
requestBody:
description: Profile object to be replaced
content:
application/json:
schema:
$ref: "#/components/schemas/OSCALProfile"
required: true
responses:
200:
description: Updated profile
content:
application/json:
schema:
$ref: "#/components/schemas/OSCALProfile"
400:
description: Bad Request
404:
description: Profile not found
409:
description: Conflict with current state
415:
description: Unsupported media type
security:
- oscal_auth:
- write:profiles
- read:profiles
x-codegen-request-body-name: body
delete:
tags:
- OSCAL Profile
summary: Deletes an OSCAL profile
operationId: deleteProfile
parameters:
- name: api_key
in: header
schema:
type: string
- name: profileId
in: path
description: Profile ID to delete
required: true
schema:
type: string
responses:
400:
description: Invalid ID supplied
content: {}
404:
description: Profile not found
content: {}
security:
- oscal_auth:
- write:profiles
- read:profiles
/profiles/{profileId}/imported-catalogs/{catalogId}:
put:
tags:
- OSCAL Profile
summary: Defines a catalog import in an OSCAL profile
operationId: addCatalogToProfile
parameters:
- name: api_key
in: header
schema:
type: string
- name: profileId
in: path
description: Profile ID
required: true
schema:
type: string
- name: catalogId
in: path
description: Catalog ID to be imported into the profile
required: true
schema:
type: string
requestBody:
description: Further description of the controls imported
content:
application/json:
schema:
type: object
properties:
include-controls:
type: array
items:
type: object
properties:
with-ids:
type: array
items:
type: string
required: false
responses:
400:
description: Invalid ID supplied
content: {}
404:
description: Profile or catalog not found
content: {}
409:
description: Conflict with current state
security:
- oscal_auth:
- write:profiles
- read:profiles
delete:
tags:
- OSCAL Profile
summary: Removes a catalog from an OSCAL profile imports
description: |
Removes the given catalog from the given profile.
This should also result in references under other parts of the schema being removed.
operationId: removeCatalogfromProfile
parameters:
- name: api_key
in: header
schema:
type: string
- name: profileId
in: path
description: Profile ID
required: true
schema:
type: string
- name: catalogId
in: path
description: Catalog ID to be removed from the profile imports
required: true
schema:
type: string
responses:
400:
description: Invalid ID supplied
content: {}
404:
description: Profile or catalog not found
content: {}
security:
- oscal_auth:
- write:profiles
- read:profiles
/profiles/{profileId}/imported-profiles/{importProfileId}:
put:
tags:
- OSCAL Profile
summary: Defines the import of another profile in an OSCAL profile
operationId: addProfileToProfile
parameters:
- name: api_key
in: header
schema:
type: string
- name: profileId
in: path
description: Profile ID
required: true
schema:
type: string
- name: importProfileId
in: path
description: Other profile ID to be defined as an import in the profile
required: true
schema:
type: string
requestBody:
description: Further description of the controls imported
content:
application/json:
schema:
type: object
properties:
include-controls:
type: array
items:
type: object
properties:
with-ids:
type: array
items:
type: string
required: false
responses:
400:
description: Invalid ID supplied
content: {}
404:
description: Profile or import profile not found
content: {}
409:
description: Conflict with current state
security:
- oscal_auth:
- write:profiles
- read:profiles
delete:
tags:
- OSCAL Profile
summary: Removes a another profile from an OSCAL profile imports
description: |
Removes the given other profile from the given profile.
This should also result in references under other parts of the schema being removed.
operationId: removeProfilefromProfile
parameters:
- name: api_key
in: header
schema:
type: string
- name: profileId
in: path
description: Profile ID
required: true
schema:
type: string
- name: importProfileId
in: path
description: Other profile ID to be removed from the profile imports
required: true
schema:
type: string
responses:
400:
description: Invalid ID supplied
content: {}
404:
description: Profile or import profile not found
content: {}
security:
- oscal_auth:
- write:profiles
- read:profiles
/profiles/{profileId}/roles:
post:
tags:
- OSCAL Profile
summary: Adds a new role to an OSCAL profile
operationId: addRoleToProfile
requestBody:
description: OSCAL role to be added
content:
application/json:
schema:
$ref: "#/components/schemas/OSCALRole"
required: true
parameters:
- name: api_key
in: header
schema:
type: string
- name: profileId
in: path
description: Profile ID
required: true
schema:
type: string
responses:
400:
description: Invalid ID supplied
content: {}
404:
description: Profile not found
content: {}
security:
- oscal_auth:
- write:profiles
- read:profiles
/profiles/{profileId}/roles/{roleId}:
delete:
tags:
- OSCAL Profile
summary: Removes a role from an OSCAL profile
description: |
Removes the given role from the given profile.
This should also result in references under other parts of the schema such as responsible parties being removed.
operationId: removeRolefromProfile
parameters:
- name: api_key
in: header
schema:
type: string
- name: profileId
in: path
description: Profile ID
required: true
schema:
type: string
- name: roleId
in: path
description: Role ID to be removed from the profile
required: true
schema:
type: string
responses:
400:
description: Invalid ID supplied
content: {}
404:
description: Profile or role not found
content: {}
security:
- oscal_auth:
- write:profiles
- read:profiles
/profiles/{profileId}/parties/{partyId}:
put:
tags:
- OSCAL Profile
summary: Associates a party with an OSCAL profile
operationId: addPartyToProfile
parameters:
- name: api_key
in: header
schema:
type: string
- name: profileId
in: path
description: Profile ID
required: true
schema:
type: string
- name: partyId
in: path
description: Party ID to be associated with the profile
required: true
schema:
type: string
responses:
400:
description: Invalid ID supplied
content: {}
404:
description: Profile or party not found
content: {}
409:
description: Conflict with current state
security:
- oscal_auth:
- write:profiles
- read:profiles
delete:
tags:
- OSCAL Profile
summary: Removes a party from an OSCAL profile
description: |
Removes the given party from the given profile.
This should also result in references under other parts of the schema such as responsible roles being removed.
operationId: removePartyfromProfile
parameters:
- name: api_key
in: header
schema:
type: string
- name: profileId
in: path
description: Profile ID
required: true
schema:
type: string
- name: partyId
in: path
description: Party ID to be removed with the profile
required: true
schema:
type: string
responses:
400:
description: Invalid ID supplied
content: {}
404:
description: Profile or party not found
content: {}
security:
- oscal_auth:
- write:profiles
- read:profiles
/profiles/{profileId}/responsible-parties/{roleId}/parties/{partyId}:
post:
tags:
- OSCAL Profile
summary: Associates a party with role within an OSCAL profile
operationId: addPartyToProfileRole
parameters:
- name: api_key
in: header
schema:
type: string
- name: profileId
in: path
description: Profile ID
required: true
schema:
type: string
- name: roleId
in: path
description: Role ID for the party to be associated with within the profile
required: true
schema:
type: string
- name: partyId
in: path
description: Party ID to be added to the role within the profile
required: true
schema:
type: string
responses:
400:
description: Invalid ID supplied
content: {}
404:
description: Profile, role, or party not found
content: {}
security:
- oscal_auth:
- write:profiles
- read:profiles
delete:
tags:
- OSCAL Profile
summary: Removes a party from a role within an OSCAL profile
operationId: removePartyfromProfileRole
parameters:
- name: api_key
in: header
schema:
type: string
- name: profileId
in: path
description: Profile ID
required: true
schema:
type: string
- name: roleId
in: path
description: Role ID within the profile that the party should be removed from
required: true
schema:
type: string
- name: partyId
in: path
description: Party ID to be removed from the role within the profile
required: true
schema:
type: string
responses:
400:
description: Invalid ID supplied
content: {}
404:
description: Profile, role, or party not found
content: {}
security:
- oscal_auth:
- write:profiles
- read:profiles
/profiles/search:
get:
tags:
- OSCAL Profile
summary: Searches for OSCAL profiles by name
operationId: findProfilesByName
parameters:
- name: query
in: query
description: Terms to search for in profile names
required: true
schema:
type: string
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/OSCALProfile"
400:
description: Invalid status value
content: {}
security:
- oscal_auth:
- read:profiles
/component-definitions:
get:
tags:
- OSCAL Component Definition
summary: Returns all OSCAL component definitions
operationId: getComponentDefinitions
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/OSCALComponentDefinition"
security:
- oscal_auth:
- read:componentDefinitions
post:
tags:
- OSCAL Component Definition
summary: Adds a new OSCAL component definition
operationId: addComponentDefinition
requestBody:
description: OSCAL component definition to be added
content:
application/json:
schema:
$ref: "#/components/schemas/OSCALComponentDefinition"
required: true
responses:
405:
description: Invalid input
content: {}
security:
- oscal_auth:
- write:componentDefinitions
- read:componentDefinitions
x-codegen-request-body-name: body
/component-definitions/{componentDefinitionId}:
get:
tags:
- OSCAL Component Definition
summary: Finds an OSCAL component definition by ID
description: Returns a single OSCAL component definition
operationId: getComponentDefinitionById
parameters:
- name: componentDefinitionId
in: path
description: ID of component definition to return
required: true
schema:
type: string
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/OSCALComponentDefinition"
400:
description: Invalid ID supplied
content: {}
404:
description: Component definition not found
content: {}
security:
- oscal_auth:
- read:componentDefinitions
patch:
tags:
- OSCAL Component Definition
summary: Updates an existing OSCAL component definition
operationId: updateComponentDefinition