- From: Markus Lanthaler via GitHub <sysbot+gh@w3.org>
- Date: Sun, 29 Apr 2018 17:26:07 +0000
- To: public-hydra-logs@w3.org
Reviewed 2 of 2 files at r1.
Review status: all files reviewed at latest revision, all discussions resolved.
---
*[drafts/use-cases/2.3.complete-api-documentation.md, line 18 at r1](https://reviewable.io/reviews/hydracg/specifications/164#-LBHOjvS7YhwKTbeX2gc:-LBHOjvS7YhwKTbeX2gd:b-b6vkre) ([raw file](https://github.com/hydracg/specifications/blob/c46a6c87fb68dce55656d41ee200d38e2cbf051d/drafts/use-cases/2.3.complete-api-documentation.md#L18)):*
> ```Markdown
> - name
> - description
> - base classes
> ```
Do you mean parent/super-classes?
---
*[drafts/use-cases/2.3.complete-api-documentation.md, line 40 at r1](https://reviewable.io/reviews/hydracg/specifications/164#-LBHP4uv4JwardklmAHo:-LBHP4uw0sr-QDAw4khs:b-pbd6rp) ([raw file](https://github.com/hydracg/specifications/blob/c46a6c87fb68dce55656d41ee200d38e2cbf051d/drafts/use-cases/2.3.complete-api-documentation.md#L40)):*
> ```Markdown
> @base <http://temp.uri/api> .
>
> <?apiDocumentation> a hydra:ApiDocumentation;
> ```
I'd think making this `<>` instead of `<?apiDocumentation>` would simplify things.
---
*[drafts/use-cases/2.3.complete-api-documentation.md, line 48 at r1](https://reviewable.io/reviews/hydracg/specifications/164#-LBHPFNZ4g8XnxpvBz9L:-LBHPFN_6-TfqTMVc7fp:bz7i1gj) ([raw file](https://github.com/hydracg/specifications/blob/c46a6c87fb68dce55656d41ee200d38e2cbf051d/drafts/use-cases/2.3.complete-api-documentation.md#L48)):*
> ```Markdown
> schema:Event a hydra:Class ;
> hydra:supportedOperation doc:get-events-operation ,
> doc:new-event-operation ,
> ```
I'd get rid of the `doc:` prefix and instead use relative IRIs directly, in this case <#new-even-operation>. That makes it clear that the description can be found further down in the same doc
---
*[drafts/use-cases/2.3.complete-api-documentation.md, line 84 at r1](https://reviewable.io/reviews/hydracg/specifications/164#-LBHPsPE5ZdMOFshH-k2:-LBHPsPE5ZdMOFshH-k3:bxmop9j) ([raw file](https://github.com/hydracg/specifications/blob/c46a6c87fb68dce55656d41ee200d38e2cbf051d/drafts/use-cases/2.3.complete-api-documentation.md#L84)):*
> ```Markdown
> # Below are operations related to schema:Event supported class.
> # Unfortunately, it is not possible to link them directly to the supported class
> # as the hydra:Operation does not allow to define the URL to be invoked.
> ```
You could reference the issue in which we are working on that here
---
*[drafts/use-cases/2.3.complete-api-documentation.md, line 89 at r1](https://reviewable.io/reviews/hydracg/specifications/164#-LBHPfvO63lDYJ_Balsw:-LBHPfvO63lDYJ_Balsx:b-27yugf) ([raw file](https://github.com/hydracg/specifications/blob/c46a6c87fb68dce55656d41ee200d38e2cbf051d/drafts/use-cases/2.3.complete-api-documentation.md#L89)):*
> ```Markdown
> # The link below does not allow to describe the fact returned payload is a collection of schema:Event,
> # thus the only hint for the client to connect it with that class is comparing supported operations
> # defined in this link and the class itsefl.
> ```
itsefl --> itself
---
*[drafts/use-cases/2.3.complete-api-documentation.md, line 110 at r1](https://reviewable.io/reviews/hydracg/specifications/164#-LBHQ8pE-mjaNEKrmSAU:-LBHQ8pE-mjaNEKrmSAV:bbm154a) ([raw file](https://github.com/hydracg/specifications/blob/c46a6c87fb68dce55656d41ee200d38e2cbf051d/drafts/use-cases/2.3.complete-api-documentation.md#L110)):*
> ```Markdown
> doc:update-event a hydra:TemplatedLink ;
> hydra:title "Updates an event." ;
> hydra:template "http://temp.uri/api/events/{id}"^^hydra:Rfc6570Template ;
> ```
`hydra:template` and `hydra:mapping` can't be used on the definition of a TemplatedLink. They need to be set when such a link is instantiated.
---
*[drafts/use-cases/2.3.complete-api-documentation.md, line 119 at r1](https://reviewable.io/reviews/hydracg/specifications/164#-LBHQaX47tRg58Q2OLvi:-LBHQaX47tRg58Q2OLvj:bj4rnpc) ([raw file](https://github.com/hydracg/specifications/blob/c46a6c87fb68dce55656d41ee200d38e2cbf051d/drafts/use-cases/2.3.complete-api-documentation.md#L119)):*
> ```Markdown
> ] .
>
> # Link below cannot be directly connected with schema:Event class as it does not mention it.
> ```
What do you mean by this? You declared there to be a supported operation of schema:Event that allows deleting the event. In general, I don't understand what you use these TemplatedLinks here for!?
---
*Comments from [Reviewable](https://reviewable.io/reviews/hydracg/specifications/164)*
<!-- Sent from Reviewable.io -->
--
GitHub Notification of comment by lanthaler
Please view or discuss this issue at https://github.com/HydraCG/Specifications/pull/164#issuecomment-385267040 using your GitHub account
Received on Sunday, 29 April 2018 17:26:11 UTC