scope

[bertvannuffelen]

Dit is een discussie over de scope van de deze standaard: https://github.com/Informatievlaanderen/generieke-hypermedia-api#scope

Waar en wanneer wordt aangeraden om deze specificatie te volgen. Wanneer wordt ervan afgeweken.

[bertvannuffelen]

Suggestie tot herschrijven van

Een generieke client herkent op zijn beurt bepaalde bouwblokken en kan daar mee verder aan de slag.

tot

Een client kan dan een generieke afhandeling voorzien voor een bouwblok.

Dan wordt dat blok dus in het geheel:

Een Generieke Hypermedia API beschrijft in elke respons de verdere stappen die vanaf dat punt kunnen worden genomen met behulp van Hypermedia Controls. Een client kan dan een generieke afhandeling voorzien voor een bouwblok. Voor elke bouwblok zal een referentie-implementatie worden voorzien.

Op welke bouwblokken we kunnen rekenen binnen Vlaanderen, wordt gespecificeerd in deze werkgroep.

[bertvannuffelen]

suggestie voor toepassingsgebied

Toepassingsgebied:

De afspraken per bouwblok zijn applicatie-neutraal. In een applicatie-context is het noodzakelijk om uit de verschillende mogelijkheden een coherente keuze te maken. Om dit laatste te vereenvoudigen hebben we 2 applicatie-profielen voorzien: een json-ld (hydra gebaseerd) en een JSON-API.

[jensscheerlinck]

@bertvannuffelen zie je dit laatste als een applicatieprofiel waarin semantiek uit de payload wordt vastgelegd (in JSON-LD bv. met een @context voor Hydra). Of eerder een pagina waarin bepaalde secties uit de verschillende bouwblokken gecombineerd worden (bv. 1 document met uit elke bouwblok de specificaties rond Hydra/JSON API)?

[bertvannuffelen]

Ik zie dat als toetsingsdocumenten. Een API designer zal ofwel json-API volgen ofwel een vrije json-ld aanpak volgen.

voor elk van de verschillende bouwblokken moet er dus een json-API en json-ld toepassing worden weergegeven. Anders kan je de vraag stellen of de ontbrekende wel voldoet aan de vereisten van het bouwblok. Hoe we dat vorm geven dat laat ik in het midden, maar ik noem het een applicatieprofiel omdat het een toepassing is van een bouwblok voor json-API of vrij json(-ld).