Skip to content

Feature/openapi spec (phase 1)#665

Open
Ishan1923 wants to merge 5 commits into
ros-controls:rollingfrom
Ishan1923:feature/openapi-spec
Open

Feature/openapi spec (phase 1)#665
Ishan1923 wants to merge 5 commits into
ros-controls:rollingfrom
Ishan1923:feature/openapi-spec

Conversation

@Ishan1923

Copy link
Copy Markdown

Depends on #664. Follow-up to the AI Agent Optimization Plan addressing #609.
This PR introduces the machine-readable OpenAPI specification for AI agent routing and updates the related files accordingly.
changes:

  • added _static/openapi.yaml : openapi 3.1.0 spec defining the static documentation URL pattern (/{version}/doc/{module}/doc/{page}.html)
  • updated _static/llms.txt : added "Tools and APIs" section linking to the openapi spec
  • updated conf.py : extended html_extra_path to expose openapi.yaml at the site root

Ishan1923 added 3 commits May 29, 2026 00:39
Signed-off-by: Ishan1923 <ecdev4ishan@gmail.com>
Signed-off-by: Ishan1923 <ecdev4ishan@gmail.com>
Signed-off-by: Ishan1923 <ecdev4ishan@gmail.com>
@Ishan1923

Copy link
Copy Markdown
Author

In openapi spec, only static path fetching is included. The RTD search endpoint doesn't exist on this deployment (confirmed via local testing, correct me if i am wrong), so it was left out. More endpoints can be added later after discussion.

- Add make_help_scripts/generate_llms_full.py to stitch Sphinx text
  output into a single llms-full.txt file
- Add text build and stitching steps to sphinx-make-page.yml CI workflow

Signed-off-by: Ishan1923 <ecdev4ishan@gmail.com>
@Ishan1923 Ishan1923 changed the title Feature/openapi spec Feature/openapi spec (phase 1) Jun 8, 2026
@bmagyar

bmagyar commented Jun 8, 2026

Copy link
Copy Markdown
Member

I think you need to run precommit

Signed-off-by: Ishan1923 <ecdev4ishan@gmail.com>
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