Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Post-PR review. #32562

Merged
merged 4 commits into from May 13, 2024
Merged

Post-PR review. #32562

merged 4 commits into from May 13, 2024

Conversation

tdykstra
Copy link
Contributor

@tdykstra tdykstra commented May 10, 2024

Review of the article created by #32529

Mostly changes to conform to the style guide.
On periods in bulleted lists, see https://styleguides.azurewebsites.net/Styleguide/Read?id=2700&topicid=56575


Internal previews

馃搫 File 馃敆 Preview link
aspnetcore/fundamentals/minimal-apis/aspnetcore-openapi.md Get started with Microsoft.AspNetCore.OpenApi

@Rick-Anderson
Copy link
Contributor

Search and replace here -- too verbose


ADD the OpenAPI-related services to `Program.cs`: <!-- REPLACE FOLLOWING WITH SNIPPET -->```

@Rick-Anderson
Copy link
Contributor

image

@Rick-Anderson
Copy link
Contributor

Rick-Anderson commented May 10, 2024

. The requests below will resolve the v1 and internal documents respectively.
The following requests resolve (nuke will)

remove all FT.

@Rick-Anderson
Copy link
Contributor

Rick-Anderson commented May 10, 2024

Split up

Transformers are useful for scenarios like:

  • adding parameters to all operations in a document,
  • modifying descriptions for parameters or operations,
  • adding top-level information to the OpenAPI document.

Copy link
Contributor

@Rick-Anderson Rick-Anderson left a comment

Choose a reason for hiding this comment

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

rewrite

Operation transformers apply to each individual operation (combination of path + HTTP method) and can be used to modify parameters or responses on endpoints.

Operation transformers apply to each individual operation, modifying parameters or responses on endpoints. These operations are a combination of the path and the HTTP method.

LInk to source on new APIs, ie
https://github.com/dotnet/aspnetcore/blob/main/src/OpenApi/src/Transformers/IOpenApiDocumentTransformer.cs#L9

aspnetcore/fundamentals/minimal-apis/aspnetcore-openapi.md Outdated Show resolved Hide resolved
@Rick-Anderson
Copy link
Contributor

@Rick-Anderson
Copy link
Contributor

Copy link
Contributor

@Rick-Anderson Rick-Anderson left a comment

Choose a reason for hiding this comment

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

aspnetcore\src\Mvc\Mvc.ApiExplorer\src\ApiDescriptionGroupCollectionProvider.cs
contains ApiDescriptionGroups

Probably create another PR to update these ref when the API is built. It's nice to have a link to the source and the API ref.

he sample below

Copy link
Member

@captainsafia captainsafia left a comment

Choose a reason for hiding this comment

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

I'm not an expert on the style guide but the content looks fine.

I've added a suggestion for the missing code snippet for multi-doc transformers.

tdykstra and others added 2 commits May 13, 2024 09:31
Co-authored-by: Safia Abdalla <safia@safia.rocks>
Co-authored-by: Rick Anderson <3605364+Rick-Anderson@users.noreply.github.com>
@Rick-Anderson Rick-Anderson merged commit f209e70 into dotnet:main May 13, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants