Skip to content

Commit efd6b43

Browse files
claude[bot]claude
andauthored
docs(spec): fence the endpoint listings in the automation and package API docblocks (#16961)
`api/automation-api` and `api/package-api` captioned a listing with `@example Endpoints` and then wrote its rows as ordinary prose lines. Consecutive non-blank lines are one markdown paragraph and the docs site loads no `remark-breaks`, so each soft break rendered as a space and both pages published their whole listing as one run-on line with the author's column alignment collapsed. Fence both listings at the source, exactly as the neighbouring `api/odata` and `api/metadata` docblocks already do, and regenerate the two reference pages. The renderer is not touched: it preserves the source's own line layout deliberately, and a rule that guessed which prose runs are really tables is the shape-sniffing its header rejects. Claude-Session: https://claude.ai/code/session_016N6xmWt5hYm94ffVEwGH8x Co-authored-by: Claude <noreply@anthropic.com>
1 parent bc1c1ce commit efd6b43

5 files changed

Lines changed: 17 additions & 0 deletions

File tree

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
"@objectstack/spec": patch
3+
---
4+
5+
The `api/automation-api` and `api/package-api` reference pages publish their endpoint listing as a code block instead of a run-on line.
6+
7+
Both module docblocks captioned a listing with `@example Endpoints` and then wrote its rows as ordinary prose lines. Consecutive non-blank lines are one markdown paragraph, and the docs site loads no `remark-breaks`, so every soft line break became a space: the nine automation rows and the eight package rows each arrived as a single run-on sentence with the author's column alignment collapsed away. The listings are now fenced at the source, the way the neighbouring `api/odata` and `api/metadata` docblocks already fence theirs, and the two generated pages render a block.
8+
9+
The fix is in the two `.zod.ts` docblocks — which ship to consumers under this package's `src/**/*.zod.ts` — and in the pages regenerated from them. No schema, export, accept set or runtime behaviour changes.

content/docs/references/api/automation-api.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ triggering executions, and querying execution history.
1313
Base path: /api/automation
1414

1515
**Endpoints**
16+
```
1617
GET /api/automation — List flows
1718
GET /api/automation/:name — Get flow
1819
POST /api/automation — Create flow
@@ -22,6 +23,7 @@ POST /api/automation/:name/trigger — Trigger flow execution
2223
POST /api/automation/:name/toggle — Enable/disable flow
2324
GET /api/automation/:name/runs — List execution runs
2425
GET /api/automation/:name/runs/:runId — Get single execution run
26+
```
2527

2628
<Callout type="info">
2729
**Source:** `packages/spec/src/api/automation-api.zod.ts`

content/docs/references/api/package-api.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ REST API endpoint schemas for package lifecycle management.
1212
Base path: /api/v1/packages
1313

1414
**Endpoints**
15+
```
1516
POST /api/v1/packages/install — Install a package
1617
POST /api/v1/packages/upgrade — Upgrade a package
1718
POST /api/v1/packages/resolve-dependencies — Resolve dependencies
@@ -20,6 +21,7 @@ GET /api/v1/packages — List installed packages
2021
GET /api/v1/packages/:packageId — Get package details
2122
POST /api/v1/packages/:packageId/rollback — Rollback a package
2223
DELETE /api/v1/packages/:packageId — Uninstall a package
24+
```
2325

2426
<Callout type="info">
2527
**Source:** `packages/spec/src/api/package-api.zod.ts`

packages/spec/src/api/automation-api.zod.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import { ExecutionLogSchema, ExecutionStatus, FlowRunSummarySchema } from '../au
1414
* Base path: /api/automation
1515
*
1616
* @example Endpoints
17+
* ```
1718
* GET /api/automation — List flows
1819
* GET /api/automation/:name — Get flow
1920
* POST /api/automation — Create flow
@@ -23,6 +24,7 @@ import { ExecutionLogSchema, ExecutionStatus, FlowRunSummarySchema } from '../au
2324
* POST /api/automation/:name/toggle — Enable/disable flow
2425
* GET /api/automation/:name/runs — List execution runs
2526
* GET /api/automation/:name/runs/:runId — Get single execution run
27+
* ```
2628
*/
2729

2830
// ==========================================

packages/spec/src/api/package-api.zod.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ import { ArtifactReferenceSchema } from '../cloud/marketplace.zod';
1717
* Base path: /api/v1/packages
1818
*
1919
* @example Endpoints
20+
* ```
2021
* POST /api/v1/packages/install — Install a package
2122
* POST /api/v1/packages/upgrade — Upgrade a package
2223
* POST /api/v1/packages/resolve-dependencies — Resolve dependencies
@@ -25,6 +26,7 @@ import { ArtifactReferenceSchema } from '../cloud/marketplace.zod';
2526
* GET /api/v1/packages/:packageId — Get package details
2627
* POST /api/v1/packages/:packageId/rollback — Rollback a package
2728
* DELETE /api/v1/packages/:packageId — Uninstall a package
29+
* ```
2830
*/
2931

3032
// ==========================================

0 commit comments

Comments
 (0)