Re: [Specifications] Introduced two new use cases related to API documentation and collection pagination

Review status: 4 of 5 files reviewed at latest revision, 9 unresolved discussions.

---

*[drafts/use-cases/2.1.api-documentation-data-structures.md, line 1 at r1](https://reviewable.io:443/reviews/hydracg/specifications/159#-L7TOIWl3Y1qaNywobmq:-L7VtiAD702BcMwkglZU:b-896fix) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.1.api-documentation-data-structures.md#L1)):*
<details><summary><i>Previously, lanthaler (Markus Lanthaler) wrote…</i></summary><blockquote>

> documentationt

Typo --> documentation
</blockquote></details>

Done.

---

*[drafts/use-cases/2.1.api-documentation-data-structures.md, line 27 at r1](https://reviewable.io:443/reviews/hydracg/specifications/159#-L7TOdUC2XxJbkr-kai6:-L7VtpI75_CUmcUo7d4Y:b-896fix) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.1.api-documentation-data-structures.md#L27)):*
<details><summary><i>Previously, lanthaler (Markus Lanthaler) wrote…</i></summary><blockquote>

>  There are situations, when i.e. Rich...

should be "There are situations when, e.g., Rich..."
</blockquote></details>

Done.

---

*[drafts/use-cases/2.1.api-documentation-data-structures.md, line 33 at r1](https://reviewable.io:443/reviews/hydracg/specifications/159#-L7TOsoo-Tew7_biEHOj:-L7VttFUa2aCgo3_lgpR:b-896fix) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.1.api-documentation-data-structures.md#L33)):*
<details><summary><i>Previously, lanthaler (Markus Lanthaler) wrote…</i></summary><blockquote>

> could be

--> is
</blockquote></details>

Done.

---

*[drafts/use-cases/2.1.api-documentation-data-structures.md, line 34 at r1](https://reviewable.io:443/reviews/hydracg/specifications/159#-L7TOuG99UG31b3lH4uu:-L7VtwR1QPG05qCZs0dA:b-896fix) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.1.api-documentation-data-structures.md#L34)):*
<details><summary><i>Previously, lanthaler (Markus Lanthaler) wrote…</i></summary><blockquote>

> vs.

--> and
</blockquote></details>

Done.

---

*[drafts/use-cases/2.1.api-documentation-data-structures.md, line 44 at r1](https://reviewable.io:443/reviews/hydracg/specifications/159#-L7TP-83BXSVMKMmo54r:-L7Vu5MB8GoDReVv3ggb:bd9yjm7) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.1.api-documentation-data-structures.md#L44)):*
<details><summary><i>Previously, lanthaler (Markus Lanthaler) wrote…</i></summary><blockquote>

> 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`
</blockquote></details>

Hmm. Actually I didn't want the documentation to be confused with an actual API resource as other (`/api/event` to not to look to far) are addressed same way. Do we have another option?

---

*[drafts/use-cases/2.1.api-documentation-data-structures.md, line 58 at r1](https://reviewable.io:443/reviews/hydracg/specifications/159#-L7TPPiy91RhGFo6JUbh:-L7VujXH7ij5CSYRuUqx:b-896fix) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.1.api-documentation-data-structures.md#L58)):*
<details><summary><i>Previously, lanthaler (Markus Lanthaler) wrote…</i></summary><blockquote>

Please type it as `hydra:ApiDocumentation`
</blockquote></details>

Done.

---

*[drafts/use-cases/2.1.api-documentation-data-structures.md, line 64 at r1](https://reviewable.io:443/reviews/hydracg/specifications/159#-L7TPUXi9P7tLTCBuxAU:-L7Vv0wWDDtIvYMVTFl9:b4kfzk7) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.1.api-documentation-data-structures.md#L64)):*
<details><summary><i>Previously, lanthaler (Markus Lanthaler) wrote…</i></summary><blockquote>

These all need to be separate objects (of type `hydra:SupportedProperty`)
</blockquote></details>

Argh - correct. I wanted it to be shorter and it ended up with some virtual stupidity. Done

---

*[drafts/use-cases/2.2.api-documentation-user-document.md, line 23 at r1](https://reviewable.io:443/reviews/hydracg/specifications/159#-L7TPzMX3zglhbHuJl3g:-L7Vvw7VyAKNNB6K0Vb-:b37ramf) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/2.2.api-documentation-user-document.md#L23)):*
<details><summary><i>Previously, lanthaler (Markus Lanthaler) wrote…</i></summary><blockquote>

> foreach (const operation of supportedProperty.supportedOperations)

Did you want to add some inner statements?
</blockquote></details>

Ahh, yep - jumped to another part of document and forgot to get back here. Done

---

*[drafts/use-cases/3.2.pagination.md, line 35 at r1](https://reviewable.io:443/reviews/hydracg/specifications/159#-L7TQHzC8rLcL0Y-LZWl:-L7Vw3tjXYooSNfiOU9z:b-896fix) ([raw file](https://github.com/hydracg/specifications/blob/9ec1f3c4b27ee71e17c55325465f43f85e77ffe3/drafts/use-cases/3.2.pagination.md#L35)):*
<details><summary><i>Previously, lanthaler (Markus Lanthaler) wrote…</i></summary><blockquote>

> Cleint

--> Client
</blockquote></details>

Done.

---


*Comments from [Reviewable](https://reviewable.io:443/reviews/hydracg/specifications/159)*
<!-- Sent from Reviewable.io -->


-- 
GitHub Notification of comment by alien-mcl
Please view or discuss this issue at https://github.com/HydraCG/Specifications/pull/159#issuecomment-372798271 using your GitHub account

Received on Tuesday, 13 March 2018 19:58:24 UTC