Re: [Specifications] Attempt to describe extensively an API used in Heracles.ts

Review status: all files reviewed, 3 unresolved discussions (waiting on @lanthaler)

---

*[drafts/use-cases/2.3.complete-api-documentation.md, line 40 at r1](https://reviewable.io/reviews/hydracg/specifications/164#-LBHP4uv4JwardklmAHo:-LEpY2RR4mYVfnDc3qX-:b-896fix) ([raw file](https://github.com/hydracg/specifications/blob/c46a6c87fb68dce55656d41ee200d38e2cbf051d/drafts/use-cases/2.3.complete-api-documentation.md#L40)):*
<details><summary><i>Previously, lanthaler (Markus Lanthaler) wrote…</i></summary><blockquote>

It's a relative URL so it depends on where it is hosted (resp. what `@base` says). The main I'd like to avoid is the use of a query param. If you don't like `<>` please make it `</apiDocumentation>` or something similar. I have seen people being confused about this in the past where they thought they would need to return the API docs if something like `?apiDocumentation` is appended to any of their URLs.
</blockquote></details>

Done.

---

*[drafts/use-cases/2.3.complete-api-documentation.md, line 48 at r1](https://reviewable.io/reviews/hydracg/specifications/164#-LBHPFNZ4g8XnxpvBz9L:-LEpWl0F7U_l5dJ4zMcK:b-896fix) ([raw file](https://github.com/hydracg/specifications/blob/c46a6c87fb68dce55656d41ee200d38e2cbf051d/drafts/use-cases/2.3.complete-api-documentation.md#L48)):*
<details><summary><i>Previously, lanthaler (Markus Lanthaler) wrote…</i></summary><blockquote>

I typically prefer to use relative URLs (mostly fragments) for everything that can be found in the same document. Let's just get rid of `@base` and use full, absolute URLs (or path-absolute URLs) for everything else
</blockquote></details>

Done.

---

*[drafts/use-cases/2.3.complete-api-documentation.md, line 119 at r1](https://reviewable.io/reviews/hydracg/specifications/164#-LBHQaX47tRg58Q2OLvi:-LEpXwo47ecXBQuHGqva:b-896fix) ([raw file](https://github.com/hydracg/specifications/blob/c46a6c87fb68dce55656d41ee200d38e2cbf051d/drafts/use-cases/2.3.complete-api-documentation.md#L119)):*
<details><summary><i>Previously, lanthaler (Markus Lanthaler) wrote…</i></summary><blockquote>

I think what you want in that case is a concrete IRI template with those operations attached to it. You don't need a TemplatedLink property for that. That being said, a client wouldn't necessarily use this as of now as there's no way to connect it to a ApiDocumentation (but it would be straightforward to add)
</blockquote></details>

Done.

---


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


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

Received on Tuesday, 12 June 2018 19:50:44 UTC