Skip to content

Add OpenAPI architecture overview - #69292

Open
PureWeen wants to merge 2 commits into
dotnet:mainfrom
PureWeen:shneuvil-openapi-architecture
Open

PureWeen wants to merge 2 commits into
dotnet:mainfrom
PureWeen:shneuvil-openapi-architecture

Conversation

@PureWeen

Copy link
Copy Markdown
Member

Context

#69011 is the wider effort to add expert pull request review guidance. This PR extracts the durable OpenAPI knowledge into an in-area architecture overview so OpenAPI area owners can review, validate, and merge it independently.

The single-file structure follows the architecture pattern established by @javiercn in #69147, with the sibling SignalR #69200, gRPC #69216, Hosting #69242, and MVC #69243 extractions as additional examples.

Summary

  • document how endpoint metadata and MVC ApiExplorer descriptions flow into OpenAPI generation
  • describe runtime and build-time document generation, serving, serialization, and cancellation boundaries
  • capture document, operation, and schema transformers with their DI and lifetime behavior
  • explain schema generation, references, serializer metadata, XML comments, source generation, and trimming/AOT boundaries
  • distinguish OpenAPI ownership from Minimal API binding, MVC discovery, generic Routing, OpenAPI.NET, and build tooling
  • map focused documentation, verification boundaries, terminology, and adjacent subsystem ownership

Documentation only; no runtime or public API changes.

Validation

  • git diff --check passed
  • all local Markdown links and heading anchors resolve
  • external documentation links resolve
  • the effective pull request diff contains exactly one added file: src/OpenApi/ARCHITECTURE.md

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added the area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc label Sep 14, 2026
@PureWeen
PureWeen marked this pull request as ready for review September 14, 2026 17:07
Copilot AI lite review requested due to automatic review settings September 14, 2026 17:07

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Unresolved documentation accuracy and lifetime/framework qualification issues remain.

Get a fresh assessment by requesting another Copilot review.

Review tier: Lite
Findings: 2 Low severity

Open findings (2)
What changed in this PR

This documentation-only PR adds an OpenAPI architecture overview covering generation, transformers, schemas, serving, and subsystem ownership.

Changes:

  • Documents runtime and build-time document generation.
  • Describes schema, transformer, serialization, trimming, and AOT boundaries.
  • Maps verification areas and related subsystem ownership.
File Description
src/​OpenApi/​ARCHITECTURE.md Adds the OpenAPI architecture documentation; unresolved accuracy and qualification issues remain.

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/OpenApi/ARCHITECTURE.md Outdated
Comment thread src/OpenApi/ARCHITECTURE.md Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants