Skip to content

Commit

Permalink
Add docs on regeneration
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Hallett committed Oct 4, 2023
1 parent 65d80d0 commit 0a4a885
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,20 @@ If you prefer an [asyncio](https://docs.python.org/3/library/asyncio.html) clien
clientele generate -f path/to/file.json -o my_client/ --asyncio t
```

### Regenerating

At times you may wish to regenerate the client. This could be because the API has updated or you just want to use a newer version of clientele.

To force a regeneration you must pass the `--regen` or `-r` argument, for example:

```sh
clientele generate -f example_openapi_specs/best.json -o my_client/ --regen t
```

!!! note

You can copy and paste the command from the `MANIFEST.md` file in your previously-generated client for a quick and easy regeneration.

## `validate`

Validate lets you check if an OpenAPI schema will work with clientele.
Expand Down

0 comments on commit 0a4a885

Please sign in to comment.