Skip to content
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

Add a rough work-in-progress API Doc #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

vddesai1871
Copy link
Collaborator

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

@Mec-iS
Copy link
Contributor

Mec-iS commented Apr 26, 2019

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.

@vddesai1871
Copy link
Collaborator Author

vddesai1871 commented Apr 26, 2019

Yes that's what I have suggested, we can have a hyperlink to the endpoint of nested collection
something like

{ 
"@type": "Article", 
"@id": "api/articles/id", 
... 
"comments": "api/articles/id/comments", 
... 
} 

@Mec-iS Mec-iS marked this pull request as ready for review May 10, 2019 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants