Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions .changeset/fence-api-endpoint-listings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
"@objectstack/spec": patch
---

The `api/automation-api` and `api/package-api` reference pages publish their endpoint listing as a code block instead of a run-on line.

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.

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.
2 changes: 2 additions & 0 deletions content/docs/references/api/automation-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ triggering executions, and querying execution history.
Base path: /api/automation

**Endpoints**
```
GET /api/automation — List flows
GET /api/automation/:name — Get flow
POST /api/automation — Create flow
Expand All @@ -22,6 +23,7 @@ POST /api/automation/:name/trigger — Trigger flow execution
POST /api/automation/:name/toggle — Enable/disable flow
GET /api/automation/:name/runs — List execution runs
GET /api/automation/:name/runs/:runId — Get single execution run
```

<Callout type="info">
**Source:** `packages/spec/src/api/automation-api.zod.ts`
Expand Down
2 changes: 2 additions & 0 deletions content/docs/references/api/package-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ REST API endpoint schemas for package lifecycle management.
Base path: /api/v1/packages

**Endpoints**
```
POST /api/v1/packages/install — Install a package
POST /api/v1/packages/upgrade — Upgrade a package
POST /api/v1/packages/resolve-dependencies — Resolve dependencies
Expand All @@ -20,6 +21,7 @@ GET /api/v1/packages — List installed packages
GET /api/v1/packages/:packageId — Get package details
POST /api/v1/packages/:packageId/rollback — Rollback a package
DELETE /api/v1/packages/:packageId — Uninstall a package
```

<Callout type="info">
**Source:** `packages/spec/src/api/package-api.zod.ts`
Expand Down
2 changes: 2 additions & 0 deletions packages/spec/src/api/automation-api.zod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import { ExecutionLogSchema, ExecutionStatus, FlowRunSummarySchema } from '../au
* Base path: /api/automation
*
* @example Endpoints
* ```
* GET /api/automation — List flows
* GET /api/automation/:name — Get flow
* POST /api/automation — Create flow
Expand All @@ -23,6 +24,7 @@ import { ExecutionLogSchema, ExecutionStatus, FlowRunSummarySchema } from '../au
* POST /api/automation/:name/toggle — Enable/disable flow
* GET /api/automation/:name/runs — List execution runs
* GET /api/automation/:name/runs/:runId — Get single execution run
* ```
*/

// ==========================================
Expand Down
2 changes: 2 additions & 0 deletions packages/spec/src/api/package-api.zod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import { ArtifactReferenceSchema } from '../cloud/marketplace.zod';
* Base path: /api/v1/packages
*
* @example Endpoints
* ```
* POST /api/v1/packages/install — Install a package
* POST /api/v1/packages/upgrade — Upgrade a package
* POST /api/v1/packages/resolve-dependencies — Resolve dependencies
Expand All @@ -25,6 +26,7 @@ import { ArtifactReferenceSchema } from '../cloud/marketplace.zod';
* GET /api/v1/packages/:packageId — Get package details
* POST /api/v1/packages/:packageId/rollback — Rollback a package
* DELETE /api/v1/packages/:packageId — Uninstall a package
* ```
*/

// ==========================================
Expand Down
Loading