HydraCG / Specifications

Specifications created by the Hydra W3C Community Group
Other
138 stars 26 forks source link

Remove hydra: prefix from use cases #151

Closed tpluscode closed 6 years ago

tpluscode commented 6 years ago

The only exceptions are turtle snippets and two terms mentioned which aren't actually part of the vocab.

I'm actually not sure whether we want to keep the hydra: prefix in text usage but decided to remove all of them for consistency


This change is Reviewable

asbjornu commented 6 years ago

Huge improvement! 👍

lanthaler commented 6 years ago

:lgtm: apart from the invalid Turtle. Thanks Tomasz


Reviewed 9 of 9 files at r1. Review status: all files reviewed at latest revision, 3 unresolved discussions.


drafts/use-cases/1.entry-point.md, line 108 at r1 (raw file):


```ttl
[] a Operation .

This is invalid Turtle. Prefixed names always need to contain a colon. I would suggest to keep using hydra: in Turtle.


drafts/use-cases/5.1.creating-event-with-put.md, line 32 at r1 (raw file):


var client = new HydraClient();
var memberTemplate = client.get('http://example.com/events')['memberTemplate'];

@alien-mcl , should we use something like hydra.memberTemplate here instead? Then we would get auto-completion etc. as well.


drafts/use-cases/6.updating-event.md, line 40 at r1 (raw file):

    "@context": "/api/context.jsonld",
    "@id": "/api/events/1",
    "@type": ["schema:Event", "Resource"],

Let's simplify this and remove Resource altogether while we are at it.


Comments from Reviewable

tpluscode commented 6 years ago

Review status: all files reviewed at latest revision, 3 unresolved discussions.


drafts/use-cases/1.entry-point.md, line 108 at r1 (raw file):

Previously, lanthaler (Markus Lanthaler) wrote…
This is invalid Turtle. [Prefixed names always need to contain a colon](https://www.w3.org/TR/turtle/#grammar-production-iri). I would suggest to keep using `hydra:` in Turtle.

Done.


drafts/use-cases/5.1.creating-event-with-put.md, line 32 at r1 (raw file):

Previously, lanthaler (Markus Lanthaler) wrote…
@alien-mcl , should we use something like `hydra.memberTemplate` here instead? Then we would get auto-completion etc. as well.

Hm, I was pretty sure I used dot notation here. Must have reverted by accident.


Comments from Reviewable

tpluscode commented 6 years ago

Review status: 7 of 9 files reviewed at latest revision, 3 unresolved discussions.


drafts/use-cases/6.updating-event.md, line 40 at r1 (raw file):

Previously, lanthaler (Markus Lanthaler) wrote…
Let's simplify this and remove `Resource` altogether while we are at it.

Done.


Comments from Reviewable

lanthaler commented 6 years ago

Unless someone objects, I'll merge this PR as soon as the last comment has been resolved.


Reviewed 2 of 2 files at r2. Review status: all files reviewed at latest revision, 2 unresolved discussions.


drafts/use-cases/5.1.creating-event-with-put.md, line 32 at r1 (raw file):

Previously, tpluscode (Tomasz Pluskiewicz) wrote…
Hm, I was pretty sure I used dot notation here. Must have reverted by accident.

Could you please fix this as well then?


drafts/use-cases/6.updating-event.md, line 40 at r1 (raw file):

Previously, tpluscode (Tomasz Pluskiewicz) wrote…
Done.

Thanks


Comments from Reviewable

elf-pavlik commented 6 years ago
:lgtm:

Review status: all files reviewed at latest revision, 1 unresolved discussion.


Comments from Reviewable

tpluscode commented 6 years ago

Review status: all files reviewed at latest revision, 1 unresolved discussion.


drafts/use-cases/5.1.creating-event-with-put.md, line 32 at r1 (raw file):

Previously, lanthaler (Markus Lanthaler) wrote…
Could you please fix this as well then?

Done.


Comments from Reviewable

lanthaler commented 6 years ago

Review status: 8 of 9 files reviewed at latest revision, 1 unresolved discussion.


drafts/use-cases/5.1.creating-event-with-put.md, line 32 at r1 (raw file):

Previously, tpluscode (Tomasz Pluskiewicz) wrote…
Done.

What I had in mind here was

client.get('http://example.com/events')[hydra.memberTemplate]

So that it would use the full URL... but let's leave it as is for now and move on. We can then update it with what was actually implemented (/cc @alien-mcl)


Comments from Reviewable

lanthaler commented 6 years ago

Reviewed 1 of 1 files at r3. Review status: all files reviewed at latest revision, all discussions resolved.


Comments from Reviewable