Skip to content

Commit b9a3898

Browse files
committed
Merge branch 'master' of github.com:mattpolzin/OpenAPI
2 parents e8b98cd + 05b99d0 commit b9a3898

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
# OpenAPIKit
44

5-
A library that encodes to- and decodes from [OpenAPI](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md) Documents.
5+
A library containing Swift types that encode to- and decode from [OpenAPI](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md) Documents and their components.
66

77
## Notes
8+
This library does *not* currently support file reading at all muchless following `$ref`s to other files and loading them in.
9+
810
This library *is* opinionated about a few defaults when you use the Swift types, however encoding and decoding stays true to the spec. Some key things to note:
911

1012
1. Within schemas, `required` is specified on the property rather than being specified on the parent object (encoding/decoding still follows the OpenAPI spec).

0 commit comments

Comments
 (0)