Skip to content

Commit 72cc847

Browse files
committed
update migration guide
1 parent ea62ddb commit 72cc847

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

documentation/migration_guides/v5_migration_guide.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ v5.10 and greater).
1515
Only relevant when compiling OpenAPIKit on iOS: Now v12+ is required.
1616

1717
### OpenAPI Specification Versions
18+
There are no breaking changes for the `OpenAPIKit30` module (OAS 3.0.x
19+
specification) in this section.
20+
1821
The OpenAPIKit module's `OpenAPI.Document.Version` enum gained `v3_1_2`,
1922
`v3_2_0` and `v3_2_x(x: Int)`.
2023

@@ -68,7 +71,7 @@ let httpMethod : OpenAPI.HttpMethod = .post
6871

6972
### Parameters
7073
There are no breaking changes for the `OpenAPIKit30` module (OAS 3.0.x
71-
specification).
74+
specification) in this section.
7275

7376
For the `OpenAPIKit` module (OAS 3.1.x and 3.2.x versions) read on.
7477

@@ -149,6 +152,13 @@ Because the `ParameterContext` has taken on the `schemaOrContent` of the
149152
similar for the other locations) no longer make sense and have been removed. You
150153
must also specify the schema or content, e.g. `ParameterContext.header(schema: .string)`.
151154

155+
### Parameter Styles
156+
There are no breaking changes for the `OpenAPIKit30` module (OAS 3.0.x
157+
specification) in this section.
158+
159+
A new `cookie` style has been added. Code that exhaustively switches on the
160+
`OpenAPI.Parameter.SchemaContext.Style` enum will need to be updated.
161+
152162
### Errors
153163
Some error messages have been tweaked in small ways. If you match on the
154164
string descriptions of any OpenAPIKit errors, you may need to update the

0 commit comments

Comments
 (0)