Skip to content

docs: auto-generate service definition table from schema #285

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

Open
leoneperdigao wants to merge 1 commit into
base: main
Choose a base branch
from
+1 −14
Open

docs: auto-generate service definition table from schema #285

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
15 changes: 1 addition & 14 deletions docs/specification/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,20 +115,7 @@ standard formats:

#### Service Definition

| Field | Type | Required | Description |
| ----------------- | ------ | -------- | ----------------------------------- |
| `version` | string | Yes | Service version (YYYY-MM-DD format) |
| `spec` | string | Yes | URL to service documentation |
| `rest` | object | No | REST transport binding |
| `rest.schema` | string | Yes | URL to OpenAPI spec (JSON) |
| `rest.endpoint` | string | Yes | Business's REST endpoint |
| `mcp` | object | No | MCP transport binding |
| `mcp.schema` | string | Yes | URL to OpenRPC spec (JSON) |
| `mcp.endpoint` | string | Yes | Business's MCP endpoint |
| `a2a` | object | No | A2A transport binding |
| `a2a.endpoint` | string | Yes | Business's A2A Agent Card URL |
| `embedded` | string | No | Embedded transport binding |
| `embedded.schema` | string | Yes | URL to OpenRPC spec (JSON) |
{{ extension_schema_fields('service.json#/$defs/platform_schema', 'overview') }}

Transport definitions **MUST** be thin: they declare method names and reference
base schemas only. See [Requirements](#requirements) for details.
Expand Down