Skip to content

Document Delivery API content type schemas in OpenAPI (CMS 18.0)#8054

Closed
lauraneto wants to merge 1 commit into
mainfrom
cms/v18/delivery-api-generate-content-type-schemas
Closed

Document Delivery API content type schemas in OpenAPI (CMS 18.0)#8054
lauraneto wants to merge 1 commit into
mainfrom
cms/v18/delivery-api-generate-content-type-schemas

Conversation

@lauraneto

Copy link
Copy Markdown
Contributor

📋 Description

Adds a new article documenting the opt-in GenerateContentTypeSchemas option 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 on contentType and mediaType.

The article covers:

  • The default behaviour and the opt-in shape.
  • When to enable the feature (typed client generation, content-model discovery without Backoffice access).
  • The configuration snippet.
  • An example consuming the schemas with hey-api.
  • A note on OpenAPI 3.1 polymorphism support in client generators.

Also updates the Content Delivery API landing page and the v18 SUMMARY.md with the new entry.

📎 Related Issues (if applicable)

✅ Contributor Checklist

I've followed the Umbraco Documentation Style Guide and can confirm that:

  • Code blocks are correctly formatted.
  • Sentences are short and clear (preferably under 25 words).
  • Passive voice and first-person language (“we”, “I”) are avoided.
  • Relevant pages are linked.
  • All links work and point to the correct resources.
  • Screenshots or diagrams are included if useful.
  • Any code examples or instructions have been tested.
  • Typos, broken links, and broken images are fixed.

Product & Version (if relevant)

CMS 18.0

Deadline (if relevant)

When possible, after the CMS 18.0 beta release.

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.
@github-actions

Copy link
Copy Markdown

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!

@lauraneto lauraneto added category/umbraco-cms ai-generated This PR was written by or with the assistance of AI. labels May 12, 2026
@lauraneto lauraneto marked this pull request as ready for review May 12, 2026 16:15
@sofietoft

Copy link
Copy Markdown
Contributor

The changes from this PR are applied to the new CMS structure here: #8061

@sofietoft sofietoft closed this May 13, 2026
acoumb pushed a commit to acoumb/UmbracoDocs that referenced this pull request May 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-generated This PR was written by or with the assistance of AI. category/umbraco-cms

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants