Skip to content

docs: explain difference between update and generate #536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 10, 2021
Merged

docs: explain difference between update and generate #536

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion openapi_python_client/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,11 @@ def update(
config_path: Optional[pathlib.Path] = CONFIG_OPTION,
fail_on_warning: bool = False,
) -> None:
"""Update an existing OpenAPI Client library"""
"""Update an existing OpenAPI Client library

The update command performs the same operations as generate except it does not overwrite specific metadata for the
generated client such as the README.md, .gitignore, and pyproject.toml.
"""
from . import update_existing_client

if not url and not path:
Expand Down
2 changes: 2 additions & 0 deletions usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ $ openapi-python-client generate [OPTIONS]

Update an existing OpenAPI Client library

> **Note:** The `update` command performs the same operations as `generate` except it does not overwrite specific metadata for the generated client such as the `README.md`, `.gitignore`, and `pyproject.toml`.

**Usage**:

```console
Expand Down