diff --git a/API-strategie-algemeen/Architectuur/config.js b/API-strategie-algemeen/Architectuur/config.js index 45a3f056..ba5119c5 100644 --- a/API-strategie-algemeen/Architectuur/config.js +++ b/API-strategie-algemeen/Architectuur/config.js @@ -12,6 +12,7 @@ //-- . . . . . : 20200417 - JvG - Definitieve versie van 04-02-2020 gemaakt //-- . . . . . : 20220412 - EJR - Vastgestelde versie van 09-03-2022 gemaakt //-- . . . . . : 20220909 - MvdP - Concept versie opzet voor Modulaire opbouw +//-- . . . . . : 20220909 - Ft - Versie ter vaststelling voor Modulaire opbouw //-- //------------------------------------------------------------------------------------- @@ -41,13 +42,13 @@ function custGHPG(respecConfig) var respecConfig = { - specStatus: "WV", + specStatus: "VV", specType: "HR", pubDomain: "api", - //publishDate: "2022-01-13", + //publishDate: "2023-01-13", previousPublishDate: "2022-03-09", previousMaturity: "GN-DEF", - edDraftURI: "https://geonovum.github.io/KP-APIs/API-strategie-algemeen/", + edDraftURI: "https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Architectuur/", editors: [ { @@ -59,6 +60,11 @@ var respecConfig = name: "Jan van Gelder", company: "Geonovum", companyURL: "https://www.Geonovum.nl/", + }, + { + name: "Martin van der Plas", + company: "Logius", + companyURL: "https://logius.nl/", } ], authors: diff --git a/API-strategie-algemeen/Architectuur/index.html b/API-strategie-algemeen/Architectuur/index.html index 383f384e..e5664157 100644 --- a/API-strategie-algemeen/Architectuur/index.html +++ b/API-strategie-algemeen/Architectuur/index.html @@ -31,7 +31,7 @@

Samenvatting

-

Ten opzichte van de vorige versie van de API strategie (28-06-2021) is het hoofdstuk "API Strategie voor de overheid" aangepast.

+

Ten opzichte van de vorige versie van de API strategie (09-03-2022) is de layout verandert en het hoofdstuk architectuur in een los document geplaatst.

diff --git a/API-strategie-algemeen/Gebruikerswensen/config.js b/API-strategie-algemeen/Gebruikerswensen/config.js index d88c2ea4..dc1307f1 100644 --- a/API-strategie-algemeen/Gebruikerswensen/config.js +++ b/API-strategie-algemeen/Gebruikerswensen/config.js @@ -12,6 +12,7 @@ //-- . . . . . : 20200417 - JvG - Definitieve versie van 04-02-2020 gemaakt //-- . . . . . : 20220412 - EJR - Vastgestelde versie van 09-03-2022 gemaakt //-- . . . . . : 20220909 - MvdP - Concept versie opzet voor Modulaire opbouw +//-- . . . . . : 20230909 - FT - versie ter vaststelling voor Modulaire opbouw //-- //------------------------------------------------------------------------------------- @@ -41,13 +42,13 @@ function custGHPG(respecConfig) var respecConfig = { - specStatus: "WV", + specStatus: "VV", specType: "HR", pubDomain: "api", //publishDate: "2022-01-13", previousPublishDate: "2022-03-09", previousMaturity: "GN-DEF", - edDraftURI: "https://geonovum.github.io/KP-APIs/API-strategie-algemeen/", + edDraftURI: "https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Gebruikerswensen/", editors: [ { @@ -59,6 +60,11 @@ var respecConfig = name: "Jan van Gelder", company: "Geonovum", companyURL: "https://www.Geonovum.nl/", + }, + { + name: "Martin van der Plas", + company: "Logius", + companyURL: "https://logius.nl/", } ], authors: diff --git a/API-strategie-algemeen/Gebruikerswensen/index.html b/API-strategie-algemeen/Gebruikerswensen/index.html index 08ed6469..63cb4991 100644 --- a/API-strategie-algemeen/Gebruikerswensen/index.html +++ b/API-strategie-algemeen/Gebruikerswensen/index.html @@ -31,7 +31,7 @@

