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

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

---

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

Yeah, I think it would clarify it
</blockquote></details>

Done.

---

*[drafts/use-cases/2.3.complete-api-documentation.md, line 40 at r1](https://reviewable.io/reviews/hydracg/specifications/164#-LBHP4uv4JwardklmAHo:-LDXjnbR0-NDQ4Lt8Y-c:b-xjf0qk) ([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>

I'd think making this `<>` instead of `<?apiDocumentation>` would simplify things.
</blockquote></details>

But `<>` is an API's entry point, which is not it's API documentation.

---

*[drafts/use-cases/2.3.complete-api-documentation.md, line 48 at r1](https://reviewable.io/reviews/hydracg/specifications/164#-LBHPFNZ4g8XnxpvBz9L:-LDXjysE-i18IDWmjcrP:bfd44dn) ([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'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
</blockquote></details>

As previously - `@base` points to the API entry point, `doc:` prefix points to the API documentation, which are separate beings. I feel some IRI re-factorization is necessary here - any suggestions?

---

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

You could reference the issue in which we are working on that here
</blockquote></details>

Done.

---

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

itsefl --> itself
</blockquote></details>

Done.

---

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

That's currently not possible
</blockquote></details>

I've added an issue to address this.

---

*[drafts/use-cases/2.3.complete-api-documentation.md, line 119 at r1](https://reviewable.io/reviews/hydracg/specifications/164#-LBHQaX47tRg58Q2OLvi:-LDXmNmV7m5GnZ0Ob1py:b-tlwe14) ([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>

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!?
</blockquote></details>

I'd like to give a client a hint, that it can use `GET`, `PUT` and `DELETE` methods on a very specific instances that can be addressed with an IRI template.

---


*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-392351891 using your GitHub account

Received on Sunday, 27 May 2018 18:10:23 UTC