Skip to content

Commit

Permalink
Merge branch 'master' of github.com:mattpolzin/OpenAPI
Browse files Browse the repository at this point in the history
  • Loading branch information
mattpolzin committed Jul 24, 2019
2 parents e8b98cd + 05b99d0 commit b9a3898
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

# OpenAPIKit

A library that encodes to- and decodes from [OpenAPI](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md) Documents.
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.

## Notes
This library does *not* currently support file reading at all muchless following `$ref`s to other files and loading them in.

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:

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

0 comments on commit b9a3898

Please sign in to comment.