actions/opensearch-pyd
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add a nox session for client generator. (#554)

Browse Source 
Signed-off-by: dblock <dblock@amazon.com>
This commit is contained in:
Daniel (dB.) Doubrovkine
2023-10-26 11:55:25 -04:00
committed by GitHub
parent ebd50e0515
commit 17794bab75
3 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
DEVELOPER_GUIDE.md
+6 -8
View File
@@ -1,10 +1,10 @@
- [Developer Guide](#developer-guide)
- [Prerequisites](#prerequisites)
- [Docker Image Installation](#docker-setup)
- [Install Docker Image](#install-docker-image)
- [Running Tests](#running-tests)
- [Integration Tests](#integration-tests)
- [Linter](#linter)
- [Documentation](#documentation)
- [Running Python Client Generator](#running-python-client-generator)
- [Client Code Generator](#client-code-generator)
# Developer Guide
@@ -115,12 +115,10 @@ make html
Open `opensearch-py/docs/build/html/index.html` to see results.
## Running Python Client Generator
## Client Code Generator
The following code executes a python client generator that updates the client by utilizing the [openapi specifications](https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json) found in the "opensearch-api-specification" repository. This process allows for the automatic generation and synchronization of the client code with the latest API specifications.
OpenSearch publishes an [OpenAPI specification](https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json) in the [opensearch-api-specification](https://github.com/opensearch-project/opensearch-api-specification) repository, which is used to auto-generate the less interesting parts of the client.
```
cd opensearch-py
python utils/generate-api.py
nox -rs format
nox -rs generate
```