Skip to content

Repository files navigation

apollo-openapi

OpenAPI Docs

This repository maintains the Apollo OpenAPI contract. The source of truth is apollo-openapi.yaml.

📖 API Reference

Browse the rendered API reference for every released version (plus next for the unreleased main HEAD):

https://openapi.apolloconfig.com/

See all versions.

Documentation changes on main deploy automatically. A v* tag push starts the deployment workflow on main using workflow_dispatch, avoiding the Pages tag deployment issue. To retry a deployment, run Deploy API Docs manually on main.

Generated code is treated as a temporary verification artifact, not as maintained source code or an official Apollo SDK. Apollo Portal pins a released apollo-openapi.yaml tag and generates its Spring OpenAPI interfaces during the Portal build.

To verify the spec can still generate the Portal OpenAPI surface:

./generate.sh --verify

The generated files are written under build/generated/ and are intentionally ignored by git.

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages