mattpolzin / mattpolzin/JSONAPI
Invariant idea: "All includes get parsed successfully"
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 81
- Forks
- 21
- PR merge metrics
- No merged PRs in 30d
Description
Another way to think of this is "the JSON Document object is told about all types of includes it should expect, so if we fail to parse any of the includes, a problem has occurred."
A potential reason for wanting to be able to ignore this invariant and succeed parsing anyway is that you anticipate other entity types getting included in a response in the future but do not yet know what they will look like or have a strategy for taking advantage of them on the clientside.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by examining how the JSON Document object represents included types and how include parsing currently enforces the stated invariant. Define the intended behavior for unrecognized or unparseable includes, including how clients would know parsing completed, before identifying the relevant implementation and tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100