Skip to content

Commit b02cb64

Browse files
committed
docs(marketplace): fix markdownlint issues in design and plan specs
1 parent e9325c9 commit b02cb64

2 files changed

Lines changed: 10 additions & 1 deletion

File tree

dev/specs/marketplace-browsing/design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ All commands live in `infrahub_sdk/ctl/marketplace.py`, registered on the existi
3232
`AsyncTyper` `app`, alongside `get`.
3333

3434
| Command | Purpose |
35-
|---|---|
35+
| --- | --- |
3636
| `marketplace list [--collections] [--limit N] [--json]` | Browse all schemas (default) or collections |
3737
| `marketplace search <term> [--collections] [--limit N] [--json]` | Browse filtered by the API `search=` param |
3838
| `marketplace show <namespace/name> [--collection] [--json]` | Full detail of one schema or collection |

dev/specs/marketplace-browsing/plan.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,12 @@
3535
Adds the core listing machinery plus the `list` command. `search` (Task 2) reuses `_run_listing`.
3636

3737
**Files:**
38+
3839
- Modify: `infrahub_sdk/ctl/marketplace.py`
3940
- Test: `tests/unit/ctl/test_marketplace_app.py`
4041

4142
**Interfaces:**
43+
4244
- Produces:
4345
- `_list_url(base_url: str, item_type: MarketplaceItemType) -> str`
4446
- `_fetch_listing(client: httpx.AsyncClient, base_url: str, item_type: MarketplaceItemType, *, search: str | None, limit: int | None) -> tuple[list[dict[str, Any]], int]`
@@ -357,10 +359,12 @@ git commit -m "feat(ctl): add marketplace list command"
357359
Thin command over `_run_listing` with the `search=` term.
358360

359361
**Files:**
362+
360363
- Modify: `infrahub_sdk/ctl/marketplace.py`
361364
- Test: `tests/unit/ctl/test_marketplace_app.py`
362365

363366
**Interfaces:**
367+
364368
- Consumes: `_run_listing` (Task 1), `_listing_json`/`_schema_item` test helpers (Task 1).
365369
- Produces: `search` command (function `search`).
366370

@@ -477,10 +481,12 @@ git commit -m "feat(ctl): add marketplace search command"
477481
### Task 3: `show` command — schema (auto-detect, versions, tags, dependencies, `--json`)
478482

479483
**Files:**
484+
480485
- Modify: `infrahub_sdk/ctl/marketplace.py`
481486
- Test: `tests/unit/ctl/test_marketplace_app.py`
482487

483488
**Interfaces:**
489+
484490
- Produces:
485491
- `_detail_url(base_url: str, item_type: MarketplaceItemType, namespace: str, name: str) -> str`
486492
- `_fetch_detail(client: httpx.AsyncClient, base_url: str, namespace: str, name: str, *, force_collection: bool) -> tuple[MarketplaceItemType, dict[str, Any]]`
@@ -731,9 +737,11 @@ git commit -m "feat(ctl): add marketplace show command for schemas"
731737
### Task 4: `show` collection (members, `--collection` force, not-found)
732738

733739
**Files:**
740+
734741
- Modify: `tests/unit/ctl/test_marketplace_app.py` (behaviour already implemented in Task 3; this task proves the collection path and not-found handling)
735742

736743
**Interfaces:**
744+
737745
- Consumes: `show` command, `_fetch_detail`, `_render_detail` (Task 3).
738746

739747
- [ ] **Step 1: Write the collection `show` tests**
@@ -838,6 +846,7 @@ git commit -m "test(ctl): cover marketplace show for collections and errors"
838846
### Task 5: Docs regeneration and changelog
839847

840848
**Files:**
849+
841850
- Modify (generated): `docs/docs/infrahubctl/infrahubctl-marketplace.mdx`
842851
- Create: `changelog/<issue>.added.md`
843852

0 commit comments

Comments
 (0)