Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: fix incorrect version notation of GQL Field #1993

Merged
merged 41 commits into from
May 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
67891ca
chore: Correct a version notation of Resource policy GQL schema
fregataa Apr 3, 2024
7a5dc13
chore: update GraphQL schema dump
fregataa Apr 3, 2024
472c33f
add news fragment
fregataa Apr 3, 2024
ab57f7b
Merge remote-tracking branch 'origin/chore/clear-resource-policy-fiel…
fregataa Apr 3, 2024
7691529
Merge branch 'main' into chore/clear-resource-policy-field-version
fregataa Apr 4, 2024
48f2143
update all GQL field version notations
fregataa Apr 4, 2024
08ece43
update news fragment
fregataa Apr 4, 2024
068f2d8
chore: update GraphQL schema dump
fregataa Apr 4, 2024
f66c277
replace 24.03.0 version notation to backport target version
fregataa Apr 4, 2024
96a41d8
chore: update GraphQL schema dump
fregataa Apr 4, 2024
8d415b2
Merge branch 'main' into chore/clear-resource-policy-field-version
fregataa Apr 5, 2024
98f3de7
Merge remote-tracking branch 'origin/chore/clear-resource-policy-fiel…
fregataa Apr 5, 2024
3b92737
chore: update GraphQL schema dump
fregataa Apr 5, 2024
4e66e2c
correct new 'Added since' descriptons to 'Added in'
fregataa Apr 5, 2024
7e91a5d
Merge remote-tracking branch 'origin/chore/clear-resource-policy-fiel…
fregataa Apr 5, 2024
dec363c
chore: update GraphQL schema dump
fregataa Apr 5, 2024
84397ef
Merge branch 'main' into chore/clear-resource-policy-field-version
fregataa Apr 5, 2024
fd578df
Merge remote-tracking branch 'origin/chore/clear-resource-policy-fiel…
fregataa Apr 5, 2024
d2304c3
Merge branch 'main' into chore/clear-resource-policy-field-version
fregataa Apr 5, 2024
889bf8a
ci: Modified to operate even in deprecation reason changed situations
Yaminyam Apr 5, 2024
98e7d82
Update gql-inspector-checker.js
Yaminyam Apr 5, 2024
8749bf0
ci: The specification of changedReason has changed
Yaminyam Apr 5, 2024
b175ecf
Update gql-inspector-checker.js
Yaminyam Apr 5, 2024
5051f3d
fix gql inspector checker script
fregataa Apr 5, 2024
c53678f
Merge branch 'main' into chore/clear-resource-policy-field-version
fregataa Apr 9, 2024
34be533
Merge branch 'main' into chore/clear-resource-policy-field-version
fregataa Apr 18, 2024
1b2a044
Merge branch 'main' into chore/clear-resource-policy-field-version
fregataa Apr 30, 2024
10490cc
Merge branch 'main' into chore/clear-resource-policy-field-version
fregataa May 24, 2024
300ca9d
chore: update GraphQL schema dump
fregataa May 24, 2024
6ef83e7
Merge branch 'main' into chore/clear-resource-policy-field-version
fregataa May 25, 2024
d184f81
Merge remote-tracking branch 'origin/chore/clear-resource-policy-fiel…
fregataa May 25, 2024
25664d6
fix versions fields added
fregataa May 25, 2024
f4b44a9
chore: update GraphQL schema dump
fregataa May 25, 2024
3e0589f
add missing field ModifyKeyPairResourcePolicyInput.max_pending_sessio…
fregataa May 25, 2024
51be7de
Merge remote-tracking branch 'origin/chore/clear-resource-policy-fiel…
fregataa May 25, 2024
49779e7
chore: update GraphQL schema dump
fregataa May 25, 2024
0e351e6
Merge branch 'main' into chore/clear-resource-policy-field-version
fregataa May 27, 2024
da32271
fix max_session_count_per_model_session version
fregataa May 27, 2024
248d8da
correct ModifyProjectResourcePolicyInput field versions
fregataa May 27, 2024
39538ea
add comments to schema.graphql
fregataa May 27, 2024
6984d2c
Merge remote-tracking branch 'origin/chore/clear-resource-policy-fiel…
fregataa May 27, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions changes/1993.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix incorrect version notation of GQL Field.
109 changes: 62 additions & 47 deletions src/ai/backend/manager/api/schema.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ type Queries {
domain_name: String
is_active: Boolean

"""Added in 24.03.0."""
"""Added in 24.03.0. Available values: GENERAL, MODEL_STORE"""
type: [String] = ["GENERAL"]
): [Group]
image(
Expand Down Expand Up @@ -184,7 +184,7 @@ type ComputeContainer implements Item {
"""Deprecated since 24.03.0; use image_object.name"""
image: String

"""Added since 24.03.0"""
"""Added in 24.03.0."""
image_object: ImageNode
architecture: String
registry: String
Expand Down Expand Up @@ -406,10 +406,10 @@ type Group {
integration_id: String
resource_policy: String

"""Added since 24.03.0."""
"""Added in 24.03.0."""
type: String

"""Added since 24.03.0."""
"""Added in 24.03.0."""
container_registry: JSONString
scaling_groups: [String]
}
Expand Down Expand Up @@ -565,7 +565,7 @@ type ComputeSession implements Item {
occupying_slots: JSONString
occupied_slots: JSONString

"""Added in 24.03.0"""
"""Added in 24.03.0."""
requested_slots: JSONString
num_queries: BigInt
containers: [ComputeContainer]
Expand Down Expand Up @@ -593,9 +593,9 @@ type KeyPairResourcePolicy {
max_containers_per_session: Int
idle_timeout: BigInt
allowed_vfolder_hosts: JSONString
max_vfolder_count: Int @deprecated(reason: "Deprecated since 23.09.4")
max_vfolder_size: BigInt @deprecated(reason: "Deprecated since 23.09.4")
max_quota_scope_size: BigInt @deprecated(reason: "Deprecated since 23.09.4")
max_vfolder_count: Int @deprecated(reason: "Deprecated since 23.09.4.")
max_vfolder_size: BigInt @deprecated(reason: "Deprecated since 23.09.4.")
max_quota_scope_size: BigInt @deprecated(reason: "Deprecated since 23.09.6.")

"""Added in 24.03.4."""
max_pending_session_count: Int
Expand All @@ -609,20 +609,22 @@ type UserResourcePolicy {
name: String!
created_at: DateTime!

"""Added since 24.03.1. Limitation of the number of user vfolders."""
"""Added in 24.03.1. Limitation of the number of user vfolders."""
fregataa marked this conversation as resolved.
Show resolved Hide resolved
# Added in (24.03.1, 23.09.6)
max_vfolder_count: Int

"""Added since 24.03.1. Limitation of the quota size of user vfolders."""
"""Added in 24.03.1. Limitation of the quota size of user vfolders."""
# Added in (24.03.1, 23.09.2)
max_quota_scope_size: BigInt
max_vfolder_size: BigInt @deprecated(reason: "Deprecated since 23.09.1")
max_vfolder_size: BigInt @deprecated(reason: "Deprecated since 23.09.2.")

"""
Added since 23.09.10. Maximum available number of sessions per single model service which the user is in charge of.
Added in 23.09.10. Maximum available number of sessions per single model service which the user is in charge of.
"""
max_session_count_per_model_session: Int

"""
Added since 24.03.0. Maximum available number of customized images one can publish to.
Added in 24.03.0. Maximum available number of customized images one can publish to.
"""
max_customized_image_count: Int
}
Expand All @@ -632,12 +634,14 @@ type ProjectResourcePolicy {
name: String!
created_at: DateTime!

"""Added since 24.03.1. Limitation of the number of project vfolders."""
"""Added in 24.03.1. Limitation of the number of project vfolders."""
# Added in (24.03.1, 23.09.6)
max_vfolder_count: Int

"""Added since 24.03.1. Limitation of the quota size of project vfolders."""
"""Added in 24.03.1. Limitation of the quota size of project vfolders."""
# Added in (24.03.1, 23.09.2)
max_quota_scope_size: BigInt
max_vfolder_size: BigInt @deprecated(reason: "Deprecated since 23.09.1")
max_vfolder_size: BigInt @deprecated(reason: "Deprecated since 23.09.2.")
}

type ResourcePreset {
Expand Down Expand Up @@ -671,10 +675,10 @@ type StorageVolume implements Item {
performance_metric: JSONString
usage: JSONString

"""Added since 24.03.0. Name of the proxy which this volume belongs to."""
"""Added in 24.03.0. Name of the proxy which this volume belongs to."""
proxy: String

"""Added since 24.03.0. Name of the storage."""
"""Added in 24.03.0. Name of the storage."""
name: String
}

Expand Down Expand Up @@ -777,9 +781,9 @@ type PredefinedAtomicPermission {
type Endpoint implements Item {
id: ID
endpoint_id: UUID
image: String @deprecated(reason: "Deprecated since 23.09.9; use `image_object`")
image: String @deprecated(reason: "Deprecated since 23.09.9. use `image_object`")

"""Added at 23.09.9"""
"""Added in 23.09.9."""
image_object: ImageNode
domain: String
project: String
Expand All @@ -788,19 +792,19 @@ type Endpoint implements Item {
url: String
model: UUID
model_mount_destiation: String
created_user: UUID @deprecated(reason: "Deprecated since 23.09.8; use `created_user_id`")
created_user: UUID @deprecated(reason: "Deprecated since 23.09.8. use `created_user_id`")

"""Added at 23.09.8"""
"""Added in 23.09.8."""
created_user_email: String

"""Added at 23.09.8"""
"""Added in 23.09.8."""
created_user_id: UUID
session_owner: UUID @deprecated(reason: "Deprecated since 23.09.8; use `session_owner_id`")
session_owner: UUID @deprecated(reason: "Deprecated since 23.09.8. use `session_owner_id`")

"""Added at 23.09.8"""
"""Added in 23.09.8."""
session_owner_email: String

"""Added at 23.09.8"""
"""Added in 23.09.8."""
session_owner_id: UUID
tag: String
startup_command: String
Expand Down Expand Up @@ -1119,7 +1123,7 @@ type CreateGroup {
}

input GroupInput {
"""Added in 24.03.0."""
"""Added in 24.03.0. Available values: GENERAL, MODEL_STORE"""
type: String = "GENERAL"
description: String = ""
is_active: Boolean = true
Expand Down Expand Up @@ -1334,7 +1338,7 @@ input ResourceLimitInput {
max: String
}

"""Added since 24.03.0."""
"""Added in 24.03.0."""
type ForgetImageById {
ok: Boolean
msg: String
Expand Down Expand Up @@ -1390,9 +1394,9 @@ input CreateKeyPairResourcePolicyInput {
max_containers_per_session: Int!
idle_timeout: BigInt!
allowed_vfolder_hosts: JSONString
max_vfolder_count: Int @deprecated(reason: "Deprecated since 23.09.4")
max_vfolder_size: BigInt @deprecated(reason: "Deprecated since 23.09.4")
max_quota_scope_size: BigInt @deprecated(reason: "Deprecated since 23.09.4")
max_vfolder_count: Int @deprecated(reason: "Deprecated since 23.09.4.")
max_vfolder_size: BigInt @deprecated(reason: "Deprecated since 23.09.4.")
max_quota_scope_size: BigInt @deprecated(reason: "Deprecated since 23.09.6.")

"""Added in 24.03.4."""
max_pending_session_count: Int
Expand All @@ -1415,9 +1419,9 @@ input ModifyKeyPairResourcePolicyInput {
max_containers_per_session: Int
idle_timeout: BigInt
allowed_vfolder_hosts: JSONString
max_vfolder_count: Int @deprecated(reason: "Deprecated since 23.09.4")
max_vfolder_size: BigInt @deprecated(reason: "Deprecated since 23.09.4")
max_quota_scope_size: BigInt @deprecated(reason: "Deprecated since 23.09.4")
max_vfolder_count: Int @deprecated(reason: "Deprecated since 23.09.4.")
max_vfolder_size: BigInt @deprecated(reason: "Deprecated since 23.09.4.")
max_quota_scope_size: BigInt @deprecated(reason: "Deprecated since 23.09.6.")

"""Added in 24.03.4."""
max_pending_session_count: Int
Expand All @@ -1438,19 +1442,22 @@ type CreateUserResourcePolicy {
}

input CreateUserResourcePolicyInput {
"""Added since 24.03.1. Limitation of the number of user vfolders."""
"""Added in 24.03.1. Limitation of the number of user vfolders."""
# Added in (24.03.1, 23.09.6)
max_vfolder_count: Int

"""Added since 24.03.1. Limitation of the quota size of user vfolders."""
"""Added in 24.03.1. Limitation of the quota size of user vfolders."""
# Added in (24.03.1, 23.09.2)
max_quota_scope_size: BigInt

"""
Added since 24.03.1. Maximum available number of sessions per single model service which the user is in charge of.
Added in 24.03.1. Maximum available number of sessions per single model service which the user is in charge of.
"""
max_session_count_per_model_session: Int
max_vfolder_size: BigInt @deprecated(reason: "Deprecated since 23.09.2.")

"""
Added since 24.03.0. Maximum available number of customized images one can publish to.
Added in 24.03.0. Maximum available number of customized images one can publish to.
"""
max_customized_image_count: Int
}
Expand All @@ -1461,19 +1468,21 @@ type ModifyUserResourcePolicy {
}

input ModifyUserResourcePolicyInput {
"""Added since 24.03.1. Limitation of the number of user vfolders."""
"""Added in 24.03.1. Limitation of the number of user vfolders."""
# Added in (24.03.1, 23.09.6)
max_vfolder_count: Int

"""Added since 24.03.1. Limitation of the quota size of user vfolders."""
"""Added in 24.03.1. Limitation of the quota size of user vfolders."""
# Added in (24.03.1, 23.09.2)
max_quota_scope_size: BigInt

"""
Added since 24.03.1. Maximum available number of sessions per single model service which the user is in charge of.
Added in 24.03.1. Maximum available number of sessions per single model service which the user is in charge of.
"""
max_session_count_per_model_session: Int

"""
Added since 24.03.0. Maximum available number of customized images one can publish to.
Added in 24.03.0. Maximum available number of customized images one can publish to.
"""
max_customized_image_count: Int
}
Expand All @@ -1490,11 +1499,14 @@ type CreateProjectResourcePolicy {
}

input CreateProjectResourcePolicyInput {
"""Added since 24.03.1. Limitation of the number of project vfolders."""
"""Added in 24.03.1. Limitation of the number of project vfolders."""
# Added in (24.03.1, 23.09.6)
max_vfolder_count: Int

"""Added since 24.03.1. Limitation of the quota size of project vfolders."""
"""Added in 24.03.1. Limitation of the quota size of project vfolders."""
# Added in (24.03.1, 23.09.2)
max_quota_scope_size: BigInt
max_vfolder_size: BigInt @deprecated(reason: "Deprecated since 23.09.2.")
}

type ModifyProjectResourcePolicy {
Expand All @@ -1503,11 +1515,14 @@ type ModifyProjectResourcePolicy {
}

input ModifyProjectResourcePolicyInput {
"""Added since 24.03.1. Limitation of the number of project vfolders."""
"""Added in 23.09.6. Limitation of the number of project vfolders."""
# Added in (24.03.1, 23.09.6)
max_vfolder_count: Int

"""Added since 24.03.1. Limitation of the quota size of project vfolders."""
"""Added in 23.09.2. Limitation of the quota size of project vfolders."""
# Added in (24.03.1, 23.09.2)
max_quota_scope_size: BigInt
max_vfolder_size: BigInt @deprecated(reason: "Deprecated since 23.09.2.")
}

type DeleteProjectResourcePolicy {
Expand Down Expand Up @@ -1669,7 +1684,7 @@ type ModifyEndpoint {
ok: Boolean
msg: String

"""Added at 23.09.8"""
"""Added in 23.09.8."""
endpoint: Endpoint
}

Expand Down
18 changes: 9 additions & 9 deletions src/ai/backend/manager/models/endpoint.py
Original file line number Diff line number Diff line change
Expand Up @@ -429,8 +429,8 @@ class Meta:
interfaces = (Item,)

endpoint_id = graphene.UUID()
image = graphene.String(deprecation_reason="Deprecated since 23.09.9; use `image_object`")
image_object = graphene.Field(ImageNode, description="Added at 23.09.9")
image = graphene.String(deprecation_reason="Deprecated since 23.09.9. use `image_object`")
image_object = graphene.Field(ImageNode, description="Added in 23.09.9.")
domain = graphene.String()
project = graphene.String()
resource_group = graphene.String()
Expand All @@ -439,15 +439,15 @@ class Meta:
model = graphene.UUID()
model_mount_destiation = graphene.String()
created_user = graphene.UUID(
deprecation_reason="Deprecated since 23.09.8; use `created_user_id`"
deprecation_reason="Deprecated since 23.09.8. use `created_user_id`"
)
created_user_email = graphene.String(description="Added at 23.09.8")
created_user_id = graphene.UUID(description="Added at 23.09.8")
created_user_email = graphene.String(description="Added in 23.09.8.")
created_user_id = graphene.UUID(description="Added in 23.09.8.")
session_owner = graphene.UUID(
deprecation_reason="Deprecated since 23.09.8; use `session_owner_id`"
deprecation_reason="Deprecated since 23.09.8. use `session_owner_id`"
)
session_owner_email = graphene.String(description="Added at 23.09.8")
session_owner_id = graphene.UUID(description="Added at 23.09.8")
session_owner_email = graphene.String(description="Added in 23.09.8.")
session_owner_id = graphene.UUID(description="Added in 23.09.8.")
tag = graphene.String()
startup_command = graphene.String()
bootstrap_script = graphene.String()
Expand Down Expand Up @@ -709,7 +709,7 @@ class Arguments:

ok = graphene.Boolean()
msg = graphene.String()
endpoint = graphene.Field(lambda: Endpoint, required=False, description="Added at 23.09.8")
endpoint = graphene.Field(lambda: Endpoint, required=False, description="Added in 23.09.8.")

@classmethod
async def mutate(
Expand Down
4 changes: 3 additions & 1 deletion src/ai/backend/manager/models/gql.py
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,9 @@ class Queries(graphene.ObjectType):
type=graphene.List(
graphene.String,
default_value=[ProjectType.GENERAL.name],
description=("Added in 24.03.0."),
description=(
f"Added in 24.03.0. Available values: {', '.join([p.name for p in ProjectType])}"
),
),
)

Expand Down
8 changes: 5 additions & 3 deletions src/ai/backend/manager/models/group.py
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,8 @@ class Group(graphene.ObjectType):
allowed_vfolder_hosts = graphene.JSONString()
integration_id = graphene.String()
resource_policy = graphene.String()
type = graphene.String(description="Added since 24.03.0.")
container_registry = graphene.JSONString(description="Added since 24.03.0.")
type = graphene.String(description="Added in 24.03.0.")
container_registry = graphene.JSONString(description="Added in 24.03.0.")

scaling_groups = graphene.List(lambda: graphene.String)

Expand Down Expand Up @@ -431,7 +431,9 @@ class GroupInput(graphene.InputObjectType):
type = graphene.String(
required=False,
default_value="GENERAL",
description=("Added in 24.03.0."),
description=(
f"Added in 24.03.0. Available values: {', '.join([p.name for p in ProjectType])}"
),
)
description = graphene.String(required=False, default_value="")
is_active = graphene.Boolean(required=False, default_value=True)
Expand Down
2 changes: 1 addition & 1 deletion src/ai/backend/manager/models/image.py
Original file line number Diff line number Diff line change
Expand Up @@ -865,7 +865,7 @@ async def _rescan_task(reporter: ProgressReporter) -> None:


class ForgetImageById(graphene.Mutation):
"""Added since 24.03.0."""
"""Added in 24.03.0."""

allowed_roles = (
UserRole.SUPERADMIN,
Expand Down
2 changes: 1 addition & 1 deletion src/ai/backend/manager/models/kernel.py
Original file line number Diff line number Diff line change
Expand Up @@ -801,7 +801,7 @@ class Meta:

# image
image = graphene.String(description="Deprecated since 24.03.0; use image_object.name")
image_object = graphene.Field(ImageNode, description="Added since 24.03.0")
image_object = graphene.Field(ImageNode, description="Added in 24.03.0.")
architecture = graphene.String()
registry = graphene.String()

Expand Down