Skip to content

Commit 78964d6

Browse files
Deployed 8051229 to dev with MkDocs 1.6.1 and mike 2.1.4
1 parent db769b7 commit 78964d6

File tree

3 files changed

+73
-39
lines changed

3 files changed

+73
-39
lines changed

dev/api/openapi3.yaml

Lines changed: 41 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -283,26 +283,28 @@ paths:
283283
tags:
284284
- api-keys-v2
285285
summary: Create a new hash-based API key
286-
description: Creates a new OpenAI-compatible API key (sk-oai-* format). If expiresIn is not provided, defaults to API_KEY_MAX_EXPIRATION_DAYS (default 90 days). The plaintext key is shown ONLY ONCE at creation time and cannot be retrieved again.
286+
description: Creates a new OpenAI-compatible API key (sk-oai-* format). Name is required for regular keys but optional for ephemeral keys. If expiresIn is not provided, defaults to API_KEY_MAX_EXPIRATION_DAYS (default 90 days) for regular keys, or 1 hour for ephemeral keys. The plaintext key is shown ONLY ONCE at creation time and cannot be retrieved again.
287287
operationId: api-keys-v2#create
288288
requestBody:
289289
required: true
290290
content:
291291
application/json:
292292
schema:
293293
type: object
294-
required:
295-
- name
296294
properties:
297295
name:
298296
type: string
299-
description: Human-readable name for the API key
297+
description: Human-readable name for the API key. Required for regular keys, optional for ephemeral keys.
300298
description:
301299
type: string
302300
description: Optional description
303301
expiresIn:
304302
type: string
305-
description: Expiration duration (e.g., "30d", "90d", "1h"). Defaults to API_KEY_MAX_EXPIRATION_DAYS if not provided.
303+
description: Expiration duration (e.g., "30d", "90d", "1h"). Defaults to API_KEY_MAX_EXPIRATION_DAYS for regular keys, 1 hour for ephemeral keys.
304+
ephemeral:
305+
type: boolean
306+
description: Create a short-lived programmatic key. Defaults to false. Ephemeral keys have 1hr default and maximum expiration (enforced), and optional name.
307+
default: false
306308
examples:
307309
default_expiration:
308310
summary: API key with default expiration (API_KEY_MAX_EXPIRATION_DAYS)
@@ -315,13 +317,25 @@ paths:
315317
name: my-short-lived-key
316318
description: 30-day test key
317319
expiresIn: 30d
320+
ephemeral_key:
321+
summary: Ephemeral key for programmatic use (1hr expiration)
322+
value:
323+
ephemeral: true
318324
responses:
319325
"201":
320326
description: Created response.
321327
content:
322328
application/json:
323329
schema:
324330
type: object
331+
required:
332+
- key
333+
- keyPrefix
334+
- id
335+
- name
336+
- createdAt
337+
- expiresAt
338+
- ephemeral
325339
properties:
326340
key:
327341
type: string
@@ -343,6 +357,9 @@ paths:
343357
type: string
344358
format: date-time
345359
description: Expiration timestamp (RFC3339)
360+
ephemeral:
361+
type: boolean
362+
description: Whether this is a short-lived programmatic key
346363
"400":
347364
description: Bad Request response.
348365
"401":
@@ -352,7 +369,7 @@ paths:
352369
tags:
353370
- api-keys-v2
354371
summary: Search and filter API keys
355-
description: Search API keys with flexible filtering, sorting, and pagination. Supports filtering by username (admin-only), status, sorting by multiple fields, and pagination.
372+
description: Search API keys with flexible filtering, sorting, and pagination. Supports filtering by username (admin-only), status, sorting by multiple fields, and pagination. Ephemeral keys are excluded by default.
356373
operationId: api-keys-v2#search
357374
requestBody:
358375
required: false
@@ -373,6 +390,10 @@ paths:
373390
type: string
374391
enum: [active, revoked, expired]
375392
description: Filter by status (active, revoked, expired). Defaults to active only.
393+
includeEphemeral:
394+
type: boolean
395+
description: Include ephemeral keys in results. Defaults to false.
396+
default: false
376397
sort:
377398
type: object
378399
properties:
@@ -398,7 +419,7 @@ paths:
398419
default: 0
399420
examples:
400421
default_search:
401-
summary: Default search (active keys, newest first)
422+
summary: Default search (active keys, newest first, excludes ephemeral)
402423
value:
403424
filters:
404425
status: ["active"]
@@ -420,6 +441,12 @@ paths:
420441
pagination:
421442
limit: 20
422443
offset: 0
444+
include_ephemeral:
445+
summary: Include ephemeral keys in search
446+
value:
447+
filters:
448+
status: ["active"]
449+
includeEphemeral: true
423450
responses:
424451
"200":
425452
description: OK response.
@@ -434,11 +461,13 @@ paths:
434461
name: my-production-key
435462
creationDate: "2024-01-15T10:30:00Z"
436463
status: active
464+
ephemeral: false
437465
- id: key_def456
438466
name: my-test-key
439467
creationDate: "2024-01-14T09:15:00Z"
440468
expirationDate: "2024-04-14T09:15:00Z"
441469
status: active
470+
ephemeral: false
442471
has_more: true
443472
"400":
444473
description: Bad Request. Invalid search parameters.
@@ -559,6 +588,7 @@ paths:
559588
name: my-production-key
560589
creationDate: "2024-01-15T10:30:00Z"
561590
status: revoked
591+
ephemeral: false
562592
"404":
563593
description: Not Found. API key not found.
564594
"401":
@@ -807,11 +837,15 @@ components:
807837
type: string
808838
format: date-time
809839
description: When the API key was last used for validation
840+
ephemeral:
841+
type: boolean
842+
description: Whether this is a short-lived programmatic token
810843
required:
811844
- id
812845
- name
813846
- creationDate
814847
- status
848+
- ephemeral
815849

