kbendick commented on a change in pull request #3561: URL: https://github.com/apache/iceberg/pull/3561#discussion_r757707515
########## File path: rest_docs/rest-catalog-v0.1-SNAPSHOT.md ########## @@ -0,0 +1,1810 @@ +--- +title: Apache Iceberg REST Catalog API v1.0.0 +language_tabs: + - shell: Shell + - java: Java +language_clients: + - shell: "" + - java: "" +toc_footers: [] +includes: [] +search: true +highlight_theme: darkula +headingLevel: 2 + +--- + +<!-- Generator: Widdershins v4.0.1 --> + +<h1 id="apache-iceberg-rest-catalog-api">Apache Iceberg REST Catalog API v1.0.0</h1> + +> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu. + +Defines the specification for the first version of the REST Catalog API. Implementations should support both Iceberg table specs v1 and v2, with priority given to v2. + +Base URLs: + +* <a href="http://127.0.0.1:1080";>http://127.0.0.1:1080</a> Review comment: So one things I should emphasize is that the entire markdown file was autogenerated from the YAML. That said, I did put the base url and port into the open api document, more just for testing purposes (with use with a mock server library to be specific). I can look into how to make them configurable in an OpenAPI document and then would be happy to do that. We can also add commands or instructions on how to generate the markdown oneself if they'd like (or maybe the generator tool I'm using will respect the user's entered host and port in the markdown if that's an option in an OpenAPI document). If you happen to know how off the top of your head or have a recommended way to add those as config options to the OpenAPI doc, by all means I'd love to hear it. I'll also look to see if there's a standard way to do that as well. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
