Skip to content

Commit c92661c

Browse files
committed
Clarify limitations
1 parent 3d777f3 commit c92661c

File tree

1 file changed

+5
-1
lines changed
  • Documentation.app/Contents/MacOS/Generation examples.playground/Pages/Limitations.xcplaygroundpage

1 file changed

+5
-1
lines changed

Documentation.app/Contents/MacOS/Generation examples.playground/Pages/Limitations.xcplaygroundpage/Contents.swift

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,13 @@
1313

1414
## Inline data types
1515

16-
In order to have a proper generation, you need to define data models in the `components` section in OpenAPI, or in the `definitions` section in Swagger. Defining your data models inline can result in generated code that is not properly named and therefore difficult to use.
16+
In order to have a proper generation, you need to define data models in the `components` section in OpenAPI, or in the `definitions` section in Swagger. Defining your data models inline can result in generated code that is not properly named and therefore difficult to use. Nested data type definition is not supported either; you will need to extract those types to the root of the definition of your models.
1717

1818
## Error data
1919

2020
If you are specifying data models as part of the error response of an endpoint, Bow OpenAPI will not parse that into a value object. However, you will be able to access such information as it is carried in the `API.HTTPError` value that you will get.
21+
22+
## Body parameters encoding
23+
24+
Currently, the only supported encoding for body parameters is `application/json`.
2125
*/

0 commit comments

Comments
 (0)