This is an automated email from the ASF dual-hosted git repository.
jshao pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new d32df9e57c [MINOR] fix(docs): Fix models.yaml (#7157)
d32df9e57c is described below
commit d32df9e57cbf0257d106a21330556edf40dfff3d
Author: Lord of Abyss <[email protected]>
AuthorDate: Wed May 14 10:31:43 2025 +0800
[MINOR] fix(docs): Fix models.yaml (#7157)
### What changes were proposed in this pull request?
Fix models.yaml
### Why are the changes needed?
MINOR
### Does this PR introduce _any_ user-facing change?
Update openAPI docs.
### How was this patch tested?
local test.
---
docs/open-api/models.yaml | 90 +++++++++++++++++++++++++++++++----------------
1 file changed, 59 insertions(+), 31 deletions(-)
diff --git a/docs/open-api/models.yaml b/docs/open-api/models.yaml
index d16c739e4e..305455a56f 100644
--- a/docs/open-api/models.yaml
+++ b/docs/open-api/models.yaml
@@ -176,36 +176,6 @@ paths:
"5xx":
$ref: "./openapi.yaml#/components/responses/ServerErrorResponse"
-
- put:
- tags:
- - model
- summary: Update model version
- operationId: updateModelVersions
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ModelVersionUpdatesRequest"
- responses:
- "200":
- $ref: "#/components/responses/ModelVersionResponse"
- "400":
- $ref: "./openapi.yaml#/components/responses/BadRequestErrorResponse"
- "404":
- description: Not Found - The target model or model version does not
exist
- content:
- application/vnd.gravitino.v1+json:
- schema:
- $ref: "./openapi.yaml#/components/schemas/ErrorModel"
- examples:
- NoSuchModelException:
- $ref: "#/components/examples/NoSuchModelException"
- NoSuchModelVersionException:
- $ref: "#/components/examples/NoSuchModelVersionException"
- "5xx":
- $ref: "./openapi.yaml#/components/responses/ServerErrorResponse"
-
post:
tags:
- model
@@ -284,6 +254,35 @@ paths:
"5xx":
$ref: "./openapi.yaml#/components/responses/ServerErrorResponse"
+ put:
+ tags:
+ - model
+ summary: Update model version
+ operationId: updateModelVersions
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ModelVersionUpdatesRequest"
+ responses:
+ "200":
+ $ref: "#/components/responses/ModelVersionResponse"
+ "400":
+ $ref: "./openapi.yaml#/components/responses/BadRequestErrorResponse"
+ "404":
+ description: Not Found - The target model or model version does not
exist
+ content:
+ application/vnd.gravitino.v1+json:
+ schema:
+ $ref: "./openapi.yaml#/components/schemas/ErrorModel"
+ examples:
+ NoSuchModelException:
+ $ref: "#/components/examples/NoSuchModelException"
+ NoSuchModelVersionException:
+ $ref: "#/components/examples/NoSuchModelVersionException"
+ "5xx":
+ $ref: "./openapi.yaml#/components/responses/ServerErrorResponse"
+
/metalakes/{metalake}/catalogs/{catalog}/schemas/{schema}/models/{model}/aliases/{alias}:
parameters:
- $ref: "./openapi.yaml#/components/parameters/metalake"
@@ -301,7 +300,7 @@ paths:
"200":
$ref: "#/components/responses/ModelVersionResponse"
"404":
- description: Not Found - The target model version does not exist
+ description: Not Found - The target model version does not exist.
content:
application/vnd.gravitino.v1+json:
schema:
@@ -325,6 +324,35 @@ paths:
"5xx":
$ref: "./openapi.yaml#/components/responses/ServerErrorResponse"
+ put:
+ tags:
+ - model
+ summary: Update model version by alias
+ operationId: updateModelVersionsByAlias
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ModelVersionUpdatesRequest"
+ responses:
+ "200":
+ $ref: "#/components/responses/ModelVersionResponse"
+ "400":
+ $ref: "./openapi.yaml#/components/responses/BadRequestErrorResponse"
+ "404":
+ description: Not Found - The target model or model version does not
exist.
+ content:
+ application/vnd.gravitino.v1+json:
+ schema:
+ $ref: "./openapi.yaml#/components/schemas/ErrorModel"
+ examples:
+ NoSuchModelException:
+ $ref: "#/components/examples/NoSuchModelException"
+ NoSuchModelVersionException:
+ $ref: "#/components/examples/NoSuchModelVersionException"
+ "5xx":
+ $ref: "./openapi.yaml#/components/responses/ServerErrorResponse"
+
components:
parameters:
version:
