Document Delivery API content type schemas in OpenAPI (CMS 18.0)#8054
Closed
lauraneto wants to merge 1 commit into
Closed
Document Delivery API content type schemas in OpenAPI (CMS 18.0)#8054lauraneto wants to merge 1 commit into
lauraneto wants to merge 1 commit into
Conversation
Documents the opt-in GenerateContentTypeSchemas option that emits per-content-type schemas in the Delivery API OpenAPI document, covering when to enable it, configuration, and an example using hey-api.
|
Thanks for opening this PR! 🎉 Quick question: Does this PR include any AI-generated content? AI tools are absolutely welcome here! We only ask that you follow our AI contribution guidelines to help keep the documentation consistent and trustworthy. Drop a quick comment to let us know! |
Contributor
|
The changes from this PR are applied to the new CMS structure here: #8061 |
acoumb
pushed a commit
to acoumb/UmbracoDocs
that referenced
this pull request
May 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📋 Description
Adds a new article documenting the opt-in
GenerateContentTypeSchemasoption introduced in Umbraco 18 (CMS PR #22666). When enabled, the Delivery API OpenAPI document emits a schema per Document Type, Element Type, and Media Type, with discriminated unions oncontentTypeandmediaType.The article covers:
Also updates the Content Delivery API landing page and the v18
SUMMARY.mdwith the new entry.📎 Related Issues (if applicable)
✅ Contributor Checklist
I've followed the Umbraco Documentation Style Guide and can confirm that:
Product & Version (if relevant)
CMS 18.0
Deadline (if relevant)
When possible, after the CMS 18.0 beta release.