Skip to content

Commit b92356e

Browse files
committed
Fix internal cross reference errors for API docs
1 parent 709da13 commit b92356e

File tree

6 files changed

+272
-272
lines changed

6 files changed

+272
-272
lines changed

rest_api/v1/AuthService/_v1_auth_m2m_config.id_put.adoc

Lines changed: 57 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ endif::internal-generation[]
115115

116116
[id="AuthMachineToMachineConfigMapping_{context}"]
117117
=== _AuthMachineToMachineConfigMapping_
118-
118+
119119

120120
Mappings map an identity token's claim values to a specific role within Central.
121121

@@ -126,33 +126,33 @@ Mappings map an identity token's claim values to a specific role within Central.
126126
| Field Name| Required| Nullable | Type| Description | Format
127127

128128
| key
129-
|
130-
|
131-
| String
129+
|
130+
|
131+
| String
132132
| A key within the identity token's claim value to use.
133-
|
133+
|
134134

135135
| valueExpression
136-
|
137-
|
138-
| String
136+
|
137+
|
138+
| String
139139
| A regular expression that will be evaluated against values of the identity token claim identified by the specified key. This regular expressions is in RE2 format, see more here: https://github.com/google/re2/wiki/Syntax.
140-
|
140+
|
141141

142142
| role
143-
|
144-
|
145-
| String
143+
|
144+
|
145+
| String
146146
| The role which should be issued when the key and value match for a particular identity token.
147-
|
147+
|
148148

149149
|===
150150

151151

152152

153153
[id="AuthServiceUpdateAuthMachineToMachineConfigBody_{context}"]
154154
=== _AuthServiceUpdateAuthMachineToMachineConfigBody_
155-
155+
156156

157157

158158

@@ -163,19 +163,19 @@ Mappings map an identity token's claim values to a specific role within Central.
163163
| Field Name| Required| Nullable | Type| Description | Format
164164

165165
| config
166-
|
167-
|
168-
| <<AuthServiceUpdateAuthMachineToMachineConfigBody_config_{context}, AuthServiceUpdateAuthMachineToMachineConfigBody_config>>
169-
|
170-
|
166+
|
167+
|
168+
| <<AuthServiceUpdateAuthMachineToMachineConfigBodyConfig_{context}, AuthServiceUpdateAuthMachineToMachineConfigBodyConfig>>
169+
|
170+
|
171171

172172
|===
173173

174174

175175

176176
[id="AuthServiceUpdateAuthMachineToMachineConfigBodyConfig_{context}"]
177177
=== _AuthServiceUpdateAuthMachineToMachineConfigBodyConfig_
178-
178+
179179

180180
AuthMachineToMachineConfig determines rules for exchanging an identity token from a third party with
181181
a Central access token. The M2M stands for machine to machine, as this is the intended use-case
@@ -188,40 +188,40 @@ for the config.
188188
| Field Name| Required| Nullable | Type| Description | Format
189189

190190
| type
191-
|
192-
|
193-
| <<V1AuthMachineToMachineConfigType_{context}, V1AuthMachineToMachineConfigType>>
194-
|
195-
| GENERIC, GITHUB_ACTIONS, KUBE_SERVICE_ACCOUNT,
191+
|
192+
|
193+
| <<V1AuthMachineToMachineConfigType_{context}, V1AuthMachineToMachineConfigType>>
194+
|
195+
| GENERIC, GITHUB_ACTIONS, KUBE_SERVICE_ACCOUNT,
196196

197197
| tokenExpirationDuration
198-
|
199-
|
200-
| String
198+
|
199+
|
200+
| String
201201
| Sets the expiration of the token returned from the ExchangeAuthMachineToMachineToken API call. Possible valid time units are: s, m, h. The maximum allowed expiration duration is 24h. As an example: 2h45m. For additional information on the validation of the duration, see: https://pkg.go.dev/time#ParseDuration.
202-
|
202+
|
203203

204204
| mappings
205-
|
206-
|
205+
|
206+
|
207207
| List of <<AuthMachineToMachineConfigMapping_{context}, AuthMachineToMachineConfigMapping>>
208208
| At least one mapping is required to resolve to a valid role for the access token to be successfully generated.
209-
|
209+
|
210210

211211
| issuer
212-
|
213-
|
214-
| String
212+
|
213+
|
214+
| String
215215
| The issuer of the related OIDC provider issuing the ID tokens to exchange. Must be non-empty string containing URL when type is GENERIC. In case of GitHub actions, this must be empty or set to https://token.actions.githubusercontent.com. Issuer is a unique key, therefore there may be at most one GITHUB_ACTIONS config, and each GENERIC config must have a distinct issuer.
216-
|
216+
|
217217

218218
|===
219219

220220

221221

222222
[id="GooglerpcStatus_{context}"]
223223
=== _GooglerpcStatus_
224-
224+
225225

226226

227227

@@ -232,33 +232,33 @@ for the config.
232232
| Field Name| Required| Nullable | Type| Description | Format
233233

234234
| code
235-
|
236-
|
237-
| Integer
238-
|
239-
| int32
235+
|
236+
|
237+
| Integer
238+
|
239+
| int32
240240

241241
| message
242-
|
243-
|
244-
| String
245-
|
246-
|
242+
|
243+
|
244+
| String
245+
|
246+
|
247247

248248
| details
249-
|
250-
|
249+
|
250+
|
251251
| List of <<ProtobufAny_{context}, ProtobufAny>>
252-
|
253-
|
252+
|
253+
|
254254

255255
|===
256256

257257

258258

259259
[id="ProtobufAny_{context}"]
260260
=== _ProtobufAny_
261-
261+
262262

263263
`Any` contains an arbitrary serialized protocol buffer message along with a
264264
URL that describes the type of the serialized message.
@@ -352,19 +352,19 @@ field. Example (for message [google.protobuf.Duration][]):
352352
| Field Name| Required| Nullable | Type| Description | Format
353353

354354
| @type
355-
|
356-
|
357-
| String
355+
|
356+
|
357+
| String
358358
| A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
359-
|
359+
|
360360

361361
|===
362362

363363

364364

365365
[id="V1AuthMachineToMachineConfigType_{context}"]
366366
=== _V1AuthMachineToMachineConfigType_
367-
367+
368368

369369
The type of the auth machine to machine config.
370370
Currently supports GitHub actions or any other generic OIDC provider to use for verifying and

0 commit comments

Comments
 (0)