Skip to content

Commit 457903a

Browse files
jopemachinelablup-octodog
jopemachine
and
lablup-octodog
committed
chore: update api schema dump
Co-authored-by: octodog <mu001@lablup.com>
1 parent 7ea84a2 commit 457903a

4 files changed

Lines changed: 88 additions & 4 deletions

File tree

‎docs/manager/graphql-reference/schema.graphql‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1214,7 +1214,6 @@ type KeyPair implements Item {
12141214
resource_policy: String
12151215
created_at: DateTime
12161216
last_used: DateTime
1217-
rate_limit: Int
12181217
num_queries: Int
12191218

12201219
"""Added in 24.09.0."""
@@ -1227,6 +1226,7 @@ type KeyPair implements Item {
12271226
concurrency_used: Int
12281227
user_info: UserInfo
12291228
concurrency_limit: Int @deprecated(reason: "Moved to KeyPairResourcePolicy object as the max_concurrent_sessions field.")
1229+
rate_limit: Int @deprecated(reason: "Moved to UserResourcePolicy object as the max_api_requests_per_window field. The value is still stored but no longer enforced.")
12301230
}
12311231

12321232
type VirtualFolder implements Item {

‎docs/manager/graphql-reference/supergraph.graphql‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5002,6 +5002,11 @@ input CreateUserResourcePolicyInputV2
50025002
"""
50035003
maxConcurrentLogins: Int = null
50045004

5005+
"""
5006+
Added in 26.9.0. Maximum number of API requests allowed per user within the rate limit window. Null means unlimited.
5007+
"""
5008+
maxApiRequestsPerWindow: Int = null
5009+
50055010
"""Maximum quota scope size (e.g., '1g', '536870912')."""
50065011
maxQuotaScopeSize: BinarySizeInput!
50075012

@@ -9645,7 +9650,6 @@ type KeyPair implements Item
96459650
resource_policy: String
96469651
created_at: DateTime
96479652
last_used: DateTime
9648-
rate_limit: Int
96499653
num_queries: Int
96509654

96519655
"""Added in 24.09.0."""
@@ -9658,6 +9662,7 @@ type KeyPair implements Item
96589662
concurrency_used: Int
96599663
user_info: UserInfo
96609664
concurrency_limit: Int @deprecated(reason: "Moved to KeyPairResourcePolicy object as the max_concurrent_sessions field.")
9665+
rate_limit: Int @deprecated(reason: "Moved to UserResourcePolicy object as the max_api_requests_per_window field. The value is still stored but no longer enforced.")
96619666
}
96629667

96639668
"""
@@ -22200,6 +22205,11 @@ input UpdateUserResourcePolicyInput
2220022205
"""
2220122206
maxConcurrentLogins: Int
2220222207

22208+
"""
22209+
Added in 26.9.0. Updated maximum number of API requests allowed per user within the rate limit window. Set to null to clear (unlimited).
22210+
"""
22211+
maxApiRequestsPerWindow: Int
22212+
2220322213
"""Updated max quota scope size."""
2220422214
maxQuotaScopeSize: BinarySizeInput = null
2220522215

@@ -22876,6 +22886,11 @@ type UserResourcePolicyV2 implements Node
2287622886
"""
2287722887
maxConcurrentLogins: Int
2287822888

22889+
"""
22890+
Added in 26.9.0. Maximum number of API requests allowed per user within the rate limit window. Null means unlimited.
22891+
"""
22892+
maxApiRequestsPerWindow: Int
22893+
2287922894
"""Maximum quota scope size."""
2288022895
maxQuotaScopeSize: BinarySizeInfo!
2288122896

@@ -22919,6 +22934,7 @@ input UserResourcePolicyV2Filter
2291922934
createdAt: DateTimeFilter = null
2292022935
maxVfolderCount: IntFilter = null
2292122936
maxConcurrentLogins: IntFilter = null
22937+
maxApiRequestsPerWindow: IntFilter = null
2292222938
maxQuotaScopeSize: IntFilter = null
2292322939
maxSessionCountPerModelSession: IntFilter = null
2292422940
maxCustomizedImageCount: IntFilter = null
@@ -22952,6 +22968,7 @@ enum UserResourcePolicyV2OrderField
2295222968
CREATED_AT @join__enumValue(graph: STRAWBERRY)
2295322969
MAX_VFOLDER_COUNT @join__enumValue(graph: STRAWBERRY)
2295422970
MAX_CONCURRENT_LOGINS @join__enumValue(graph: STRAWBERRY)
22971+
MAX_API_REQUESTS_PER_WINDOW @join__enumValue(graph: STRAWBERRY)
2295522972
MAX_QUOTA_SCOPE_SIZE @join__enumValue(graph: STRAWBERRY)
2295622973
MAX_SESSION_COUNT_PER_MODEL_SESSION @join__enumValue(graph: STRAWBERRY)
2295722974
MAX_CUSTOMIZED_IMAGE_COUNT @join__enumValue(graph: STRAWBERRY)

‎docs/manager/graphql-reference/v2-schema.graphql‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3377,6 +3377,11 @@ input CreateUserResourcePolicyInputV2 {
33773377
"""
33783378
maxConcurrentLogins: Int = null
33793379

3380+
"""
3381+
Added in 26.9.0. Maximum number of API requests allowed per user within the rate limit window. Null means unlimited.
3382+
"""
3383+
maxApiRequestsPerWindow: Int = null
3384+
33803385
"""Maximum quota scope size (e.g., '1g', '536870912')."""
33813386
maxQuotaScopeSize: BinarySizeInput!
33823387

@@ -16030,6 +16035,11 @@ input UpdateUserResourcePolicyInput {
1603016035
"""
1603116036
maxConcurrentLogins: Int
1603216037

16038+
"""
16039+
Added in 26.9.0. Updated maximum number of API requests allowed per user within the rate limit window. Set to null to clear (unlimited).
16040+
"""
16041+
maxApiRequestsPerWindow: Int
16042+
1603316043
"""Updated max quota scope size."""
1603416044
maxQuotaScopeSize: BinarySizeInput = null
1603516045

@@ -16446,6 +16456,11 @@ type UserResourcePolicyV2 implements Node {
1644616456
"""
1644716457
maxConcurrentLogins: Int
1644816458

16459+
"""
16460+
Added in 26.9.0. Maximum number of API requests allowed per user within the rate limit window. Null means unlimited.
16461+
"""
16462+
maxApiRequestsPerWindow: Int
16463+
1644916464
"""Maximum quota scope size."""
1645016465
maxQuotaScopeSize: BinarySizeInfo!
1645116466

@@ -16483,6 +16498,7 @@ input UserResourcePolicyV2Filter {
1648316498
createdAt: DateTimeFilter = null
1648416499
maxVfolderCount: IntFilter = null
1648516500
maxConcurrentLogins: IntFilter = null
16501+
maxApiRequestsPerWindow: IntFilter = null
1648616502
maxQuotaScopeSize: IntFilter = null
1648716503
maxSessionCountPerModelSession: IntFilter = null
1648816504
maxCustomizedImageCount: IntFilter = null
@@ -16512,6 +16528,7 @@ enum UserResourcePolicyV2OrderField {
1651216528
CREATED_AT
1651316529
MAX_VFOLDER_COUNT
1651416530
MAX_CONCURRENT_LOGINS
16531+
MAX_API_REQUESTS_PER_WINDOW
1651516532
MAX_QUOTA_SCOPE_SIZE
1651616533
MAX_SESSION_COUNT_PER_MODEL_SESSION
1651716534
MAX_CUSTOMIZED_IMAGE_COUNT

‎docs/manager/rest-reference/openapi.json‎

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12365,7 +12365,8 @@
1236512365
},
1236612366
"rate_limit": {
1236712367
"default": 30000,
12368-
"description": "API rate limit (requests per minute).",
12368+
"deprecated": true,
12369+
"description": "Deprecated: superseded by the user resource policy field max_api_requests_per_window, which is what the rate limiter reads. This value is stored but no longer enforced.",
1236912370
"title": "Rate Limit",
1237012371
"type": "integer"
1237112372
}
@@ -12434,7 +12435,8 @@
1243412435
}
1243512436
],
1243612437
"default": null,
12437-
"description": "New API rate limit.",
12438+
"deprecated": true,
12439+
"description": "Deprecated: superseded by the user resource policy field max_api_requests_per_window, which is what the rate limiter reads. This value is stored but no longer enforced.",
1243812440
"title": "Rate Limit"
1243912441
}
1244012442
},
@@ -21910,6 +21912,18 @@
2191021912
"default": null,
2191121913
"description": "Filter by max concurrent logins."
2191221914
},
21915+
"max_api_requests_per_window": {
21916+
"anyOf": [
21917+
{
21918+
"$ref": "#/components/schemas/IntFilter"
21919+
},
21920+
{
21921+
"type": "null"
21922+
}
21923+
],
21924+
"default": null,
21925+
"description": "Filter by max API requests per rate limit window."
21926+
},
2191321927
"max_quota_scope_size": {
2191421928
"anyOf": [
2191521929
{
@@ -22024,6 +22038,7 @@
2202422038
"created_at",
2202522039
"max_vfolder_count",
2202622040
"max_concurrent_logins",
22041+
"max_api_requests_per_window",
2202722042
"max_quota_scope_size",
2202822043
"max_session_count_per_model_session",
2202922044
"max_customized_image_count"
@@ -22173,6 +22188,20 @@
2217322188
"description": "Maximum number of concurrent authenticated login sessions per user. Null means unlimited. Must be >= 1 when set. Distinct from keypair_resource_policies.max_concurrent_sessions which caps compute sessions.",
2217422189
"title": "Max Concurrent Logins"
2217522190
},
22191+
"max_api_requests_per_window": {
22192+
"anyOf": [
22193+
{
22194+
"minimum": 0,
22195+
"type": "integer"
22196+
},
22197+
{
22198+
"type": "null"
22199+
}
22200+
],
22201+
"default": null,
22202+
"description": "Maximum number of API requests allowed per user within the rate limit window. Null means unlimited.",
22203+
"title": "Max Api Requests Per Window"
22204+
},
2217622205
"max_quota_scope_size": {
2217722206
"$ref": "#/components/schemas/BinarySizeInput",
2217822207
"description": "Maximum quota scope size (e.g., '1g', '536870912')."
@@ -22238,6 +22267,27 @@
2223822267
"description": "Updated maximum number of concurrent authenticated login sessions per user. Set to null to clear (unlimited). Must be >= 1 when set. Distinct from keypair_resource_policies.max_concurrent_sessions which caps compute sessions.",
2223922268
"title": "Max Concurrent Logins"
2224022269
},
22270+
"max_api_requests_per_window": {
22271+
"anyOf": [
22272+
{
22273+
"anyOf": [
22274+
{
22275+
"type": "integer"
22276+
},
22277+
{
22278+
"$ref": "#/components/schemas/Sentinel"
22279+
}
22280+
],
22281+
"ge": 0
22282+
},
22283+
{
22284+
"type": "null"
22285+
}
22286+
],
22287+
"default": 1,
22288+
"description": "Updated maximum number of API requests allowed per user within the rate limit window. Set to null to clear (unlimited).",
22289+
"title": "Max Api Requests Per Window"
22290+
},
2224122291
"max_quota_scope_size": {
2224222292
"anyOf": [
2224322293
{

0 commit comments

Comments
 (0)