Skip to content

Commit 160a711

Browse files
gaurav-nelsongaurav-nelson
authored
Merge pull request #93809 from gaurav-nelson/rhacs-docs-4.7
Updated API docs for 4.7.3
2 parents baf7719 + fb55579 commit 160a711

File tree

429 files changed

+50773
-197991
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

429 files changed

+50773
-197991
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 224 additions & 806 deletions
Large diffs are not rendered by default.

‎rest_api/APITokenService/APITokenService.adoc

Lines changed: 256 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,256 @@
1+
// Auto-generated by scripts. Do not edit.
2+
:_mod-docs-content-type: ASSEMBLY
3+
[id="APITokenService"]
4+
= A P I Token Service
5+
:toc: macro
6+
:toc-title:
7+
8+
toc::[]
9+
10+
:context: APITokenService
11+
12+
[id="GenerateToken_APITokenService"]
13+
== GenerateToken
14+
15+
`POST /v1/apitokens/generate`
16+
17+
GenerateToken generates API token for a given user and role.
18+
19+
=== Description
20+
21+
=== Parameters
22+
23+
==== Body Parameter
24+
25+
[cols="2,3,1,1,1"]
26+
|===
27+
|Name| Description| Required| Default| Pattern
28+
29+
| body
30+
| xref:../CommonObjectReference/CommonObjectReference.adoc#V1GenerateTokenRequest_CommonObjectReference[V1GenerateTokenRequest]
31+
| X
32+
|
33+
|
34+
35+
|===
36+
37+
=== Return Type
38+
39+
xref:../CommonObjectReference/CommonObjectReference.adoc#V1GenerateTokenResponse_CommonObjectReference[V1GenerateTokenResponse]
40+
41+
=== Content Type
42+
43+
* application/json
44+
45+
=== Responses
46+
47+
.HTTP Response Codes
48+
[cols="2,3,1"]
49+
|===
50+
| Code | Message | Datatype
51+
52+
| 200
53+
| A successful response.
54+
| xref:../CommonObjectReference/CommonObjectReference.adoc#V1GenerateTokenResponse_CommonObjectReference[V1GenerateTokenResponse]
55+
56+
| 0
57+
| An unexpected error response.
58+
| xref:../CommonObjectReference/CommonObjectReference.adoc#GooglerpcStatus_CommonObjectReference[GooglerpcStatus]
59+
60+
|===
61+
62+
=== Samples
63+
64+
[id="GetAPIToken_APITokenService"]
65+
== GetAPIToken
66+
67+
`GET /v1/apitokens/{id}`
68+
69+
GetAPIToken returns API token metadata for a given id.
70+
71+
=== Description
72+
73+
=== Parameters
74+
75+
==== Path Parameters
76+
77+
[cols="2,3,1,1,1"]
78+
|===
79+
|Name| Description| Required| Default| Pattern
80+
81+
| id
82+
|
83+
| X
84+
| null
85+
|
86+
87+
|===
88+
89+
=== Return Type
90+
91+
xref:../CommonObjectReference/CommonObjectReference.adoc#StorageTokenMetadata_CommonObjectReference[StorageTokenMetadata]
92+
93+
=== Content Type
94+
95+
* application/json
96+
97+
=== Responses
98+
99+
.HTTP Response Codes
100+
[cols="2,3,1"]
101+
|===
102+
| Code | Message | Datatype
103+
104+
| 200
105+
| A successful response.
106+
| xref:../CommonObjectReference/CommonObjectReference.adoc#StorageTokenMetadata_CommonObjectReference[StorageTokenMetadata]
107+
108+
| 0
109+
| An unexpected error response.
110+
| xref:../CommonObjectReference/CommonObjectReference.adoc#GooglerpcStatus_CommonObjectReference[GooglerpcStatus]
111+
112+
|===
113+
114+
=== Samples
115+
116+
[id="GetAPITokens_APITokenService"]
117+
== GetAPITokens
118+
119+
`GET /v1/apitokens`
120+
121+
GetAPITokens returns all the API tokens.
122+
123+
=== Description
124+
125+
=== Parameters
126+
127+
==== Query Parameters
128+
129+
[cols="2,3,1,1,1"]
130+
|===
131+
|Name| Description| Required| Default| Pattern
132+
133+
| revoked
134+
|
135+
| -
136+
| null
137+
|
138+
139+
|===
140+
141+
=== Return Type
142+
143+
xref:../CommonObjectReference/CommonObjectReference.adoc#V1GetAPITokensResponse_CommonObjectReference[V1GetAPITokensResponse]
144+
145+
=== Content Type
146+
147+
* application/json
148+
149+
=== Responses
150+
151+
.HTTP Response Codes
152+
[cols="2,3,1"]
153+
|===
154+
| Code | Message | Datatype
155+
156+
| 200
157+
| A successful response.
158+
| xref:../CommonObjectReference/CommonObjectReference.adoc#V1GetAPITokensResponse_CommonObjectReference[V1GetAPITokensResponse]
159+
160+
| 0
161+
| An unexpected error response.
162+
| xref:../CommonObjectReference/CommonObjectReference.adoc#GooglerpcStatus_CommonObjectReference[GooglerpcStatus]
163+
164+
|===
165+
166+
=== Samples
167+
168+
[id="ListAllowedTokenRoles_APITokenService"]
169+
== ListAllowedTokenRoles
170+
171+
`GET /v1/apitokens/generate/allowed-roles`
172+
173+
GetAllowedTokenRoles return roles that user is allowed to request for API token.
174+
175+
=== Description
176+
177+
=== Parameters
178+
179+
=== Return Type
180+
181+
xref:../CommonObjectReference/CommonObjectReference.adoc#V1ListAllowedTokenRolesResponse_CommonObjectReference[V1ListAllowedTokenRolesResponse]
182+
183+
=== Content Type
184+
185+
* application/json
186+
187+
=== Responses
188+
189+
.HTTP Response Codes
190+
[cols="2,3,1"]
191+
|===
192+
| Code | Message | Datatype
193+
194+
| 200
195+
| A successful response.
196+
| xref:../CommonObjectReference/CommonObjectReference.adoc#V1ListAllowedTokenRolesResponse_CommonObjectReference[V1ListAllowedTokenRolesResponse]
197+
198+
| 0
199+
| An unexpected error response.
200+
| xref:../CommonObjectReference/CommonObjectReference.adoc#GooglerpcStatus_CommonObjectReference[GooglerpcStatus]
201+
202+
|===
203+
204+
=== Samples
205+
206+
[id="RevokeToken_APITokenService"]
207+
== RevokeToken
208+
209+
`PATCH /v1/apitokens/revoke/{id}`
210+
211+
RevokeToken removes the API token for a given id.
212+
213+
=== Description
214+
215+
=== Parameters
216+
217+
==== Path Parameters
218+
219+
[cols="2,3,1,1,1"]
220+
|===
221+
|Name| Description| Required| Default| Pattern
222+
223+
| id
224+
|
225+
| X
226+
| null
227+
|
228+
229+
|===
230+
231+
=== Return Type
232+
233+
`Object`
234+
235+
=== Content Type
236+
237+
* application/json
238+
239+
=== Responses
240+
241+
.HTTP Response Codes
242+
[cols="2,3,1"]
243+
|===
244+
| Code | Message | Datatype
245+
246+
| 200
247+
| A successful response.
248+
| `Object`
249+
250+
| 0
251+
| An unexpected error response.
252+
| xref:../CommonObjectReference/CommonObjectReference.adoc#GooglerpcStatus_CommonObjectReference[GooglerpcStatus]
253+
254+
|===
255+
256+
=== Samples

0 commit comments

Comments
 (0)