Skip to content

docs(api): enforce OpenAPI conventions and response coverage - #1131

Merged
aaltshuler merged 1 commit into
ModernRelay:mainfrom
aaltshuler:codex/http-api-conventions-lint
Oct 22, 2026
Merged

aaltshuler merged 1 commit into
ModernRelay:mainfrom
aaltshuler:codex/http-api-conventions-lint

Conversation

@aaltshuler

Copy link
Copy Markdown
Contributor

The generated HTTP specification omitted unknown write outcomes and several parameter bounds and descriptions. This adds the missing documentation and a convention check in the existing OpenAPI owner, with the guide as the source for naming rules and reviewed exceptions. HTTP contract 0.14 and runtime behavior stay unchanged.

Required-response checks cover write uncertainty and applicable internal failures independently of response prose. Negative cases remove a response or its code, and malformed-spec cases exercise naming, tags, statuses, and pagination bounds. Engine constants guard documented change-page limits.

This is the first implementation slice of #1089. The operation inventory and breaking rename batch follow as separate stacked PRs.

Validation:

  • Clean baseline: 96 OpenAPI tests and 94 data-route tests passed.
  • Reproduced missing 500 outcome_unknown documentation on all 14 write-capable operations before correcting annotations.
  • Updated OpenAPI owner passes, including the new coverage and convention regressions.
  • Documentation, link/index, spelling, formatting, and focused Clippy checks.

@aaltshuler
aaltshuler added this pull request to the merge queue Oct 22, 2026
Merged via the queue into ModernRelay:main with commit 5a96c36 Oct 22, 2026
32 checks passed
github-merge-queue Bot pushed a commit that referenced this pull request Oct 22, 2026
* refactor(api): bind HTTP MCP and CLI operation inventories (#1132)

* docs(api): enforce OpenAPI conventions and response coverage (#1131)

* refactor(api): bind HTTP MCP and CLI operation inventories

* test(api): remove obsolete HTTP route storage exception

* feat(api)!: standardize HTTP contract 0.15

* fix(api): retain HTTP 0.14 while the release is in development

* test(cli): align version output with access protocol 2

* test(api): refresh commit-list vocabulary fingerprint
azimafroozeh pushed a commit to ragnorc/omnigraph that referenced this pull request Oct 22, 2026
…ay#1132)

* docs(api): enforce OpenAPI conventions and response coverage (ModernRelay#1131)

* refactor(api): bind HTTP MCP and CLI operation inventories

* test(api): remove obsolete HTTP route storage exception
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.

1 participant