Skip to content

Commit 782a3d5

Browse files
authored
[DOCS] Add responses components in connector open API specification (#153136)
1 parent 68a782a commit 782a3d5

17 files changed

+262
-475
lines changed

docs/api-generated/connectors/connector-apis-passthru.asciidoc

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Any modifications made to this file will be overwritten.
9898
<a href="#connector_response_properties">connector_response_properties</a>
9999
<h4 class="field-label">401</h4>
100100
Authorization information is missing or invalid.
101-
<a href="#401_response">401_response</a>
101+
<a href="#Unauthorized_response">Unauthorized_response</a>
102102
</div> <!-- method -->
103103
<hr/>
104104
<div class="method"><a name="deleteConnector"/>
@@ -146,7 +146,7 @@ Any modifications made to this file will be overwritten.
146146
<a href="#"></a>
147147
<h4 class="field-label">401</h4>
148148
Authorization information is missing or invalid.
149-
<a href="#401_response">401_response</a>
149+
<a href="#Unauthorized_response">Unauthorized_response</a>
150150
<h4 class="field-label">404</h4>
151151
Object is not found.
152152
<a href="#getConnector_404_response">getConnector_404_response</a>
@@ -198,7 +198,7 @@ Any modifications made to this file will be overwritten.
198198
<a href="#connector_response_properties">connector_response_properties</a>
199199
<h4 class="field-label">401</h4>
200200
Authorization information is missing or invalid.
201-
<a href="#401_response">401_response</a>
201+
<a href="#Unauthorized_response">Unauthorized_response</a>
202202
<h4 class="field-label">404</h4>
203203
Object is not found.
204204
<a href="#getConnector_404_response">getConnector_404_response</a>
@@ -262,7 +262,7 @@ Any modifications made to this file will be overwritten.
262262
263263
<h4 class="field-label">401</h4>
264264
Authorization information is missing or invalid.
265-
<a href="#401_response">401_response</a>
265+
<a href="#Unauthorized_response">Unauthorized_response</a>
266266
</div> <!-- method -->
267267
<hr/>
268268
<div class="method"><a name="getConnectors"/>
@@ -320,7 +320,7 @@ Any modifications made to this file will be overwritten.
320320
321321
<h4 class="field-label">401</h4>
322322
Authorization information is missing or invalid.
323-
<a href="#401_response">401_response</a>
323+
<a href="#Unauthorized_response">Unauthorized_response</a>
324324
</div> <!-- method -->
325325
<hr/>
326326
<div class="method"><a name="legacyCreateConnector"/>
@@ -394,7 +394,7 @@ Any modifications made to this file will be overwritten.
394394
<a href="#action_response_properties">action_response_properties</a>
395395
<h4 class="field-label">401</h4>
396396
Authorization information is missing or invalid.
397-
<a href="#401_response">401_response</a>
397+
<a href="#Unauthorized_response">Unauthorized_response</a>
398398
</div> <!-- method -->
399399
<hr/>
400400
<div class="method"><a name="legacyDeleteConnector"/>
@@ -442,7 +442,7 @@ Any modifications made to this file will be overwritten.
442442
<a href="#"></a>
443443
<h4 class="field-label">401</h4>
444444
Authorization information is missing or invalid.
445-
<a href="#401_response">401_response</a>
445+
<a href="#Unauthorized_response">Unauthorized_response</a>
446446
</div> <!-- method -->
447447
<hr/>
448448
<div class="method"><a name="legacyGetConnector"/>
@@ -499,7 +499,7 @@ Any modifications made to this file will be overwritten.
499499
<a href="#action_response_properties">action_response_properties</a>
500500
<h4 class="field-label">401</h4>
501501
Authorization information is missing or invalid.
502-
<a href="#401_response">401_response</a>
502+
<a href="#Unauthorized_response">Unauthorized_response</a>
503503
</div> <!-- method -->
504504
<hr/>
505505
<div class="method"><a name="legacyGetConnectorTypes"/>
@@ -553,7 +553,7 @@ Any modifications made to this file will be overwritten.
553553
554554
<h4 class="field-label">401</h4>
555555
Authorization information is missing or invalid.
556-
<a href="#401_response">401_response</a>
556+
<a href="#Unauthorized_response">Unauthorized_response</a>
557557
</div> <!-- method -->
558558
<hr/>
559559
<div class="method"><a name="legacyGetConnectors"/>
@@ -608,7 +608,7 @@ Any modifications made to this file will be overwritten.
608608
609609
<h4 class="field-label">401</h4>
610610
Authorization information is missing or invalid.
611-
<a href="#401_response">401_response</a>
611+
<a href="#Unauthorized_response">Unauthorized_response</a>
612612
</div> <!-- method -->
613613
<hr/>
614614
<div class="method"><a name="legacyRunConnector"/>
@@ -679,7 +679,7 @@ Any modifications made to this file will be overwritten.
679679
<a href="#legacyRunConnector_200_response">legacyRunConnector_200_response</a>
680680
<h4 class="field-label">401</h4>
681681
Authorization information is missing or invalid.
682-
<a href="#401_response">401_response</a>
682+
<a href="#Unauthorized_response">Unauthorized_response</a>
683683
</div> <!-- method -->
684684
<hr/>
685685
<div class="method"><a name="legacyUpdateConnector"/>
@@ -755,7 +755,7 @@ Any modifications made to this file will be overwritten.
755755
<a href="#action_response_properties">action_response_properties</a>
756756
<h4 class="field-label">404</h4>
757757
Object is not found.
758-
<a href="#404_response">404_response</a>
758+
<a href="#Not_found_response">Not_found_response</a>
759759
</div> <!-- method -->
760760
<hr/>
761761
<div class="method"><a name="runConnector"/>
@@ -826,7 +826,7 @@ Any modifications made to this file will be overwritten.
826826
<a href="#runConnector_200_response">runConnector_200_response</a>
827827
<h4 class="field-label">401</h4>
828828
Authorization information is missing or invalid.
829-
<a href="#401_response">401_response</a>
829+
<a href="#Unauthorized_response">Unauthorized_response</a>
830830
</div> <!-- method -->
831831
<hr/>
832832
<div class="method"><a name="updateConnector"/>
@@ -897,10 +897,10 @@ Any modifications made to this file will be overwritten.
897897
<a href="#updateConnector_400_response">updateConnector_400_response</a>
898898
<h4 class="field-label">401</h4>
899899
Authorization information is missing or invalid.
900-
<a href="#401_response">401_response</a>
900+
<a href="#Unauthorized_response">Unauthorized_response</a>
901901
<h4 class="field-label">404</h4>
902902
Object is not found.
903-
<a href="#404_response">404_response</a>
903+
<a href="#Not_found_response">Not_found_response</a>
904904
</div> <!-- method -->
905905
<hr/>
906906
@@ -909,8 +909,6 @@ Any modifications made to this file will be overwritten.
909909
910910
<h3>Table of Contents</h3>
911911
<ol>
912-
<li><a href="#401_response"><code>401_response</code> - Unsuccessful rule API response</a></li>
913-
<li><a href="#404_response"><code>404_response</code> - </a></li>
914912
<li><a href="#Alert_identifier_mapping"><code>Alert_identifier_mapping</code> - Alert identifier mapping</a></li>
915913
<li><a href="#Case_comment_mapping"><code>Case_comment_mapping</code> - Case comment mapping</a></li>
916914
<li><a href="#Case_description_mapping"><code>Case_description_mapping</code> - Case description mapping</a></li>
@@ -924,11 +922,13 @@ Any modifications made to this file will be overwritten.
924922
<li><a href="#Legacy_get_connector_types_response_body_properties_inner"><code>Legacy_get_connector_types_response_body_properties_inner</code> - </a></li>
925923
<li><a href="#Legacy_run_connector_request_body_properties"><code>Legacy_run_connector_request_body_properties</code> - Legacy run connector request body properties</a></li>
926924
<li><a href="#Legacy_update_connector_request_body_properties"><code>Legacy_update_connector_request_body_properties</code> - Legacy update connector request body properties</a></li>
925+
<li><a href="#Not_found_response"><code>Not_found_response</code> - Not found response</a></li>
927926
<li><a href="#Rule_name_mapping"><code>Rule_name_mapping</code> - Rule name mapping</a></li>
928927
<li><a href="#Run_connector_request_body_properties"><code>Run_connector_request_body_properties</code> - Run connector request body properties</a></li>
929928
<li><a href="#Run_connector_request_body_properties_params"><code>Run_connector_request_body_properties_params</code> - </a></li>
930929
<li><a href="#Severity_mapping"><code>Severity_mapping</code> - Severity mapping</a></li>
931930
<li><a href="#Subaction_parameters"><code>Subaction_parameters</code> - Subaction parameters</a></li>
931+
<li><a href="#Unauthorized_response"><code>Unauthorized_response</code> - Unauthorized response</a></li>
932932
<li><a href="#Update_connector_request_body_properties"><code>Update_connector_request_body_properties</code> - Update connector request body properties</a></li>
933933
<li><a href="#action_response_properties"><code>action_response_properties</code> - Action response properties</a></li>
934934
<li><a href="#config_properties_cases_webhook"><code>config_properties_cases_webhook</code> - Connector request properties for Webhook - Case Management connector</a></li>
@@ -1028,32 +1028,6 @@ Any modifications made to this file will be overwritten.
10281028
<li><a href="#update_connector_request_swimlane"><code>update_connector_request_swimlane</code> - Update Swimlane connector request</a></li>
10291029
</ol>
10301030
1031-
<div class="model">
1032-
<h3><a name="401_response"><code>401_response</code> - Unsuccessful rule API response</a> <a class="up" href="#__Models">Up</a></h3>
1033-
<div class='model-description'></div>
1034-
<div class="field-items">
1035-
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
1036-
<div class="param-enum-header">Enum:</div>
1037-
<div class="param-enum">Unauthorized</div>
1038-
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
1039-
<div class="param">statusCode (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
1040-
<div class="param-enum-header">Enum:</div>
1041-
<div class="param-enum">401</div>
1042-
</div> <!-- field-items -->
1043-
</div>
1044-
<div class="model">
1045-
<h3><a name="404_response"><code>404_response</code> - </a> <a class="up" href="#__Models">Up</a></h3>
1046-
<div class='model-description'></div>
1047-
<div class="field-items">
1048-
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
1049-
<div class="param-enum-header">Enum:</div>
1050-
<div class="param-enum">Not Found</div>
1051-
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
1052-
<div class="param">statusCode (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
1053-
<div class="param-enum-header">Enum:</div>
1054-
<div class="param-enum">404</div>
1055-
</div> <!-- field-items -->
1056-
</div>
10571031
<div class="model">
10581032
<h3><a name="Alert_identifier_mapping"><code>Alert_identifier_mapping</code> - Alert identifier mapping</a> <a class="up" href="#__Models">Up</a></h3>
10591033
<div class='model-description'>Mapping for the alert ID.</div>
@@ -1194,6 +1168,19 @@ Any modifications made to this file will be overwritten.
11941168
<div class="param">secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> The updated secrets configuration for the connector. Secrets properties vary depending on the connector type. </div>
11951169
</div> <!-- field-items -->
11961170
</div>
1171+
<div class="model">
1172+
<h3><a name="Not_found_response"><code>Not_found_response</code> - Not found response</a> <a class="up" href="#__Models">Up</a></h3>
1173+
<div class='model-description'></div>
1174+
<div class="field-items">
1175+
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
1176+
<div class="param-enum-header">Enum:</div>
1177+
<div class="param-enum">Not Found</div>
1178+
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
1179+
<div class="param">statusCode (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
1180+
<div class="param-enum-header">Enum:</div>
1181+
<div class="param-enum">404</div>
1182+
</div> <!-- field-items -->
1183+
</div>
11971184
<div class="model">
11981185
<h3><a name="Rule_name_mapping"><code>Rule_name_mapping</code> - Rule name mapping</a> <a class="up" href="#__Models">Up</a></h3>
11991186
<div class='model-description'>Mapping for the name of the alert's rule.</div>
@@ -1246,6 +1233,19 @@ Any modifications made to this file will be overwritten.
12461233
<div class="param">subActionParams </div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_pushtoservice_subActionParams">run_connector_subaction_pushtoservice_subActionParams</a></span> </div>
12471234
</div> <!-- field-items -->
12481235
</div>
1236+
<div class="model">
1237+
<h3><a name="Unauthorized_response"><code>Unauthorized_response</code> - Unauthorized response</a> <a class="up" href="#__Models">Up</a></h3>
1238+
<div class='model-description'></div>
1239+
<div class="field-items">
1240+
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
1241+
<div class="param-enum-header">Enum:</div>
1242+
<div class="param-enum">Unauthorized</div>
1243+
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
1244+
<div class="param">statusCode (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
1245+
<div class="param-enum-header">Enum:</div>
1246+
<div class="param-enum">401</div>
1247+
</div> <!-- field-items -->
1248+
</div>
12491249
<div class="model">
12501250
<h3><a name="Update_connector_request_body_properties"><code>Update_connector_request_body_properties</code> - Update connector request body properties</a> <a class="up" href="#__Models">Up</a></h3>
12511251
<div class='model-description'>The properties vary depending on the connector type.</div>

0 commit comments

Comments
 (0)