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
General Description about Working Principles #8
Comments
Where do you think we need to describe that? In the README? A dedicated documentation? Somewhere else?
Who do you see as the target group of these descriptions?
That's a pretty accurate description of where I would like to get with the HydraConsole. The only problem I have at the moment is time. Unfortunately, I can't push that forward myself in the next couple of weeks. Could you get this started? That would be fantastic.
Please also note that the resource rendering currently depends on the (modified) PHP JSON-LD processor. |
I think we could put it in a Wiki here on GH as it is supplementary material. The target groups are:
I consider working on this... Regarding the PHP Proxy: Would you mind doing the rendering entirely on the Client? |
Sorry for the delay Thomas
I'm not a big fan of Wikis but we can use it to get this thing started. Depending on how long the document gets, we could perhaps include directly in the README.
Makes sense.. a lot of this stuff probably would make sense in the README as proposed above
Cool. That would be much appreciated
No, I wouldn't mind. What's the advantage of doing so? If everything is properly refactored, there should be very little code left that is affected by the choice of the framework anyway.
Nope, in fact I would prefer it. |
Ps.: sorry my english: i don't speak english! {
"@context": "/hydra/event-api/contexts/EntryPoint.jsonld",
"@id": "/hydra/event-api/",
"@type": "EntryPoint",
"events": "/hydra/event-api/events/"
} but i have errors...then i figure out this... the response expected by the console is this: {
"@context": {
"__value": "/hydra/event-api/contexts/EntryPoint.jsonld",
"__activectx": {
"@base": {},
"hydra": {
"@id": "http://www.w3.org/ns/hydra/core#",
"@reverse": false
},
"vocab": {
"@id": "http://www.markus-lanthaler.com/hydra/event-api/vocab#",
"@reverse": false
},
"EntryPoint": {
"@id": "http://www.markus-lanthaler.com/hydra/event-api/vocab#EntryPoint",
"@reverse": false
},
"events": {
"@id": "http://www.markus-lanthaler.com/hydra/event-api/vocab#EntryPoint/events",
"@reverse": false,
"@type": "@id"
}
}
},
"@id": {
"__iri": "@id",
"__value": {
"__orig_value": "/hydra/event-api/",
"__value": {
"@id": "http://www.markus-lanthaler.com/hydra/event-api/"
}
}
},
"@type": {
"__iri": "@type",
"__value": {
"__orig_value": "EntryPoint",
"__value": {
"@id": "http://www.markus-lanthaler.com/hydra/event-api/vocab#EntryPoint"
}
}
},
"events": {
"__iri": "http://www.markus-lanthaler.com/hydra/event-api/vocab#EntryPoint/events",
"__value": {
"__orig_value": "/hydra/event-api/events/",
"__value": {
"@id": "http://www.markus-lanthaler.com/hydra/event-api/events/"
}
}
}
} what is this properties : __value, __orig_value, __activectx etc? I suppose it's the result of the recursive processing of the original json.But I do not know how I can do this processing in my api. is a different form of serialization json? I've been researching and found that there are different forms (expanded, flatened, framed) but do not know how the console is waiting ... I'm using node.js and mongo.db on my server. Is there any lib that allows automate this json pre-processing of my api for it to be compatible with your console without the need to add these properties manually? if not there is a lib for node.js to do that ... u have any document or article that explains this pre-PROCESSING the json so I can implement the processor for node.js community. I thank you for your attention. |
Good point @wancharle. In 7d1b837 I added a reference to the high-level description of how the HydraConsole works in my dissertation. If you have further questions, feel free to join the Hydra W3C Community Group and post your questions directly to our mailing list. All details can be found here: http://www.hydra-cg.com/#community |
thanks @lanthaler i will go read it! |
After searching for the implementation of the extended expansion algorithm for quite a while: It's in the |
thank you! this helped me a lot. |
I think we need a short description about the working principles of the console.
In my opinion best told with some use cases like these:
UC1 - GET API Documentaion:
1.) Make a request to the given API endpoint
2.) Client detects type
ApiDocumentation
3.) Render interactive representation of the documentaion
UC2 - GET Collection/ Paged Collection:
1.) Make a request to the given API endpoint
2.) Client detects type
Collection
/PagedCollection
3.) Render interactive representation of the collection
UC3 - GET Resource:
1.) Make a request to the given API endpoint
2.) Client detects type
Resource
3.) Render interactive representation of the resource
etc.
Also, I propose the following enhancements:
The text was updated successfully, but these errors were encountered: