Skip to content

docs: document .json alternative format endpoint and add URL pattern table#3245

Open
won-seoop wants to merge 2 commits into
spring-cloud:mainfrom
won-seoop:doc-add-json-alternative-format-endpoint
Open

docs: document .json alternative format endpoint and add URL pattern table#3245
won-seoop wants to merge 2 commits into
spring-cloud:mainfrom
won-seoop:doc-add-json-alternative-format-endpoint

Conversation

@won-seoop

Copy link
Copy Markdown

Problem

The Serving Alternative Formats documentation listed .yml, .yaml, and .properties suffixes for consuming flattened config from the Config Server, but omitted the .json suffix.

The endpoint has existed in EnvironmentController for a long time:

GET /{application}-{profile}.json
GET /{label}/{application}-{profile}.json

Users discovering the endpoint empirically or through third-party guides had no official documentation to refer to.

Changes

  • Mention .json as a supported suffix in the introductory sentence
  • Add a reference table listing all six URL patterns (json/yml/properties × with and without label)
  • Update surrounding prose to be consistent ("flat JSON, YAML, and properties" instead of just "YAML or properties")

Closes #722

🤖 Generated with Claude Code

won-seoop and others added 2 commits June 10, 2026 03:22
The observability.adoc page existed but was unreachable from the
documentation navigation and would cause unresolved reference errors
when building the release train docs.

- Add `* xref:observability.adoc[]` to nav.adoc so the page appears
  in the sidebar
- Promote the heading from level 2 (`==`) to level 1 (`=`) so it
  is valid as a standalone Antora page

Fixes spring-cloud#2272

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…table

The serving-alternative-formats page documented .yml/.yaml/.properties
suffixes but omitted the .json flat format endpoint. Add the missing
suffix and a table summarising all six supported URL patterns (with
and without a label segment), including the new .json variants.

Closes spring-cloud#722

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document .json endpoint

2 participants