-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Namespace/update the DML Drawings API + allow for versioning #161
Comments
5 tasks
krissy
changed the title
Update the DML Drawings API and move to a namespace to enable versioning
Namespace the DML Drawings API and allow for versioning
Apr 22, 2017
krissy
changed the title
Namespace the DML Drawings API and allow for versioning
Namespace/update the DML Drawings API + allow for versioning
Apr 22, 2017
CathMollie
modified the milestones:
E2E data integration,
Image API complete & documented,
E2E data management and integration
Apr 29, 2017
krissy
added a commit
that referenced
this issue
May 21, 2017
krissy
added a commit
that referenced
this issue
May 21, 2017
9 tasks
krissy
added a commit
that referenced
this issue
Jul 2, 2017
krissy
added a commit
that referenced
this issue
Jul 2, 2017
krissy
added a commit
that referenced
this issue
Jul 2, 2017
krissy
added a commit
that referenced
this issue
Jul 2, 2017
krissy
added a commit
that referenced
this issue
Aug 28, 2017
[#161] Update, secure & namespace the DML Drawings API
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Blocked by: #36
What
At the time of writing, we have roughly setup JSON-HAL API endpoints accessible (when logged in) for singular and collection drawing endpoints. E.g. {host}/{API version}/drawings.hal (collection) or {host}/{API version}/drawings/1.hal (singular).
1. Ensure API is in sync with our API spec
We want to update the API so it shows the most up-to-date drawings data and matches the documentation at http://docs.drawmylife.apiary.io/. (NB: The apiary documentation has a separate task to be confirmed and cleaned up in #36. Ensure that is closed first before starting on this ticket. Feel free to pick it up if unassigned!) Most importantly, we want to ensure we only display image URLs for images that have the consent field marked as true. If consent is not given, we are allowed to share the data, just not the image.
2. Update how we access the API
We want to move the API implementation, so it's not accessible via the root path, and instead can be accessed by calling the version subdirectory {host}/api/drawings. We also want to default to returning a HAL-representation, rather than specifying it explicitly like {host}/api/drawings as we do currently.
3. Versioning
🌵 UPDATE: Let's park this for now, can version later
We want to enable API versioning. Due to reasons posted in articles like this one we want our clients to request versions via request headers, rather than adding a new subpath like api/v1/drawings.hal to the URI.
I.e. To request the first version:
Note, we can also use headers to request different content types if we want, but not necessary for this ticket.
4. Secure the API
(Optional) Finally, once the API is cleaned up and correctly toggling on consent, we need to secure the API with simple token authentication.
How
The text was updated successfully, but these errors were encountered: