Skip to content

Commit 3bdc2ca

Browse files
authored
OpenAPI: Clarify annotation mapping for parameters and properties (#2225)
This is the clarification of the docs accompanying PR cap-js/openapi#107
1 parent bb82975 commit 3bdc2ca

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

advanced/publishing-apis/openapi.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,11 +97,15 @@ See [Frequently Asked Questions](#faq) for examples on how to use these annotati
9797
| `Description` | Action, ActionImport, Function, FunctionImport | `summary` of Operation Object |
9898
| `Description` | EntitySet, Singleton | `description` of Tag Object |
9999
| `Description` | EntityType | `title` of Request Body Object |
100-
| `Description` | ComplexType, EntityType, EnumerationType, Parameter, Property, TypeDefinition | `title` of Schema Object |
100+
| `Description` | ComplexType, EntityType, EnumerationType, TypeDefinition | `title` of Schema Object |
101+
| `Description` | Parameter | `description` of Parameter Object (fallback if `LongDescription` not present) |
102+
| `Description` | Property | `description` of Schema Object (fallback if `LongDescription` not present) |
101103
| `Description` | Schema, EntityContainer | `info.title` |
102104
| `Example` | Property | `example` of Schema Object |
103105
| `Immutable` | Property | omit from Update structure |
104106
| `LongDescription` | Action, ActionImport, Function, FunctionImport | `description` of Operation Object |
107+
| `LongDescription` | Parameter | `description` of Parameter Object |
108+
| `LongDescription` | Property | `description` of Schema Object |
105109
| `LongDescription` | Schema, EntityContainer | `info.description` |
106110
| `Permissions:Read` | Property | omit read-only properties from Create and Update structures |
107111
| `SchemaVersion` | Schema | `info.version` |

0 commit comments

Comments
 (0)