Samenvatting

-

Ten opzichte van de vorige versie van de API strategie (28-06-2021) is het hoofdstuk "API Strategie voor de overheid" aangepast.

+

Ten opzichte van de vorige versie van de API strategie (09-03-2022) is de layout verandert en het hoofdstuk gebruikerswensen in een los document geplaatst

diff --git a/API-strategie-modules/access-control/js/config.js b/API-strategie-modules/access-control/js/config.js index da5840bb..4b1d62c7 100644 --- a/API-strategie-modules/access-control/js/config.js +++ b/API-strategie-modules/access-control/js/config.js @@ -1,12 +1,12 @@ const documentConfig = { //voor specStatus mogelijkheden zie https://github.com/Logius-standaarden/respec/wiki/specStatus - specStatus: "WV", + specStatus: "VV", //voor specType mogelijkheden zie https://github.com/Logius-standaarden/respec/wiki/specType specType: "HR", pubDomain: "api", - shortName: "security", - publishDate: "2022-06-24", - publishVersion: "0.0.1", + shortName: "access-control", +// publishDate: "2022-06-24", + publishVersion: "1.0.0", // previousPublishVersion: "(none)", // previousPublishDate: "(none)", // previousMaturity: "WV", diff --git a/API-strategie-modules/hypermedia/js/config.js b/API-strategie-modules/hypermedia/js/config.js index 31f17285..a8560f1b 100644 --- a/API-strategie-modules/hypermedia/js/config.js +++ b/API-strategie-modules/hypermedia/js/config.js @@ -1,29 +1,29 @@ const documentConfig = { //voor specStatus mogelijkheden zie https://github.com/Logius-standaarden/respec/wiki/specStatus - specStatus: "WV", + specStatus: "VV", //voor specType mogelijkheden zie https://github.com/Logius-standaarden/respec/wiki/specType specType: "HR", pubDomain: "api", shortName: "hypermedia", - publishDate: "2023-06-05", +// publishDate: "2023-06-05", publishVersion: "1.0.0", - previousPublishVersion: "0.0.0", +// previousPublishVersion: "0.0.0", // previousPublishDate: "(none)", // previousMaturity: "WV", editors: [ { - name: "Logius Standaarden", - company: "Logius", - companyURL: "https://github.com/Logius-standaarden", + name: "Kennisplatform API's", + company: "Kennisplatform API's", + companyURL: "https://github.com/Geonovum/KP-APIs", } ], authors: [ { - name: "Logius Standaarden", - company: "Logius", - companyURL: "https://github.com/Logius-standaarden", + name: "Kennisplatform API's", + company: "Kennisplatform API's", + companyURL: "https://github.com/Geonovum/KP-APIs", } ], github: "https://github.com/Geonovum/KP-APIs", diff --git a/API-strategie-modules/naming-conventions/js/config.js b/API-strategie-modules/naming-conventions/js/config.js index ffeda1da..84bba5fe 100644 --- a/API-strategie-modules/naming-conventions/js/config.js +++ b/API-strategie-modules/naming-conventions/js/config.js @@ -1,11 +1,11 @@ const documentConfig = { //voor specStatus mogelijkheden zie https://github.com/Logius-standaarden/respec/wiki/specStatus - specStatus: "WV", + specStatus: "VV", //voor specType mogelijkheden zie https://github.com/Logius-standaarden/respec/wiki/specType specType: "HR", pubDomain: "api", shortName: "naming-conventions", - publishDate: "2023-06-06", +// publishDate: "2023-06-06", publishVersion: "1.0.0", previousPublishVersion: "0.0.0", // previousPublishDate: "(none)", @@ -13,17 +13,16 @@ const documentConfig = { editors: [ { - name: "Logius Standaarden", - company: "Logius", - companyURL: "https://github.com/Logius-standaarden", - } - ], + name: "Kennisplatform API's", + company: "Kennisplatform API's", + companyURL: "https://github.com/Geonovum/KP-APIs", + } ], authors: [ { - name: "Logius Standaarden", - company: "Logius", - companyURL: "https://github.com/Logius-standaarden", + name: "Kennisplatform API's", + company: "Kennisplatform API's", + companyURL: "https://github.com/Geonovum/KP-APIs", } ], github: "https://github.com/Geonovum/KP-APIs", diff --git a/API-strategie-modules/transport-security/js/config.js b/API-strategie-modules/transport-security/js/config.js index 12e5a098..d1e570d8 100644 --- a/API-strategie-modules/transport-security/js/config.js +++ b/API-strategie-modules/transport-security/js/config.js @@ -1,12 +1,12 @@ const documentConfig = { //voor specStatus mogelijkheden zie https://github.com/Logius-standaarden/respec/wiki/specStatus - specStatus: "WV", + specStatus: "VV", //voor specType mogelijkheden zie https://github.com/Logius-standaarden/respec/wiki/specType specType: "HR", pubDomain: "api", - shortName: "security", - publishDate: "2023-05-24", - publishVersion: "0.1.0", + shortName: "transport-security", +// publishDate: "2023-05-24", + publishVersion: "1.0.0", // previousPublishVersion: "(none)", // previousPublishDate: "(none)", // previousMaturity: "WV", diff --git a/inleiding.md b/inleiding.md index d13ae2dd..93e4bd9b 100644 --- a/inleiding.md +++ b/inleiding.md @@ -21,20 +21,20 @@ De API strategie bestaat uit een een inleidend document, verschillende normatiev De verschillende onderdelen van de NL API Strategie bevat de volgende documenten: -| Onderdeel | Documentnaam &
Verwijzing naar de gepubliceerde versie | Status | Versie | -| ---------------------- | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------- | ----------------------- | -| Algemeen | [Inleiding NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Inleiding/) | Vastgesteld
(door Kennisplatform) | 09-03-2022 | -| Algemeen | [Architectuur NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Architectuur/) | Vastgesteld
(door Kennisplatform) | 09-03-2022 | -| Algemeen | [Gebruikerswensen NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Gebruikerswensen/) | Vastgesteld
(door Kennisplatform) | 09-03-2022 | -| Normatieve standaard | [API Design Rules (ADR)](https://gitdocumentatie.logius.nl/publicatie/api/adr/) | Verplicht
(pas toe leg uit) | 09-07-2020
v1.0.0 | -| Verplichte standaard | [Open API Specification (OAS)](https://forumstandaardisatie.nl/open-standaarden/openapi-specification) | Verplicht
(pas toe leg uit) | 25-05-2018
v3.0.0 | -| Normatieve standaard | [NL GOV OAuth profiel](https://gitdocumentatie.logius.nl/publicatie/api/oauth/) | Verplicht
(pas toe leg uit) | 09-07-2020
v1.0.0 | -| Voorgestelde standaard | [NL GOV OpenID Connect profile](https://logius.gitlab.io/oidc/) | Bijna Verplicht*
(pas toe leg uit)| 18-02-2021
v1.0.0 | -| Verplichte standaard | [Digikoppeling REST API koppelvlak specificatie](https://gitdocumentatie.logius.nl/publicatie/dk/restapi/) | Verplicht
(pas toe leg uit) | 14-11-2022
v1.1.1 | -| Aanvullende module | [API Geospatial Design Rules module](https://docs.geostandaarden.nl/api/API-Strategie-mod-geo/) | Vastgesteld
(door Kennisplatform) | 23-05-2023 | -| Aanvullende module | [API Transport Security module](https://geonovum.github.io/KP-APIs/API-strategie-modules/transport-security/) | Stabiel
(Werkgroep Kennisplatform)| 11-07-2023 | -| Aanvullende module | [API Access control module](https://geonovum.github.io/KP-APIs/API-strategie-modules/access-control/) | Stabiel
(Werkgroep Kennisplatform)| 11-07-2023 | -| Aanvullende module | [API Naming conventions module](https://geonovum.github.io/KP-APIs/API-strategie-modules/naming-conventions/) | Stabiel
(Werkgroep Kennisplatform)| 12-07-2023 | -| Aanvullende module | [API Hypermedia module](https://geonovum.github.io/KP-APIs/API-strategie-modules/hypermedia/) | Stabiel
(Werkgroep Kennisplatform)| 12-07-2023 | - -* 21 september 2023 besluit het OBDO over de opname van het OIDC profiel op de lijst verplichte standaarden van het Forum Standaardisatie. +| Onderdeel | Documentnaam &
Verwijzing naar de gepubliceerde versie | Status | Versie | +| ---------------------- | ---------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ----------------------- | +| Algemeen | [Inleiding NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Inleiding/) | Vastgesteld
(door Kennisplatform) | 09-03-2022 | +| Algemeen | [Architectuur NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Architectuur/) | Vastgesteld
(door Kennisplatform) | 09-03-2022 | +| Algemeen | [Gebruikerswensen NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Gebruikerswensen/) | Vastgesteld
(door Kennisplatform) | 09-03-2022 | +| Normatieve standaard | [API Design Rules (ADR)](https://gitdocumentatie.logius.nl/publicatie/api/adr/) | Verplicht
(pas toe leg uit) | 09-07-2020
v1.0.0 | +| Verplichte standaard | [Open API Specification (OAS)](https://forumstandaardisatie.nl/open-standaarden/openapi-specification) | Verplicht
(pas toe leg uit) | 25-05-2018
v3.0.0 | +| Normatieve standaard | [NL GOV OAuth profiel](https://gitdocumentatie.logius.nl/publicatie/api/oauth/) | Verplicht
(pas toe leg uit) | 09-07-2020
v1.0.0 | +| Voorgestelde standaard | [NL GOV OpenID Connect profile](https://logius.gitlab.io/oidc/) | Verplicht
(pas toe leg uit) | 18-02-2021
v1.0.0 | +| Verplichte standaard | [Digikoppeling REST API koppelvlak specificatie](https://gitdocumentatie.logius.nl/publicatie/dk/restapi/) | Verplicht
(pas toe leg uit) | 14-11-2022
v1.1.1 | +| Aanvullende module | [API Geospatial Design Rules module](https://docs.geostandaarden.nl/api/API-Strategie-mod-geo/) | Vastgesteld *
(door Kennisplatform) | 23-05-2023 | +| Aanvullende module | [API Transport Security module](https://geonovum.github.io/KP-APIs/API-strategie-modules/transport-security/) | Stabiel *
(Werkgroep Kennisplatform)| 11-07-2023 | +| Aanvullende module | [API Access control module](https://geonovum.github.io/KP-APIs/API-strategie-modules/access-control/) | Stabiel
(Werkgroep Kennisplatform) | 11-07-2023 | +| Aanvullende module | [API Naming conventions module](https://geonovum.github.io/KP-APIs/API-strategie-modules/naming-conventions/) | Stabiel
(Werkgroep Kennisplatform) | 12-07-2023 | +| Aanvullende module | [API Hypermedia module](https://geonovum.github.io/KP-APIs/API-strategie-modules/hypermedia/) | Stabiel
(Werkgroep Kennisplatform) | 12-07-2023 | + +* Deze modules zijn voordragen als normatief, vaststellingsproces is nog niet compleet \ No newline at end of file diff --git a/media/API infographic.drawio b/media/API infographic.drawio index ed008912..f189e216 100644 --- a/media/API infographic.drawio +++ b/media/API infographic.drawio @@ -1,6 +1,6 @@ - + - + @@ -37,17 +37,17 @@ - + - + - + @@ -75,7 +75,7 @@ - + @@ -88,12 +88,12 @@ - + - + @@ -108,7 +108,7 @@ - + @@ -118,7 +118,7 @@ - + @@ -143,7 +143,7 @@ - + @@ -245,7 +245,7 @@ - + diff --git a/media/API_infographic.png b/media/API_infographic.png index 119346b5..df5959b2 100644 Binary files a/media/API_infographic.png and b/media/API_infographic.png differ diff --git a/media/API_infographic.svg b/media/API_infographic.svg index 7e7d2fb3..c0df4f5d 100644 --- a/media/API_infographic.svg +++ b/media/API_infographic.svg @@ -1,4 +1,4 @@ -
Legenda
Legenda
Verplichte
'Pas toe of leg uit'
-lijst standaarden
Verplichte...Algemene documenten
Inleiding
NL API Strategie
Inleiding...
Gebruikerswensen
NL API Strategie
Gebruikerswensen...
Architectuur
NL API Strategie
Architectuur...Normatieve documenten
API Design Rules (ADR)
API Design Rules (ADR)
Open API Specification (OAS)
Open API Specification (OAS)
NL GOV OAuth profiel
NL GOV OAuth profiel
Digikoppeling REST API koppelvlak specificatie
Digikoppeling REST API koppelvla...
NL GOV OIDC profiel *
NL GOV OIDC profiel *
NL API Strategie
NL API StrategieModulen documenten
GEO module
GEO module
Transport Security module
Transport Security module
API Management module
API Management module
Versioning module
Versioning module
API Access module
API Access module
Signing & Encription module
Signing & Encription module
Naming conventions module
Naming conventions module
JSON module
JSON module
Filtering & Sorting module
Filtering & Sorting module
Search & Customization module
Search & Customization module
Temporal module
Temporal module
Hypermedia module
Hypermedia module
Pagination module
Pagination module
Caching module
Caching module
Rate limiting module
Rate limiting module
Error handling module
Error handling module
Delegation module
Delegation module
Logging module
Logging module
API Monitoring module
API Monitoring module
Discovery module
Discovery module
Vastgestelde algemene documenten
Vastgestelde algemen...
Concept modules
Concept modules
Stabiele modules
Stabiele modules
Laatst bijgewerkt:

dd. 06-09-2023
Versie 0.7.1
Laatst bijgewerkt:...
Infographic
NL API Strategie
Infographic...
Nog te ontwikkelen modules
Nog te ontwikkelen m...
Normatieve kennisplatform standaarden
Normatieve kennispla...Text is not SVG - cannot display \ No newline at end of file +
Legenda
Legenda
Verplichte
'Pas toe of leg uit'
-lijst standaarden
Verplichte...Algemene documenten
Inleiding
NL API Strategie
Inleiding...
Gebruikerswensen
NL API Strategie
Gebruikerswensen...
Architectuur
NL API Strategie
Architectuur...Normatieve documenten
API Design Rules (ADR)
API Design Rules (ADR)
Open API Specification (OAS)
Open API Specification (OAS)
NL GOV OAuth profiel
NL GOV OAuth profiel
Digikoppeling REST API koppelvlak specificatie
Digikoppeling REST API koppelvla...
NL GOV OIDC profiel
NL GOV OIDC profiel
NL API Strategie
NL API StrategieModulen documenten
GEO module *
GEO module *
Transport Security module *
Transport Security module *
API Management module
API Management module
Versioning module
Versioning module
API Access module
API Access module
Signing & Encription module
Signing & Encription module
Naming conventions module
Naming conventions module
JSON module
JSON module
Filtering & Sorting module
Filtering & Sorting module
Search & Customization module
Search & Customization module
Temporal module
Temporal module
Hypermedia module
Hypermedia module
Pagination module
Pagination module
Caching module
Caching module
Rate limiting module
Rate limiting module
Error handling module
Error handling module
Delegation module
Delegation module
Logging module
Logging module
API Monitoring module
API Monitoring module
Discovery module
Discovery module
Vastgestelde algemene documenten
Vastgestelde algemen...
Concept modules
Concept modules
Stabiele modules
Stabiele modules
Laatst bijgewerkt:

dd. 15-12-2023
Versie 0.9.9
Laatst bijgewerkt:...
Infographic
NL API Strategie
Infographic...
Nog te ontwikkelen modules
Nog te ontwikkelen m...
Normatieve kennisplatform standaarden
Normatieve kennispla...Text is not SVG - cannot display \ No newline at end of file