Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[CRUD] hydra:returns & sh:property #25

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open

[CRUD] hydra:returns & sh:property #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions crud-operaties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Allow: GET,PUT,DELETE

### Hydra

De toegelaten operaties worden meegegeven in de response body via de eigenschap [hydra:operation](http://www.w3.org/ns/hydra/core#operation). Verder kan, waar relevant, de verwachte input worden meegegevens via de eigenschap [hydra:expects](http://www.w3.org/ns/hydra/core#expects).
De toegelaten operaties worden meegegeven in de response body via de eigenschap [hydra:operation](http://www.w3.org/ns/hydra/core#operation). Verder kan, waar relevant, de verwachte input worden meegegevens via de eigenschap [hydra:expects](http://www.w3.org/ns/hydra/core#expects). Ten slotte kan via de eigenschap [hydra:returns](http://www.w3.org/ns/hydra/core#returns) aangeduid worden welke output teruggegeven wordt.

```json
{
Expand All @@ -69,7 +69,8 @@ De toegelaten operaties worden meegegeven in de response body via de eigenschap
"operation": [
{
"@type": "Operation",
"method": "GET"
"method": "GET",
"returns": "schema:Event"
},
{
"@type": "Operation",
Expand All @@ -80,7 +81,7 @@ De toegelaten operaties worden meegegeven in de response body via de eigenschap
}
```

De informatie die verwacht wordt als input door de API (`hydra:expects`) kan verder gespecifieerd worden door gebruik te maken van de [Shapes Constraint Language (SHACL)](https://www.w3.org/TR/shacl/):
De informatie die verwacht wordt als input (`hydra:expects`) of output (`hydra:returns`) door de API kan verder gespecifieerd worden door gebruik te maken van de [Shapes Constraint Language (SHACL)](https://www.w3.org/TR/shacl/):

```json
{
Expand All @@ -91,11 +92,16 @@ De informatie die verwacht wordt als input door de API (`hydra:expects`) kan ver
},
"@id": "/api/resource/1",
"operation": [
{
"@type": "Operation",
"method": "GET",
"returns": "http://example.org/EventShape"
},
{
"@type": "Operation",
"method": "PUT",
"expects": {
"@id": "schema:Event",
"@id": "http://example.org/EventShape",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wordt dit dat dan niet meer als blanknode gebruikt?

"sh:targetClass": "schema:Event",
"sh:property": [
{
Expand All @@ -122,7 +128,7 @@ Namespace prefix hydra: http://www.w3.org/ns/hydra/core#
1. Als de ALLOW header van een Resource response een GET, PUT, DELETE, POST, HEAD en/of PATCH methode bevat, voorzie in een generieke afhandeling in lijn met [RFC7231](https://tools.ietf.org/html/rfc7231).
2. Anders, als de response header `application/ld+json` als Content-Type bevat, gebruik het [JSON-LD 1.1 processing algoritme](https://json-ld.org/spec/FCGS/json-ld-api/20180607/#expansion-algorithms) om de response om te zetten in zijn geëxpandeerde vorm.
3. Als de response een object bevat met als attribuut `hydra:operation`, gebruik het corresponderende `hydra:Operation` object om te voorzien in een generieke afhandeling in lijn met [RFC7231](https://tools.ietf.org/html/rfc7231).
4. Als de `hydra:Operation` een attribuut `hydra:expects` bevat, voer een `GET` operatie uit op de corresponderende resource om de lijst met ondersteunde attributen (`hydra:suppertProperty`) voor een create of update operatie te bekomen. Gebruik deze response om eventueel een dynamisch input formulier op te stellen.
4. Als de `hydra:Operation` een attribuut `hydra:expects` of `hydra:returns` bevat, voer indien nodig een `GET` operatie uit op de corresponderende resource om de lijst met ondersteunde attributen (`sh:property`) voor een create of update operatie te bekomen. Gebruik deze response om eventueel een dynamisch input formulier op te stellen. Verwijs naar de verwachte vorm (zogenoemde `SHACL shape`) van een applicatie profiel om aan te duiden dat de response hiermee in lijn is.

## Herbruikbare library

Expand Down