Skip to content

Commit

Permalink
Updated developer guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ckunki committed Apr 17, 2024
1 parent 42d2830 commit b2c3ae3
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions doc/developer_guide/developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,21 @@ In order to regenerate the model layer please use the following command line:
```shell
poetry run nox generate-api
```

### Change the Source URL of API Model JSON Definition

If you want to retrieve the JSON definition for the API model from a different
source then just edit file `noxfile.py`.

Candidates
* https://cloud.exasol.com/openapi.json
* https://cloud-staging.exasol.com/openapi.json
* https://cloud-staging.exasol.com/internal-api.json

### Read JSON definition From a Local File

Use CLI option `--path` to read the JSON definition from a local file instead of a URL:

```python
"--path", "/path/to/openapi.json",
```

0 comments on commit b2c3ae3

Please sign in to comment.