- From: Markus Lanthaler via GitHub <sysbot+gh@w3.org>
- Date: Tue, 13 Mar 2018 08:16:25 +0000
- To: public-hydra-logs@w3.org
Reviewed 4 of 5 files at r1.
Review status: 4 of 5 files reviewed at latest revision, all discussions resolved.
---
*[drafts/use-cases/2.1.api-documentation-data-structures.md, line 1 at r1](https://beta.reviewable.io/reviews/hydracg/specifications/159#-L7TOIWl3Y1qaNywobmq:-L7TOIWl3Y1qaNywobmr:b-mebgkj) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.1.api-documentation-data-structures.md#L1)):*
> documentationt
Typo --> documentation
---
*[drafts/use-cases/2.1.api-documentation-data-structures.md, line 27 at r1](https://beta.reviewable.io/reviews/hydracg/specifications/159#-L7TOdUC2XxJbkr-kai6:-L7TOUHpD-s8LLGDs87p:bmzf8pb) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.1.api-documentation-data-structures.md#L27)):*
> There are situations, when i.e. Rich...
should be "There are situations when, e.g., Rich..."
---
*[drafts/use-cases/2.1.api-documentation-data-structures.md, line 33 at r1](https://beta.reviewable.io/reviews/hydracg/specifications/159#-L7TOsoo-Tew7_biEHOj:-L7TOsoo-Tew7_biEHOk:b-evssbv) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.1.api-documentation-data-structures.md#L33)):*
> could be
--> is
---
*[drafts/use-cases/2.1.api-documentation-data-structures.md, line 34 at r1](https://beta.reviewable.io/reviews/hydracg/specifications/159#-L7TOuG99UG31b3lH4uu:-L7TOuG99UG31b3lH4uv:b46yxaj) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.1.api-documentation-data-structures.md#L34)):*
> vs.
--> and
---
*[drafts/use-cases/2.1.api-documentation-data-structures.md, line 44 at r1](https://beta.reviewable.io/reviews/hydracg/specifications/159#-L7TP-83BXSVMKMmo54r:-L7TP-83BXSVMKMmo54s:b-zhf62m) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.1.api-documentation-data-structures.md#L44)):*
> api?documentation
Nit: While it wouldn't matter in practice, I think people will find the query parameter confusing. I'd thus suggest to place this at `/api/documentation`
---
*[drafts/use-cases/2.1.api-documentation-data-structures.md, line 58 at r1](https://beta.reviewable.io/reviews/hydracg/specifications/159#-L7TPPiy91RhGFo6JUbh:-L7TPPiy91RhGFo6JUbi:b6d9312) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.1.api-documentation-data-structures.md#L58)):*
> ```Markdown
> {
> "@context": "/api/context.jsonld",
> "@id": "/api?documentation",
> ```
Please type it as `hydra:ApiDocumentation`
---
*[drafts/use-cases/2.1.api-documentation-data-structures.md, line 64 at r1](https://beta.reviewable.io/reviews/hydracg/specifications/159#-L7TPUXi9P7tLTCBuxAU:-L7TPUXi9P7tLTCBuxAV:bm2d8i9) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.1.api-documentation-data-structures.md#L64)):*
> ```Markdown
> "supportedProperty": [
> {
> "property": "schema:eventName",
> ```
These all need to be separate objects (of type `hydra:SupportedProperty`)
---
*[drafts/use-cases/2.2.api-documentation-user-document.md, line 23 at r1](https://beta.reviewable.io/reviews/hydracg/specifications/159#-L7TPzMX3zglhbHuJl3g:-L7TPzMX3zglhbHuJl3h:b-wz825f) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.2.api-documentation-user-document.md#L23)):*
> foreach (const operation of supportedProperty.supportedOperations)
Did you want to add some inner statements?
---
*[drafts/use-cases/3.2.pagination.md, line 35 at r1](https://beta.reviewable.io/reviews/hydracg/specifications/159#-L7TQHzC8rLcL0Y-LZWl:-L7TQHzC8rLcL0Y-LZWm:bthhxmv) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/3.2.pagination.md#L35)):*
> Cleint
--> Client
---
*Comments from [Reviewable](https://beta.reviewable.io/reviews/hydracg/specifications/159)*
<!-- Sent from Reviewable.io -->
--
GitHub Notification of comment by lanthaler
Please view or discuss this issue at https://github.com/HydraCG/Specifications/pull/159#issuecomment-372581851 using your GitHub account
Received on Tuesday, 13 March 2018 08:16:34 UTC