Skip to content

Commit 099d17a

Browse files
authored
Update README.md
Removing check boxes for `Arbitrary` conformance and `OpenAPI` integration. Both of these "features" are maintained in separate libraries.
1 parent 92d1239 commit 099d17a

1 file changed

Lines changed: 0 additions & 32 deletions

File tree

README.md

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -108,75 +108,44 @@ Note that Playground support for importing non-system Frameworks is still a bit
108108
#### Document
109109
- `data`
110110
- [x] Encoding/Decoding
111-
- [x] Arbitrary
112-
- [x] OpenAPI
113111
- `included`
114112
- [x] Encoding/Decoding
115-
- [x] Arbitrary
116-
- [x] OpenAPI
117113
- `errors`
118114
- [x] Encoding/Decoding
119-
- [x] Arbitrary
120-
- [ ] OpenAPI
121115
- `meta`
122116
- [x] Encoding/Decoding
123-
- [x] Arbitrary
124-
- [ ] OpenAPI
125117
- `jsonapi` (i.e. API Information)
126118
- [x] Encoding/Decoding
127-
- [x] Arbitrary
128-
- [ ] OpenAPI
129119
- `links`
130120
- [x] Encoding/Decoding
131-
- [x] Arbitrary
132-
- [ ] OpenAPI
133121

134122
#### Resource Object
135123
- `id`
136124
- [x] Encoding/Decoding
137-
- [x] Arbitrary
138-
- [x] OpenAPI
139125
- `type`
140126
- [x] Encoding/Decoding
141-
- [x] OpenAPI
142127
- `attributes`
143128
- [x] Encoding/Decoding
144-
- [x] OpenAPI
145129
- `relationships`
146130
- [x] Encoding/Decoding
147-
- [x] OpenAPI
148131
- `links`
149132
- [x] Encoding/Decoding
150-
- [x] Arbitrary
151-
- [ ] OpenAPI
152133
- `meta`
153134
- [x] Encoding/Decoding
154-
- [x] Arbitrary
155-
- [ ] OpenAPI
156135

157136
#### Relationship Object
158137
- `data`
159138
- [x] Encoding/Decoding
160-
- [x] Arbitrary
161-
- [x] OpenAPI
162139
- `links`
163140
- [x] Encoding/Decoding
164-
- [ ] Arbitrary
165-
- [ ] OpenAPI
166141
- `meta`
167142
- [x] Encoding/Decoding
168-
- [ ] Arbitrary
169-
- [ ] OpenAPI
170143

171144
#### Links Object
172145
- `href`
173146
- [x] Encoding/Decoding
174-
- [ ] Arbitrary
175-
- [ ] OpenAPI
176147
- `meta`
177148
- [x] Encoding/Decoding
178-
- [ ] Arbitrary
179-
- [ ] OpenAPI
180149

181150
### Misc
182151
- [x] Support transforms on `Attributes` values (e.g. to support different representations of `Date`)
@@ -194,7 +163,6 @@ Note that Playground support for importing non-system Frameworks is still a bit
194163
- [ ] (Maybe) Use `KeyPath` to specify `Includes` thus creating type safety around the relationship between a primary resource type and the types of included resources.
195164
- [ ] (Maybe) Replace `SingleResourceBody` and `ManyResourceBody` with support at the `Document` level to just interpret `PrimaryResource`, `PrimaryResource?`, or `[PrimaryResource]` as the same decoding/encoding strategies.
196165
- [ ] Support sideposting. JSONAPI spec might become opinionated in the future (https://github.com/json-api/json-api/pull/1197, https://github.com/json-api/json-api/issues/1215, https://github.com/json-api/json-api/issues/1216) but there is also an existing implementation to consider (https://jsonapi-suite.github.io/jsonapi_suite/ruby/writes/nested-writes). At this time, any sidepost implementation would be an awesome tertiary library to be used alongside the primary JSONAPI library. Maybe `JSONAPISideloading`.
197-
- [ ] Property-based testing (using `SwiftCheck`).
198166
- [ ] Error or warning if an included resource object is not related to a primary resource object or another included resource object (Turned off or at least not throwing by default).
199167

200168
## Usage

0 commit comments

Comments
 (0)