You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: proposals/004_Overlays.md
+37
Original file line number
Diff line number
Diff line change
@@ -165,6 +165,43 @@ updates:
165
165
remove: true
166
166
```
167
167
168
+
##### Traits Examples
169
+
170
+
By annotating an OpenAPI description using extension such as `x-oai-traits` an author of OpenAPI description can identify where overlay updates should be applied.
171
+
172
+
```yaml
173
+
openapi: 3.1.0
174
+
info:
175
+
title: Api with a paged collection
176
+
version: 1.0.0
177
+
paths:
178
+
/items:
179
+
get:
180
+
x-oai-traits: ["paged"]
181
+
responses:
182
+
200:
183
+
description: OK
184
+
```
185
+
186
+
With the above OpenAPI description, following Overlay document will apply the necessary updates to describe how paging is implemented, where that trait has been applied.
0 commit comments