verplicht het toepassen van de standaard Federated Service Connectivity #27

ronaldkoster · 2023-12-18T10:25:28Z

Na behandeling in het TO Digikoppeling 29/5 is dit wijzigingsvoorstel aangepast naar "FSC opnemen als Aanbevolen" (in plaats van Verplicht)
Zie:

federated service connectivity toegevoegd aan de voorschriften voor REST API's Digikoppeling-Architectuur#14

Toevoeging FSC #29

Issue #26 is gemaakt om FSC toe te voegen aan Digikoppeling

mrtn78 · 2024-01-30T09:13:20Z

ch03_Digikoppeling Restful API profiel.md

+Het Digikoppeling REST API profiel geeft invulling aan bepaalde keuzes die gemaakt moeten worden bij het gebruik van FSC. 
+In het Digikoppeling REST API profiel wordt er vanuit gegaan dat de lezer bekent is met de standaard FSC. Er worden namelijk termen gebruikt uit deze standaard.
+
+* Zie [FSC](https://commonground.gitlab.io/standards/fsc/)


Hier graag een verdere duiding maken van de 3 onderliggende standaarden en direct verwijzen naar de 3 documenten.

Core

html

Delegation

html

Logging

html

mrtn78 · 2024-01-30T09:14:11Z

ch03_Digikoppeling Restful API profiel.md

 * Zie [[Digikoppeling-Beveiligingsdocument]]

+FSC spreekt over een Thrust Anchor die door een Group moet worden gekozen. De Trust Anchor is binnen de context van X.509 certificaten de certificate authority (CA) waaruit het vertrouwen wordt afgeleid.


Suggested change

FSC spreekt over een Thrust Anchor die door een Group moet worden gekozen. De Trust Anchor is binnen de context van X.509 certificaten de certificate authority (CA) waaruit het vertrouwen wordt afgeleid.

FSC spreekt over een Trust Anchor die door een Group moet worden gekozen. De Trust Anchor is binnen de context van X.509 certificaten de certificate authority (CA) waaruit het vertrouwen wordt afgeleid.

mrtn78 · 2024-01-30T09:15:09Z

ch03_Digikoppeling Restful API profiel.md

-Digikoppeling maakt gebruik van het OIN (Organisatie Identificatie Nummer) voor de identificatie van organisaties.
-Binnen dit DK REST-API profielprofiel zijn er alleen voorschriften m.b.t. het verplicht gebruik van het OIN binnen PKIO certificaten. Voor OIN gebruik binnen payloads (bv JSON) of resource-pad gelden geen specifieke voorschriften.
+Digikoppeling maakt gebruik van het OIN (Organisatie Identificatie Nummer) voor de identificatie van organisaties. Dit is het PeerID binnen de context van FSC. Het OIN wordt bij PKIO certificaten geplaatst in het SerialNumber veld van het Subject.
+Het verplicht vanuit FSC om te bepalen welk veld uit het certificaat de Peer name bepaald. Dit is het organization veld van het Subject van het PKIO certificaat.


Suggested change

Het verplicht vanuit FSC om te bepalen welk veld uit het certificaat de Peer name bepaald. Dit is het organization veld van het Subject van het PKIO certificaat.

Het is verplicht vanuit FSC om te bepalen welk veld uit het certificaat de Peer name bepaald. Dit is het organization veld van het Subject van het PKIO certificaat.

mrtn78 · 2024-01-30T09:24:37Z

ch03_Digikoppeling Restful API profiel.md

+Een exponential backoff retry-mechanism is een mechanisme dat een mislukt verzoek opnieuw gaat uitvoeren op een interval die exponentieel groeit. 
+Deze exponentiële groei voorkomt dat een applicatie een veelfout van verzoeken verstuurd naar een service die niet bereikbaar is. 
+
+Voorbeeld: Peer A verstuurt een Contract naar Peer B. Het versturen mislukt. Peer A probeert het opnieuw na 1 seconde, het verzoek mislukt weer. De volgende poging wordt gedaan na 2 seconden, daarna 4 seconden, vervolgens 16 seconden, enzovoort. Om te voorkomen dat er langlopende processen worden gecreëerd hanteerd Peer A een maximale interval van 300 seconden.  


Is dit interval en deze maximum waarde een vereiste of alleen een voorbeeld. En als dit alleen een voorbeeld is waar worden deze afspraken dan gemaakt en vastgelegd?

mrtn78 · 2024-01-30T09:26:04Z

ch03_Digikoppeling Restful API profiel.md

+> Het retry mechanisme betreft niet de HTTP-requests voor het bevragen van een Service.
+
+Een exponential backoff retry-mechanism is een mechanisme dat een mislukt verzoek opnieuw gaat uitvoeren op een interval die exponentieel groeit. 
+Deze exponentiële groei voorkomt dat een applicatie een veelfout van verzoeken verstuurd naar een service die niet bereikbaar is. 


Suggested change

Deze exponentiële groei voorkomt dat een applicatie een veelfout van verzoeken verstuurd naar een service die niet bereikbaar is.

Deze exponentiële groei voorkomt dat een applicatie een veelvoud van verzoeken verstuurd naar een service die niet bereikbaar is.

edwinwisse · 2024-02-01T08:56:31Z

ch03_Digikoppeling Restful API profiel.md


 ## Inleiding

 ### Historie

-Vanuit het TO Digikoppeling zijn al langere tijd de ontwikkelingen rond Restful API's gevolgd. Binnen het Kennisplatform API zijn de REST-API Design Rules (REST ADR) ontwikkeld en de REST ADR standaard is ook opgenomen op de Pas-toe-of-leg-uit lijst van het Forum Standaardisatie. De REST ADR standaard is dan ook als basis genomen voor dit Digikoppeling REST API Profiel dat zich specifiek richt op G2G (Government-to-Government) interactie en M2M (Machine-to-Machine verkeer).
+Vanuit het TO Digikoppeling zijn al langere tijd de ontwikkelingen rond RESTful API's gevolgd. Binnen het Kennisplatform API zijn de REST-API Design Rules (REST ADR) ontwikkeld en de REST ADR standaard is ook opgenomen op de Pas-toe-of-leg-uit lijst van het Forum Standaardisatie. De REST ADR standaard is dan ook als basis genomen voor dit Digikoppeling REST API Profiel dat zich specifiek richt op G2G (Government-to-Government) interactie en M2M (Machine-to-Machine verkeer).
+Daarnaast is de standaard Federated Service Connectivity (FSC) ontwikkelt die voorschrijft hoe organisaties REST API's kunnen ontdekken, aanbieden en consumeren. De FSC standaard is opgenomen in dit Digikoppeling REST API Profiel om de koppelingen met REST API's te standardiseren waardoor er een interoperabel API landschap ontstaat.  


ontwikkeld (ipv ontwikkelt)

strijm · 2024-03-04T10:25:35Z

ch03_Digikoppeling Restful API profiel.md

-Binnen dit DK REST-API profielprofiel zijn er alleen voorschriften m.b.t. het verplicht gebruik van het OIN binnen PKIO certificaten. Voor OIN gebruik binnen payloads (bv JSON) of resource-pad gelden geen specifieke voorschriften.
+Digikoppeling maakt gebruik van het OIN (Organisatie Identificatie Nummer) voor de identificatie van organisaties. Dit is het PeerID binnen de context van FSC. Het OIN wordt bij PKIO certificaten geplaatst in het SerialNumber veld van het Subject.
+Het verplicht vanuit FSC om te bepalen welk veld uit het certificaat de Peer name bepaald. Dit is het organization veld van het Subject van het PKIO certificaat.
+Binnen dit Digikoppeling REST API profielprofiel zijn er alleen voorschriften m.b.t. het verplicht gebruik van het OIN binnen PKIO certificaten en FSC. Voor OIN gebruik binnen payloads (bv JSON) of resource-pad gelden geen specifieke voorschriften.


profielprofiel -> profiel

kad-vijlbc · 2024-03-06T10:25:52Z

ch03_Digikoppeling Restful API profiel.md

+#### Contracten
+
+FSC gebruikt Contracten om afspraken tussen Peers vast te leggen. Een Contract kan één of meerdere Grants bevatten. Een Grant beschrijft welke interactie er mogelijk is tussen de Peers.
+FSC plaatst geen beperking op het aantal Grants per Contract. Het Digikoppeling REST API profiel doet dit wel om te voorkomen dat er fragiele Contracten ontstaan met een hoge beheerslast. Het aantal Grants wordt beperkt tot maximaal 10.


Deze beperking van 10 lijkt mij in praktijk wel een issue. Hoe gaan we hier mee om? Meerdere contracten opstellen? De beperking van 10 kon ik ook niet zo snel vinden in het REST API profiel (link toevoegen?)

ronaldkoster mentioned this pull request Dec 18, 2023

Federatieve Service Connectiviteit opnemen in het Digikoppeling voor REST API's profiel #26

Open

sanderke linked an issue Jan 8, 2024 that may be closed by this pull request

Federatieve Service Connectiviteit opnemen in het Digikoppeling voor REST API's profiel #26

Open

ronaldkoster force-pushed the develop branch from ec21c4b to 96df15e Compare January 16, 2024 08:23

mrtn78 requested changes Jan 30, 2024

View reviewed changes

mrtn78 requested a review from PHaasnoot January 30, 2024 09:26

edwinwisse reviewed Feb 1, 2024

View reviewed changes

ronaldkoster force-pushed the develop branch from 96df15e to 43be9a4 Compare February 2, 2024 08:04

mrtn78 approved these changes Feb 5, 2024

View reviewed changes

ronaldkoster force-pushed the develop branch from 43be9a4 to 5bd25d1 Compare February 8, 2024 09:31

PHaasnoot approved these changes Feb 14, 2024

View reviewed changes

mrtn78 mentioned this pull request Feb 15, 2024

federated service connectivity toegevoegd aan de voorschriften voor REST API's Logius-standaarden/Digikoppeling-Architectuur#14

Open

strijm reviewed Mar 4, 2024

View reviewed changes

kad-vijlbc reviewed Mar 6, 2024

View reviewed changes

verplicht het toepassen van de standaard Federated Service Connectivity

5049679

ronaldkoster force-pushed the develop branch from 5bd25d1 to 8154810 Compare April 24, 2024 14:44

beschrijving retry-mechanisme herschreven en een voorbeeld toegevoegd

03d3006

ronaldkoster force-pushed the develop branch from 8154810 to 03d3006 Compare June 4, 2024 12:38

sanderke removed a link to an issue Jun 11, 2024

Federatieve Service Connectiviteit opnemen in het Digikoppeling voor REST API's profiel #26

Open

sanderke changed the base branch from develop to fsc June 11, 2024 10:48

Merge branch 'fsc' into develop

2573fbc

sanderke merged commit d251037 into Logius-standaarden:fsc Jun 11, 2024
4 of 5 checks passed

logius-standaardenbeheer mentioned this pull request Jun 11, 2024

Toevoeging FSC #29

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

verplicht het toepassen van de standaard Federated Service Connectivity #27

verplicht het toepassen van de standaard Federated Service Connectivity #27

ronaldkoster commented Dec 18, 2023 •

edited by PHaasnoot

Loading

mrtn78 Jan 30, 2024

mrtn78 Jan 30, 2024

mrtn78 Jan 30, 2024

mrtn78 Jan 30, 2024

mrtn78 Jan 30, 2024

edwinwisse Feb 1, 2024

strijm Mar 4, 2024

kad-vijlbc Mar 6, 2024

		* Zie [[Digikoppeling-Beveiligingsdocument]]

		FSC spreekt over een Thrust Anchor die door een Group moet worden gekozen. De Trust Anchor is binnen de context van X.509 certificaten de certificate authority (CA) waaruit het vertrouwen wordt afgeleid.

	FSC spreekt over een Thrust Anchor die door een Group moet worden gekozen. De Trust Anchor is binnen de context van X.509 certificaten de certificate authority (CA) waaruit het vertrouwen wordt afgeleid.
	FSC spreekt over een Trust Anchor die door een Group moet worden gekozen. De Trust Anchor is binnen de context van X.509 certificaten de certificate authority (CA) waaruit het vertrouwen wordt afgeleid.

	Het verplicht vanuit FSC om te bepalen welk veld uit het certificaat de Peer name bepaald. Dit is het organization veld van het Subject van het PKIO certificaat.
	Het is verplicht vanuit FSC om te bepalen welk veld uit het certificaat de Peer name bepaald. Dit is het organization veld van het Subject van het PKIO certificaat.

	Deze exponentiële groei voorkomt dat een applicatie een veelfout van verzoeken verstuurd naar een service die niet bereikbaar is.
	Deze exponentiële groei voorkomt dat een applicatie een veelvoud van verzoeken verstuurd naar een service die niet bereikbaar is.

verplicht het toepassen van de standaard Federated Service Connectivity #27

verplicht het toepassen van de standaard Federated Service Connectivity #27

Conversation

ronaldkoster commented Dec 18, 2023 • edited by PHaasnoot Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ronaldkoster commented Dec 18, 2023 •

edited by PHaasnoot

Loading