Skip to content

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

Open
leoneperdigao wants to merge 1 commit intoUniversal-Commerce-Protocol:mainfrom
leoneperdigao:ucp/136-docs-service-definition-in-docs-does-not-match
Open

docs: auto-generate service definition table from schema#285
leoneperdigao wants to merge 1 commit intoUniversal-Commerce-Protocol:mainfrom
leoneperdigao:ucp/136-docs-service-definition-in-docs-does-not-match

Conversation

@leoneperdigao
Copy link

Description

Replace the hardcoded service definition table in the Overview page with the extension_schema_fields macro, which auto-generates the table from the actual service.json schema.

The previous hardcoded table described an outdated nested structure (rest.schema, rest.endpoint, mcp.schema, mcp.endpoint, etc.) that no longer matches the current flat transport-based schema which uses transport, schema, and endpoint as top-level fields.

By using the same macro approach already used for the Capability Definition table, the service definition documentation will now stay automatically in sync with any future schema changes.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

Fixes #136

Replace the hardcoded service definition table with the
extension_schema_fields macro to keep the documentation in sync with
the actual service.json schema. The previous table described an outdated
nested structure (rest.schema, mcp.endpoint, etc.) that no longer
matches the current flat transport-based schema.

Fixes Universal-Commerce-Protocol#136
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Service definition in docs does not match actual schema

1 participant