Skip to content

Commit c8086be

Browse files
winridwinrid
committed
fixing api key docs
1 parent 2363583 commit c8086be

File tree

4 files changed

+216
-57
lines changed

4 files changed

+216
-57
lines changed

‎client/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,20 @@ Please follow the [installation](#installation) instruction and execute the foll
8383
import com.fastcomments.invoker.ApiClient;
8484
import com.fastcomments.invoker.ApiException;
8585
import com.fastcomments.invoker.Configuration;
86+
import com.fastcomments.invoker.auth.*;
8687
import com.fastcomments.model.*;
8788
import com.fastcomments.api.DefaultApi;
8889

8990
public class Example {
9091
public static void main(String[] args) {
9192
ApiClient defaultClient = Configuration.getDefaultApiClient();
9293
defaultClient.setBasePath("http://localhost");
94+
95+
// Configure API key authorization: api_key
96+
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
97+
api_key.setApiKey("YOUR API KEY");
98+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
99+
//api_key.setApiKeyPrefix("Token");
93100

94101
DefaultApi apiInstance = new DefaultApi(defaultClient);
95102
String tenantId = "tenantId_example"; // String |

‎client/api/openapi.yaml‎

Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,8 @@ paths:
521521
schema:
522522
$ref: '#/components/schemas/GetFeedPosts_200_response'
523523
description: Ok
524-
security: []
524+
security:
525+
- api_key: []
525526
x-accepts:
526527
- application/json
527528
post:
@@ -547,7 +548,8 @@ paths:
547548
schema:
548549
$ref: '#/components/schemas/CreateFeedPost_200_response'
549550
description: Ok
550-
security: []
551+
security:
552+
- api_key: []
551553
x-content-type: application/json
552554
x-accepts:
553555
- application/json
@@ -582,7 +584,8 @@ paths:
582584
schema:
583585
$ref: '#/components/schemas/FlagCommentPublic_200_response'
584586
description: Ok
585-
security: []
587+
security:
588+
- api_key: []
586589
x-content-type: application/json
587590
x-accepts:
588591
- application/json
@@ -1674,7 +1677,8 @@ paths:
16741677
schema:
16751678
$ref: '#/components/schemas/GetDomainConfigs_200_response'
16761679
description: Ok
1677-
security: []
1680+
security:
1681+
- api_key: []
16781682
x-accepts:
16791683
- application/json
16801684
post:
@@ -1700,7 +1704,8 @@ paths:
17001704
schema:
17011705
$ref: '#/components/schemas/AddDomainConfig_200_response'
17021706
description: Ok
1703-
security: []
1707+
security:
1708+
- api_key: []
17041709
x-content-type: application/json
17051710
x-accepts:
17061711
- application/json
@@ -1729,7 +1734,8 @@ paths:
17291734
schema:
17301735
$ref: '#/components/schemas/DeleteDomainConfig_200_response'
17311736
description: Ok
1732-
security: []
1737+
security:
1738+
- api_key: []
17331739
x-accepts:
17341740
- application/json
17351741
get:
@@ -1756,7 +1762,8 @@ paths:
17561762
schema:
17571763
$ref: '#/components/schemas/GetDomainConfig_200_response'
17581764
description: Ok
1759-
security: []
1765+
security:
1766+
- api_key: []
17601767
x-accepts:
17611768
- application/json
17621769
/api/v1/domain-configs/{domainToUpdate}:
@@ -1790,7 +1797,8 @@ paths:
17901797
schema:
17911798
$ref: '#/components/schemas/GetDomainConfig_200_response'
17921799
description: Ok
1793-
security: []
1800+
security:
1801+
- api_key: []
17941802
x-content-type: application/json
17951803
x-accepts:
17961804
- application/json
@@ -1824,7 +1832,8 @@ paths:
18241832
schema:
18251833
$ref: '#/components/schemas/GetDomainConfig_200_response'
18261834
description: Ok
1827-
security: []
1835+
security:
1836+
- api_key: []
18281837
x-content-type: application/json
18291838
x-accepts:
18301839
- application/json
@@ -1867,7 +1876,8 @@ paths:
18671876
schema:
18681877
$ref: '#/components/schemas/DeleteComment_200_response'
18691878
description: Ok
1870-
security: []
1879+
security:
1880+
- api_key: []
18711881
x-accepts:
18721882
- application/json
18731883
get:
@@ -1894,7 +1904,8 @@ paths:
18941904
schema:
18951905
$ref: '#/components/schemas/GetComment_200_response'
18961906
description: Ok
1897-
security: []
1907+
security:
1908+
- api_key: []
18981909
x-accepts:
18991910
- application/json
19001911
patch:
@@ -1948,7 +1959,8 @@ paths:
19481959
schema:
19491960
$ref: '#/components/schemas/FlagCommentPublic_200_response'
19501961
description: Ok
1951-
security: []
1962+
security:
1963+
- api_key: []
19521964
x-content-type: application/json
19531965
x-accepts:
19541966
- application/json
@@ -2074,7 +2086,8 @@ paths:
20742086
schema:
20752087
$ref: '#/components/schemas/GetComments_200_response'
20762088
description: Ok
2077-
security: []
2089+
security:
2090+
- api_key: []
20782091
x-accepts:
20792092
- application/json
20802093
post:
@@ -2128,7 +2141,8 @@ paths:
21282141
schema:
21292142
$ref: '#/components/schemas/SaveComment_200_response'
21302143
description: Ok
2131-
security: []
2144+
security:
2145+
- api_key: []
21322146
x-content-type: application/json
21332147
x-accepts:
21342148
- application/json
@@ -2171,7 +2185,8 @@ paths:
21712185
schema:
21722186
$ref: '#/components/schemas/FlagComment_200_response'
21732187
description: Ok
2174-
security: []
2188+
security:
2189+
- api_key: []
21752190
x-accepts:
21762191
- application/json
21772192
/api/v1/comments/{id}/un-flag:
@@ -2213,7 +2228,8 @@ paths:
22132228
schema:
22142229
$ref: '#/components/schemas/FlagComment_200_response'
22152230
description: Ok
2216-
security: []
2231+
security:
2232+
- api_key: []
22172233
x-accepts:
22182234
- application/json
22192235
/api/v1/comments/{id}/block:
@@ -2261,7 +2277,8 @@ paths:
22612277
schema:
22622278
$ref: '#/components/schemas/BlockFromCommentPublic_200_response'
22632279
description: Ok
2264-
security: []
2280+
security:
2281+
- api_key: []
22652282
x-content-type: application/json
22662283
x-accepts:
22672284
- application/json
@@ -2310,7 +2327,8 @@ paths:
23102327
schema:
23112328
$ref: '#/components/schemas/UnBlockCommentPublic_200_response'
23122329
description: Ok
2313-
security: []
2330+
security:
2331+
- api_key: []
23142332
x-content-type: application/json
23152333
x-accepts:
23162334
- application/json
@@ -2371,7 +2389,8 @@ paths:
23712389
schema:
23722390
$ref: '#/components/schemas/GetAuditLogs_200_response'
23732391
description: Ok
2374-
security: []
2392+
security:
2393+
- api_key: []
23752394
x-accepts:
23762395
- application/json
23772396
/api/v1/aggregate:

0 commit comments

Comments
 (0)