Skip to content

docs: sync OpenAPI reference from staging - #53

Open
hanakannzashi wants to merge 1 commit into
mainfrom
codex/sync-openapi-staging
Open

hanakannzashi wants to merge 1 commit into
mainfrom
codex/sync-openapi-staging

Conversation

@hanakannzashi

@hanakannzashi hanakannzashi commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Sync the generated OpenAPI reference from staging while keeping the public server URL set to NEAR AI Cloud.
  • Add API Reference navigation entries for the endpoints added by the schema.
  • Exclude retiring Conversations, Files, and stateful Responses operations from both the published OpenAPI file and generated navigation.

Validation

  • python3 -m py_compile scripts/sync-openapi.py
  • git diff --check origin/main...HEAD
  • jq empty api-reference/openapi.json
  • jq empty docs.json
  • Confirmed the generated sidebar has 118 operations and retains only POST /v1/responses from the Responses operations scheduled for removal.

@PierreLeGuen PierreLeGuen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @hanakannzashi. The sync itself looks right: no operation was removed, and every operation in the spec is in the navigation (135).

One thing to change before merging: this publishes 20 operations we're about to retire. That's Conversations (11), Files (5), and the stateful Responses operations: GET and DELETE /v1/responses/{response_id}, /cancel, and /input_items.

Private Chat goes read-only on Sep 28, and your stateful-Responses removal (cloud-api#942, #943, #944) is planned for the Oct 1 release. Documenting them now points integrators at APIs we're removing. They're in the live spec, so the sync script picks them up. Suggest excluding the Conversations and Files tags and those four Responses operations in scripts/sync-openapi.py, then re-running the sync so the next one doesn't bring them back.

A question, not blocking: the new AML allowlist and report operations, and the org fallback ones, land in the public Admin group. They're admin-only, but do we want AML endpoints in the public reference? If not, the same exclusion list covers them.

@hanakannzashi
hanakannzashi force-pushed the codex/sync-openapi-staging branch from 902f517 to c690296 Compare September 23, 2026 12:24
@hanakannzashi

Copy link
Copy Markdown
Contributor Author

Addressed the blocking request in c690296. The sync now filters Conversations, Files, and the four retiring stateful Responses operations before writing the OpenAPI file, so they stay out of both the published spec and sidebar on future syncs. I left AML and other Admin operations unchanged because that was raised as a non-blocking product-scope question.

This branch has not been deployed

No deployments
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.

2 participants