rahil-c commented on code in PR #705: URL: https://github.com/apache/incubator-xtable/pull/705#discussion_r2067834240
########## spec/rest-service-open-api.yaml: ########## @@ -0,0 +1,241 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +openapi: 3.0.3 +info: + title: XTable REST Service API + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + version: 0.0.1 + description: | + A REST API for initiating metadata conversion using Apache XTable. + +servers: + - url: "{scheme}://{host}/{prefix}" + description: Server URL when the port can be inferred from the scheme + variables: + scheme: + description: The scheme of the URI, either http or https. + default: https + host: + description: The host address for the specified server + default: localhost + prefix: + description: Optional prefix to be appended to all routes + default: "" + - url: "{scheme}://{host}:{port}/{prefix}" + description: Generic base server URL, with all parts configurable + variables: + scheme: + description: The scheme of the URI, either http or https. + default: https + host: + description: The host address for the specified server + default: localhost + port: + description: The port used when addressing the host + default: "8080" + prefix: + description: Optional prefix to be appended to all routes + default: "" + +paths: + /v1/conversion/table: + post: + tags: + - XTable Service API + summary: Initiate XTable's runSync process to convert a source table format to the requested target table formats. + description: | + Reads the source table metadata from storage, converts it to the requested + target formats. + operationId: convertTable Review Comment: in general these `operationId` are just tags for the api, are useful when referring another api via a link. Here is the open api spec doc for it https://swagger.io/docs/specification/v3_0/paths-and-operations/ <img width="897" alt="Screenshot 2025-04-29 at 9 28 55 PM" src="https://github.com/user-attachments/assets/e22333e8-bbb4-4ab2-9eda-df7a5b4eb605"; /> See this example here in iceberg rest spec https://github.com/apache/iceberg/blob/main/open-api/rest-catalog-open-api.yaml#L653, usually the `description` and `summary` is enough context for an api, and the `operationId` does not require additional clarity. -- 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: commits-unsubscr...@xtable.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
