From 8fb531627bb0ab2b16dcb2084400cbeb3588e986 Mon Sep 17 00:00:00 2001 From: Tim Schulze-Hartung Date: Fri, 21 Nov 2025 14:55:44 +0100 Subject: [PATCH] fix: update descriptions for OpenAPI schema objects --- advanced/publishing-apis/openapi.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/advanced/publishing-apis/openapi.md b/advanced/publishing-apis/openapi.md index 3d535a07c..b2aa7ed5a 100644 --- a/advanced/publishing-apis/openapi.md +++ b/advanced/publishing-apis/openapi.md @@ -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` |