[GitHub] [iceberg] nastra commented on a diff in pull request #7751: Open-API: Add Python code as an example

["nastra (via GitHub)" <gi...@apache.org>]

nastra commented on code in PR #7751:
URL: https://github.com/apache/iceberg/pull/7751#discussion_r1213067357


##########
open-api/README.md:
##########
@@ -0,0 +1,23 @@
+# Open API spec
+
+The `rest-catalog-open-api.yaml` defines the REST catalog interface.
+
+## Lint
+
+To make sure that the open-api definition is valid, you can run the `lint` command:
+
+```sh
+make install
+make lint
+```
+
+## Generate Python code
+
+When reviewing changes in the spec, it helps to see what kind of code is being generated from the spec. We generate Python code to make this process easier. Before committing, make sure to run:

Review Comment:
   I'm guessing you mean before committing changes to the Spec with `Before committing`? Maybe we can simplify/change this sentence to:
   
   
   *When updating `rest-catalog-open-api.yaml`, make sure to update `rest-catalog-open-api.py` with the spec changes by running the following commands:*
   ```sh
   make install
   make generate
   ```



-- 
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-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org