816850
# API Key List Response (paginated)
817851
ApiKeyListResponse:

dev/sitemap.xml

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,130 +2,130 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/</loc>
5-
<lastmod>2026-03-19</lastmod>
5+
<lastmod>2026-03-20</lastmod>
66
</url>
77
<url>
88
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/architecture/</loc>
9-
<lastmod>2026-03-19</lastmod>
9+
<lastmod>2026-03-20</lastmod>
1010
</url>
1111
<url>
1212
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/quickstart/</loc>
13-
<lastmod>2026-03-19</lastmod>
13+
<lastmod>2026-03-20</lastmod>
1414
</url>
1515
<url>
1616
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/advanced-administration/limitador-persistence/</loc>
17-
<lastmod>2026-03-19</lastmod>
17+
<lastmod>2026-03-20</lastmod>
1818
</url>
1919
<url>
2020
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/advanced-administration/observability/</loc>
21-
<lastmod>2026-03-19</lastmod>
21+
<lastmod>2026-03-20</lastmod>
2222
</url>
2323
<url>
2424
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/advanced-administration/subscription-cardinality/</loc>
25-
<lastmod>2026-03-19</lastmod>
25+
<lastmod>2026-03-20</lastmod>
2626
</url>
2727
<url>
2828
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/configuration-and-management/group-membership-known-issues/</loc>
29-
<lastmod>2026-03-19</lastmod>
29+
<lastmod>2026-03-20</lastmod>
3030
</url>
3131
<url>
3232
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/configuration-and-management/maas-controller-overview/</loc>
33-
<lastmod>2026-03-19</lastmod>
33+
<lastmod>2026-03-20</lastmod>
3434
</url>
3535
<url>
3636
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/configuration-and-management/maas-model-kinds/</loc>
37-
<lastmod>2026-03-19</lastmod>
37+
<lastmod>2026-03-20</lastmod>
3838
</url>
3939
<url>
4040
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/configuration-and-management/maas-models/</loc>
41-
<lastmod>2026-03-19</lastmod>
41+
<lastmod>2026-03-20</lastmod>
4242
</url>
4343
<url>
4444
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/configuration-and-management/model-access-behavior/</loc>
45-
<lastmod>2026-03-19</lastmod>
45+
<lastmod>2026-03-20</lastmod>
4646
</url>
4747
<url>
4848
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/configuration-and-management/model-listing-flow/</loc>
49-
<lastmod>2026-03-19</lastmod>
49+
<lastmod>2026-03-20</lastmod>
5050
</url>
5151
<url>
5252
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/configuration-and-management/model-setup/</loc>
53-
<lastmod>2026-03-19</lastmod>
53+
<lastmod>2026-03-20</lastmod>
5454
</url>
5555
<url>
5656
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/configuration-and-management/quota-and-access-configuration/</loc>
57-
<lastmod>2026-03-19</lastmod>
57+
<lastmod>2026-03-20</lastmod>
5858
</url>
5959
<url>
6060
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/configuration-and-management/subscription-known-issues/</loc>
61-
<lastmod>2026-03-19</lastmod>
61+
<lastmod>2026-03-20</lastmod>
6262
</url>
6363
<url>
6464
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/configuration-and-management/subscription-overview/</loc>
65-
<lastmod>2026-03-19</lastmod>
65+
<lastmod>2026-03-20</lastmod>
6666
</url>
6767
<url>
6868
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/configuration-and-management/tls-configuration/</loc>
69-
<lastmod>2026-03-19</lastmod>
69+
<lastmod>2026-03-20</lastmod>
7070
</url>
7171
<url>
7272
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/configuration-and-management/token-management/</loc>
73-
<lastmod>2026-03-19</lastmod>
73+
<lastmod>2026-03-20</lastmod>
7474
</url>
7575
<url>
7676
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/install/maas-setup/</loc>
77-
<lastmod>2026-03-19</lastmod>
77+
<lastmod>2026-03-20</lastmod>
7878
</url>
7979
<url>
8080
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/install/model-setup/</loc>
81-
<lastmod>2026-03-19</lastmod>
81+
<lastmod>2026-03-20</lastmod>
8282
</url>
8383
<url>
8484
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/install/platform-setup/</loc>
85-
<lastmod>2026-03-19</lastmod>
85+
<lastmod>2026-03-20</lastmod>
8686
</url>
8787
<url>
8888
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/install/prerequisites/</loc>
89-
<lastmod>2026-03-19</lastmod>
89+
<lastmod>2026-03-20</lastmod>
9090
</url>
9191
<url>
9292
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/install/troubleshooting/</loc>
93-
<lastmod>2026-03-19</lastmod>
93+
<lastmod>2026-03-20</lastmod>
9494
</url>
9595
<url>
9696
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/install/validation/</loc>
97-
<lastmod>2026-03-19</lastmod>
97+
<lastmod>2026-03-20</lastmod>
9898
</url>
9999
<url>
100100
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/migration/tier-to-subscription/</loc>
101-
<lastmod>2026-03-19</lastmod>
101+
<lastmod>2026-03-20</lastmod>
102102
</url>
103103
<url>
104104
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/reference/api-reference/</loc>
105-
<lastmod>2026-03-19</lastmod>
105+
<lastmod>2026-03-20</lastmod>
106106
</url>
107107
<url>
108108
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/reference/maas-api-overview/</loc>
109-
<lastmod>2026-03-19</lastmod>
109+
<lastmod>2026-03-20</lastmod>
110110
</url>
111111
<url>
112112
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/reference/crds/maas-auth-policy/</loc>
113-
<lastmod>2026-03-19</lastmod>
113+
<lastmod>2026-03-20</lastmod>
114114
</url>
115115
<url>
116116
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/reference/crds/maas-model-ref/</loc>
117-
<lastmod>2026-03-19</lastmod>
117+
<lastmod>2026-03-20</lastmod>
118118
</url>
119119
<url>
120120
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/reference/crds/maas-subscription/</loc>
121-
<lastmod>2026-03-19</lastmod>
121+
<lastmod>2026-03-20</lastmod>
122122
</url>
123123
<url>
124124
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/release-notes/</loc>
125-
<lastmod>2026-03-19</lastmod>
125+
<lastmod>2026-03-20</lastmod>
126126
</url>
127127
<url>
128128
<loc>https://opendatahub-io.github.io/models-as-a-service/dev/user-guide/self-service-model-access/</loc>
129-
<lastmod>2026-03-19</lastmod>
129+
<lastmod>2026-03-20</lastmod>
130130
</url>
131131
</urlset>

dev/sitemap.xml.gz

-1 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)