Skip to content

Commit 03ee959

Browse files
author
Chris Vermeulen
authored
Add endpoint for fetching a single component from an SSP ByComponent (#245)
1 parent a2253e0 commit 03ee959

File tree

4 files changed

+352
-139
lines changed

4 files changed

+352
-139
lines changed

‎docs/docs.go‎

Lines changed: 95 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -8360,7 +8360,7 @@ const docTemplate = `{
83608360
"application/json"
83618361
],
83628362
"tags": [
8363-
"Oscal"
8363+
"System Security Plans"
83648364
],
83658365
"summary": "Update a System Security Plan",
83668366
"parameters": [
@@ -8411,7 +8411,7 @@ const docTemplate = `{
84118411
"delete": {
84128412
"description": "Deletes an existing System Security Plan and all its related data.",
84138413
"tags": [
8414-
"Oscal"
8414+
"System Security Plans"
84158415
],
84168416
"summary": "Delete a System Security Plan",
84178417
"parameters": [
@@ -8455,7 +8455,7 @@ const docTemplate = `{
84558455
"application/json"
84568456
],
84578457
"tags": [
8458-
"Oscal"
8458+
"System Security Plans"
84598459
],
84608460
"summary": "Get SSP back-matter",
84618461
"parameters": [
@@ -8503,7 +8503,7 @@ const docTemplate = `{
85038503
"application/json"
85048504
],
85058505
"tags": [
8506-
"Oscal"
8506+
"System Security Plans"
85078507
],
85088508
"summary": "Update SSP back-matter",
85098509
"parameters": [
@@ -8559,7 +8559,7 @@ const docTemplate = `{
85598559
"application/json"
85608560
],
85618561
"tags": [
8562-
"Oscal"
8562+
"System Security Plans"
85638563
],
85648564
"summary": "Get back-matter resources for a SSP",
85658565
"parameters": [
@@ -8607,7 +8607,7 @@ const docTemplate = `{
86078607
"application/json"
86088608
],
86098609
"tags": [
8610-
"Oscal"
8610+
"System Security Plans"
86118611
],
86128612
"summary": "Create a new back-matter resource for a SSP",
86138613
"parameters": [
@@ -8666,7 +8666,7 @@ const docTemplate = `{
86668666
"application/json"
86678667
],
86688668
"tags": [
8669-
"Oscal"
8669+
"System Security Plans"
86708670
],
86718671
"summary": "Update a back-matter resource for a SSP",
86728672
"parameters": [
@@ -8724,7 +8724,7 @@ const docTemplate = `{
87248724
"delete": {
87258725
"description": "Deletes an existing back-matter resource for a given SSP.",
87268726
"tags": [
8727-
"Oscal"
8727+
"System Security Plans"
87288728
],
87298729
"summary": "Delete a back-matter resource from a SSP",
87308730
"parameters": [
@@ -8834,7 +8834,7 @@ const docTemplate = `{
88348834
"application/json"
88358835
],
88368836
"tags": [
8837-
"Oscal"
8837+
"System Security Plans"
88388838
],
88398839
"summary": "Update Control Implementation",
88408840
"parameters": [
@@ -8890,7 +8890,7 @@ const docTemplate = `{
88908890
"application/json"
88918891
],
88928892
"tags": [
8893-
"Oscal"
8893+
"System Security Plans"
88948894
],
88958895
"summary": "Get implemented requirements for a SSP",
88968896
"parameters": [
@@ -8938,7 +8938,7 @@ const docTemplate = `{
89388938
"application/json"
89398939
],
89408940
"tags": [
8941-
"Oscal"
8941+
"System Security Plans"
89428942
],
89438943
"summary": "Create a new implemented requirement for a SSP",
89448944
"parameters": [
@@ -8997,7 +8997,7 @@ const docTemplate = `{
89978997
"application/json"
89988998
],
89998999
"tags": [
9000-
"Oscal"
9000+
"System Security Plans"
90019001
],
90029002
"summary": "Update an implemented requirement for a SSP",
90039003
"parameters": [
@@ -9055,7 +9055,7 @@ const docTemplate = `{
90559055
"delete": {
90569056
"description": "Deletes an existing implemented requirement for a given SSP.",
90579057
"tags": [
9058-
"Oscal"
9058+
"System Security Plans"
90599059
],
90609060
"summary": "Delete an implemented requirement from a SSP",
90619061
"parameters": [
@@ -9109,7 +9109,7 @@ const docTemplate = `{
91099109
"application/json"
91109110
],
91119111
"tags": [
9112-
"Oscal"
9112+
"System Security Plans"
91139113
],
91149114
"summary": "Create a new statement within an implemented requirement",
91159115
"parameters": [
@@ -9175,7 +9175,7 @@ const docTemplate = `{
91759175
"application/json"
91769176
],
91779177
"tags": [
9178-
"Oscal"
9178+
"System Security Plans"
91799179
],
91809180
"summary": "Update a statement within an implemented requirement",
91819181
"parameters": [
@@ -9245,7 +9245,7 @@ const docTemplate = `{
92459245
"application/json"
92469246
],
92479247
"tags": [
9248-
"Oscal"
9248+
"System Security Plans"
92499249
],
92509250
"summary": "Get SSP import-profile",
92519251
"parameters": [
@@ -9293,7 +9293,7 @@ const docTemplate = `{
92939293
"application/json"
92949294
],
92959295
"tags": [
9296-
"Oscal"
9296+
"System Security Plans"
92979297
],
92989298
"summary": "Update SSP import-profile",
92999299
"parameters": [
@@ -9349,7 +9349,7 @@ const docTemplate = `{
93499349
"application/json"
93509350
],
93519351
"tags": [
9352-
"Oscal"
9352+
"System Security Plans"
93539353
],
93549354
"summary": "Get SSP metadata",
93559355
"parameters": [
@@ -9397,7 +9397,7 @@ const docTemplate = `{
93979397
"application/json"
93989398
],
93999399
"tags": [
9400-
"Oscal"
9400+
"System Security Plans"
94019401
],
94029402
"summary": "Update SSP metadata",
94039403
"parameters": [
@@ -10048,7 +10048,7 @@ const docTemplate = `{
1004810048
"application/json"
1004910049
],
1005010050
"tags": [
10051-
"Oscal"
10051+
"System Security Plans"
1005210052
],
1005310053
"summary": "Update System Implementation",
1005410054
"parameters": [
@@ -10169,7 +10169,7 @@ const docTemplate = `{
1016910169
"application/json"
1017010170
],
1017110171
"tags": [
10172-
"Oscal"
10172+
"System Security Plans"
1017310173
],
1017410174
"summary": "Create a new system component",
1017510175
"parameters": [
@@ -10219,6 +10219,69 @@ const docTemplate = `{
1021910219
}
1022010220
},
1022110221
"/oscal/system-security-plans/{id}/system-implementation/components/{componentId}": {
10222+
"get": {
10223+
"security": [
10224+
{
10225+
"OAuth2Password": []
10226+
}
10227+
],
10228+
"description": "Retrieves component in the System Implementation for a given System Security Plan.",
10229+
"produces": [
10230+
"application/json"
10231+
],
10232+
"tags": [
10233+
"System Security Plans"
10234+
],
10235+
"summary": "Get System Implementation Component",
10236+
"parameters": [
10237+
{
10238+
"type": "string",
10239+
"description": "System Security Plan ID",
10240+
"name": "id",
10241+
"in": "path",
10242+
"required": true
10243+
},
10244+
{
10245+
"type": "string",
10246+
"description": "Component ID",
10247+
"name": "componentId",
10248+
"in": "path",
10249+
"required": true
10250+
}
10251+
],
10252+
"responses": {
10253+
"200": {
10254+
"description": "OK",
10255+
"schema": {
10256+
"$ref": "#/definitions/handler.GenericDataResponse-oscalTypes_1_1_3_SystemComponent"
10257+
}
10258+
},
10259+
"400": {
10260+
"description": "Bad Request",
10261+
"schema": {
10262+
"$ref": "#/definitions/api.Error"
10263+
}
10264+
},
10265+
"401": {
10266+
"description": "Unauthorized",
10267+
"schema": {
10268+
"$ref": "#/definitions/api.Error"
10269+
}
10270+
},
10271+
"404": {
10272+
"description": "Not Found",
10273+
"schema": {
10274+
"$ref": "#/definitions/api.Error"
10275+
}
10276+
},
10277+
"500": {
10278+
"description": "Internal Server Error",
10279+
"schema": {
10280+
"$ref": "#/definitions/api.Error"
10281+
}
10282+
}
10283+
}
10284+
},
1022210285
"put": {
1022310286
"description": "Updates an existing system component for a given SSP.",
1022410287
"consumes": [
@@ -10228,7 +10291,7 @@ const docTemplate = `{
1022810291
"application/json"
1022910292
],
1023010293
"tags": [
10231-
"Oscal"
10294+
"System Security Plans"
1023210295
],
1023310296
"summary": "Update a system component",
1023410297
"parameters": [
@@ -10286,7 +10349,7 @@ const docTemplate = `{
1028610349
"delete": {
1028710350
"description": "Deletes an existing system component for a given SSP.",
1028810351
"tags": [
10289-
"Oscal"
10352+
"System Security Plans"
1029010353
],
1029110354
"summary": "Delete a system component",
1029210355
"parameters": [
@@ -10396,7 +10459,7 @@ const docTemplate = `{
1039610459
"application/json"
1039710460
],
1039810461
"tags": [
10399-
"Oscal"
10462+
"System Security Plans"
1040010463
],
1040110464
"summary": "Create a new inventory item",
1040210465
"parameters": [
@@ -10455,7 +10518,7 @@ const docTemplate = `{
1045510518
"application/json"
1045610519
],
1045710520
"tags": [
10458-
"Oscal"
10521+
"System Security Plans"
1045910522
],
1046010523
"summary": "Update an inventory item",
1046110524
"parameters": [
@@ -10513,7 +10576,7 @@ const docTemplate = `{
1051310576
"delete": {
1051410577
"description": "Deletes an existing inventory item for a given SSP.",
1051510578
"tags": [
10516-
"Oscal"
10579+
"System Security Plans"
1051710580
],
1051810581
"summary": "Delete an inventory item",
1051910582
"parameters": [
@@ -10623,7 +10686,7 @@ const docTemplate = `{
1062310686
"application/json"
1062410687
],
1062510688
"tags": [
10626-
"Oscal"
10689+
"System Security Plans"
1062710690
],
1062810691
"summary": "Create a new leveraged authorization",
1062910692
"parameters": [
@@ -10682,7 +10745,7 @@ const docTemplate = `{
1068210745
"application/json"
1068310746
],
1068410747
"tags": [
10685-
"Oscal"
10748+
"System Security Plans"
1068610749
],
1068710750
"summary": "Update a leveraged authorization",
1068810751
"parameters": [
@@ -10740,7 +10803,7 @@ const docTemplate = `{
1074010803
"delete": {
1074110804
"description": "Deletes an existing leveraged authorization for a given SSP.",
1074210805
"tags": [
10743-
"Oscal"
10806+
"System Security Plans"
1074410807
],
1074510808
"summary": "Delete a leveraged authorization",
1074610809
"parameters": [
@@ -10850,7 +10913,7 @@ const docTemplate = `{
1085010913
"application/json"
1085110914
],
1085210915
"tags": [
10853-
"Oscal"
10916+
"System Security Plans"
1085410917
],
1085510918
"summary": "Create a new system user",
1085610919
"parameters": [
@@ -10909,7 +10972,7 @@ const docTemplate = `{
1090910972
"application/json"
1091010973
],
1091110974
"tags": [
10912-
"Oscal"
10975+
"System Security Plans"
1091310976
],
1091410977
"summary": "Update a system user",
1091510978
"parameters": [
@@ -10967,7 +11030,7 @@ const docTemplate = `{
1096711030
"delete": {
1096811031
"description": "Deletes an existing system user for a given SSP.",
1096911032
"tags": [
10970-
"Oscal"
11033+
"System Security Plans"
1097111034
],
1097211035
"summary": "Delete a system user",
1097311036
"parameters": [

0 commit comments

Comments
 (0)