Add a rough work-in-progress API Doc#2
Open
vddesai1871 wants to merge 1 commit intoHTTP-APIs:masterfrom
Open
Conversation
Contributor
|
Let's always remember that the pivot concept of our work are hypermedia. So we possibly want to return an hyperlink to the collection, not the full collection. same we did for nested object in Flock-Demo. Always take as example of output the Github API, it is the best balance between content and length of outputs. |
Collaborator
Author
|
Yes that's what I have suggested, we can have a hyperlink to the endpoint of nested collection |
2 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
It's just a rough structure of the API Doc.
While trying to run it I found that hydrus can't show nested collections. (eg. collection of comments on a particular issue/article). I think we'll need to create an extra endpoint for 'apiname/Item/id/Collection'. Is it the right way to go or we can do something else as we did for nested objects. @Mec-iS @xadahiya @chrizandr