Skip to content

Render OpenAPI spec as Ref Guide page#4291

Open
epugh wants to merge 5 commits intoapache:mainfrom
epugh:SOLR-17395-elements-ui
Open

Render OpenAPI spec as Ref Guide page#4291
epugh wants to merge 5 commits intoapache:mainfrom
epugh:SOLR-17395-elements-ui

Conversation

@epugh
Copy link
Copy Markdown
Contributor

@epugh epugh commented Apr 19, 2026

https://issues.apache.org/jira/browse/SOLR-17395

Description

POC of using the https://stoplight.io/open-source/elements library to render our OpenAPI specfication in Ref Guide.

Solution

This is just a draft, and I don't even know if it should be in Ref Guide or standalone site? I tried Redoc which I've used before but couldn't get the magic to work.

After building the site you need to run python3 -m http.server 8080 --directory solr/solr-ref-guide/build/site and hit port 8080.. The docs only work in a HTTP environment.

Tests

manual

./gradlew clean
./gradlew :solr:solr-ref-guide:buildLocalSite
python3 -m http.server 8080 --directory solr/solr-ref-guide/build/site

@github-actions github-actions Bot added documentation Improvements or additions to documentation dependencies Dependency upgrades tool:build labels Apr 19, 2026
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This whole toplevel nav coupld be moved under somewhere else if we wanted..

@epugh
Copy link
Copy Markdown
Contributor Author

epugh commented Apr 19, 2026

Example of UI rendered:
image

@epugh epugh requested review from gerlowskija and janhoy April 19, 2026 01:03
@epugh epugh marked this pull request as ready for review April 19, 2026 01:03
@solrbot
Copy link
Copy Markdown
Collaborator

solrbot commented Apr 19, 2026

Cool

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Dependency upgrades documentation Improvements or additions to documentation tool:build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants