Skip to content

Commit a89281f

Browse files
Apply suggestions from PR review
Co-authored-by: Tom Dykstra <[email protected]>
1 parent 87b2fca commit a89281f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

aspnetcore/fundamentals/openapi/include-metadata.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ uid: fundamentals/openapi/include-metadata
1010
---
1111
# Include OpenAPI metadata in an ASP.NET Core app
1212

13-
## Including OpenAPI metadata for endpoints
13+
## Include OpenAPI metadata for endpoints
1414

1515
ASP.NET collects metadata from the web app's endpoints and uses it to generate an OpenAPI document.
1616
In controller-based apps, metadata is collected from attributes like [`[EndpointDescription]`](xref:Microsoft.AspNetCore.Http.EndpointDescriptionAttribute), [`[HttpPost]`](xref:Microsoft.AspNetCore.Mvc.HttpPostAttribute),
@@ -396,7 +396,7 @@ This example also illustrates how to define multiple response types for an actio
396396
397397
---
398398
399-
### Excluding endpoints from the generated document
399+
### Exclude endpoints from the generated document
400400
401401
By default, all endpoints that are defined in an app are documented in the generated OpenAPI file, but endpoints can be excluded from the document using attributes or extension methods.
402402
@@ -435,7 +435,7 @@ The following example demonstrates how to exclude an endpoint from the generated
435435
```
436436
---
437437
438-
## Including OpenAPI metadata for data types
438+
## Include OpenAPI metadata for data types
439439
440440
C# classes or records used in request or response bodies are represented as schemas
441441
in the generated OpenAPI document.
@@ -477,7 +477,7 @@ Note that object and dynamic types have _no_ type defined in the OpenAPI because
477477
478478
The `type` and `format` can also be set with a [Schema Transformer](xref:fundamentals/openapi/customize-openapi#use-schema-transformers). For example, you may want the `format` of decimal types to be `decimal` instead of `double`.
479479
480-
### Using attributes to add metadata
480+
### Use attributes to add metadata
481481
482482
ASP.NET uses metadata from attributes on class or record properties to set metadata on the corresponding properties of the generated schema.
483483
@@ -526,7 +526,7 @@ The [`[JsonDerivedType]`](xref:System.Text.Json.Serialization.JsonDerivedTypeAtt
526526
527527
An abstract class with a [`[JsonPolymorphic]`](xref:System.Text.Json.Serialization.JsonPolymorphicAttribute) attribute has a `discriminator` field in the schema, but a concrete class with a [`[JsonPolymorphic]`](xref:System.Text.Json.Serialization.JsonPolymorphicAttribute) attribute doesn't have a `discriminator` field. OpenAPI requires that the discriminator property be a required property in the schema, but since the discriminator property isn't defined in the concrete base class, the schema cannot include a `discriminator` field.
528528
529-
### Adding metadata with a schema transformer
529+
### Add metadata with a schema transformer
530530
531531
A schema transformer can be used to override any default metadata or add additional metadata, such as `example` values, to the generated schema. See [Use schema transformers](xref:fundamentals/openapi/customize-openapi#use-schema-transformers) for more information.
532532

0 commit comments

Comments
 (0)