Skip to content

OpenAPI: Clarify annotation mapping for parameters and properties #2225

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

OpenAPI: Clarify annotation mapping for parameters and properties #2225

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8fb5316
fix: update descriptions for OpenAPI schema objects
tim-sh Nov 21, 2025
60e2ed3
Merge branch 'main' into openapi/descriptionFields
tim-sh Nov 24, 2025
45fd6fc
Merge branch 'main' into openapi/descriptionFields
tim-sh Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion advanced/publishing-apis/openapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,15 @@ See [Frequently Asked Questions](#faq) for examples on how to use these annotati
| `Description` | Action, ActionImport, Function, FunctionImport | `summary` of Operation Object |
| `Description` | EntitySet, Singleton | `description` of Tag Object |
| `Description` | EntityType | `title` of Request Body Object |
| `Description` | ComplexType, EntityType, EnumerationType, Parameter, Property, TypeDefinition | `title` of Schema Object |
| `Description` | ComplexType, EntityType, EnumerationType, TypeDefinition | `title` of Schema Object |
| `Description` | Parameter | `description` of Parameter Object (fallback if `LongDescription` not present) |
| `Description` | Property | `description` of Schema Object (fallback if `LongDescription` not present) |
| `Description` | Schema, EntityContainer | `info.title` |
| `Example` | Property | `example` of Schema Object |
| `Immutable` | Property | omit from Update structure |
| `LongDescription` | Action, ActionImport, Function, FunctionImport | `description` of Operation Object |
| `LongDescription` | Parameter | `description` of Parameter Object |
| `LongDescription` | Property | `description` of Schema Object |
| `LongDescription` | Schema, EntityContainer | `info.description` |
| `Permissions:Read` | Property | omit read-only properties from Create and Update structures |
| `SchemaVersion` | Schema | `info.version` |
Expand Down