JingsongLi commented on code in PR #5317: URL: https://github.com/apache/paimon/pull/5317#discussion_r2004773465
########## paimon-open-api/rest-catalog-open-api.yaml: ########## @@ -28,6 +28,151 @@ servers: - url: http://localhost:8080 description: Server URL in Development environment paths: + /v1/catalogs: + post: + tags: + - Catalogs + operationId: createCatalog + summary: Create a catalog + description: | + Creates a new catalog instance. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCatalogRequest' + responses: + '200': + description: The new catalog was successfully created. + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCatalogResponse' + "409": + description: Resource has exist + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + "500": + description: Internal Server Error + get: + tags: + - Catalogs + parameters: + - name: maxResults + in: query + description: | + Maximum number of catalogs to return. + - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; + - when set to 0 or less than 0, the page length is set to a server configured value; + schema: + type: integer + format: int32 + maximum: 100 + required: false + - name: pageToken + in: query + description: | + Opaque pagination token to go to next page based on previous query. + schema: + type: string + required: false + operationId: listCatalogs + summary: List catalogs + description: | + Lists the available catalogs. + responses: + '200': + description: The catalog list was successfully retrieved. + content: + application/json: + schema: + $ref: '#/components/schemas/ListCatalogsResponse' + '500': + description: Internal Server Error + /v1/catalogs/{name}: + parameters: + - name: name + in: path + description: The name of the catalog. + required: true + schema: + type: string + get: + tags: + - Catalogs + operationId: getCatalog + summary: Get a catalog + description: | + Gets the specified catalog. + responses: + '200': + description: The catalog was successfully retrieved. + content: + application/json: + schema: + $ref: '#/components/schemas/GetCatalogResponse' + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + patch: + tags: + - Catalogs + operationId: alterCatalog + summary: Alter a catalog + description: | + Alter the catalog that matches the supplied name. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AlterCatalogRequest' + responses: + '200': + description: The catalog was successfully altered. + content: + application/json: + schema: + $ref: '#/components/schemas/AlterCatalogResponse' + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + delete: + tags: + - Catalogs + operationId: dropCatalog + summary: Drop a catalog + description: | + Drop the catalog that matches the supplied name. + parameters: + - name: cascade Review Comment: remove this -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@paimon.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
