diff --git a/changelog/+schema-cli-short-help.fixed.md b/changelog/+schema-cli-short-help.fixed.md new file mode 100644 index 00000000..830263dc --- /dev/null +++ b/changelog/+schema-cli-short-help.fixed.md @@ -0,0 +1 @@ +Fixed the `load` and `check` command descriptions in the `infrahubctl schema` help output and generated docs, which were cut off mid-sentence. diff --git a/docs/docs/infrahubctl/infrahubctl-schema.mdx b/docs/docs/infrahubctl/infrahubctl-schema.mdx index 6cffe318..ec9f24fe 100644 --- a/docs/docs/infrahubctl/infrahubctl-schema.mdx +++ b/docs/docs/infrahubctl/infrahubctl-schema.mdx @@ -16,8 +16,8 @@ $ infrahubctl schema [OPTIONS] COMMAND [ARGS]... **Commands**: -* `load`: Load one or multiple schema files into... -* `check`: Check if schema files are valid and what... +* `load`: Load one or multiple schema files into Infrahub. +* `check`: Check if schema files are valid and their impact on Infrahub. * `export`: Export the schema from Infrahub as YAML... * `list`: List all available schema kinds. * `show`: Show details for a specific schema kind. diff --git a/infrahub_sdk/ctl/schema.py b/infrahub_sdk/ctl/schema.py index 9114d251..54ae82db 100644 --- a/infrahub_sdk/ctl/schema.py +++ b/infrahub_sdk/ctl/schema.py @@ -193,7 +193,7 @@ def get_node( return None -@app.command() +@app.command(short_help="Load one or multiple schema files into Infrahub.") @catch_exception(console=console) async def load( schemas: list[Path], @@ -245,7 +245,7 @@ async def load( await asyncio.sleep(delay=1) -@app.command() +@app.command(short_help="Check if schema files are valid and their impact on Infrahub.") @catch_exception(console=console) async def check( schemas: list[Path],