Last active
May 31, 2017 19:24
-
-
Save russellbodine/ad03c78cf15325ff1bdb29fb6fab1ee5 to your computer and use it in GitHub Desktop.
Filter/hash endpoints for permalink Creation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Documenting 2 endpoints for permalink creation. | |
| Filter endpoint used to create hash. | |
| POST to: | |
| {{url}}/api/v1/references/filter/ | |
| BODY: | |
| { | |
| "data": {"test" : "test4"} #whatever filter json u want goes as the body!!!! | |
| } | |
| RETURN: | |
| { | |
| "hash": "23231A13r1131243" | |
| } | |
| The body format is up to the front end. We simply drill down to request body and hash it. | |
| A new story will be made for filter valiation and will be added to the backlog. | |
| --------------------------------------------------------------------------------------------- | |
| Hash endpoint used to return Filter. | |
| POST to: | |
| {{url}}/api/v1/references/hash/ | |
| REQUEST BODY: | |
| { | |
| "hash": "23231A13r1131243" | |
| } | |
| RETURN: | |
| { | |
| "filter": { #whatever data u provided goes as the value of filter!!!! | |
| "data": { | |
| "test": "test4" | |
| } | |
| } | |
| } | |
| The return json is whatever was sent in the body for the filter endpoint |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment