Skip to content

Commit

Permalink
modulaire versie ter vaststelling klaarzetten
Browse files Browse the repository at this point in the history
  • Loading branch information
@fterpstra
fterpstra committed Dec 15, 2023
1 parent 1511f20 commit 43fdb68
Show file tree
Hide file tree
Showing 12 changed files with 75 additions and 64 deletions.
12 changes: 9 additions & 3 deletions API-strategie-algemeen/Architectuur/config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
//--
//-------------------------------------------------------------------------------------

Expand Down Expand Up @@ -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:
[
{
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion API-strategie-algemeen/Architectuur/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<!-- HTML-Body ================================================================================ -->
<body>
<section id='abstract' data-format="markdown" data-include="samenvatting.md"><h2>Samenvatting</h2></section>
<section id='sotd'><p>Ten opzichte van de vorige versie van de API strategie (28-06-2021) is het hoofdstuk "API Strategie voor de overheid" aangepast.</p></section>
<section id='sotd'><p>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.</p></section>
<!-- vanaf hier per hoofdstuk een sectie of een div in het document ======================== -->
<!-- Secties komen in de inhoudsopgave div's niet ========================================== -->
<!-- Secties hebben verplicht <h2> tags, div's niet ======================================== -->
Expand Down
10 changes: 8 additions & 2 deletions API-strategie-algemeen/Gebruikerswensen/config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
//--
//-------------------------------------------------------------------------------------

Expand Down Expand Up @@ -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:
[
{
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion API-strategie-algemeen/Gebruikerswensen/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<!-- HTML-Body ================================================================================ -->
<body>
<section id='abstract' data-format="markdown" data-include="samenvatting.md"><h2>Samenvatting</h2></section>
<section id='sotd'><p>Ten opzichte van de vorige versie van de API strategie (28-06-2021) is het hoofdstuk "API Strategie voor de overheid" aangepast.</p></section>
<section id='sotd'><p>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</p></section>
<!-- vanaf hier per hoofdstuk een sectie of een div in het document ======================== -->
<!-- Secties komen in de inhoudsopgave div's niet ========================================== -->
<!-- Secties hebben verplicht <h2> tags, div's niet ======================================== -->
Expand Down
8 changes: 4 additions & 4 deletions API-strategie-modules/access-control/js/config.js
View file
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
18 changes: 9 additions & 9 deletions API-strategie-modules/hypermedia/js/config.js
View file
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
19 changes: 9 additions & 10 deletions API-strategie-modules/naming-conventions/js/config.js
View file
Original file line number Diff line number Diff line change
@@ -1,29 +1,28 @@
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)",
// 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",
Expand Down
8 changes: 4 additions & 4 deletions API-strategie-modules/transport-security/js/config.js
View file
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
34 changes: 17 additions & 17 deletions inleiding.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 & </br> Verwijzing naar de gepubliceerde versie | Status | Versie |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------- | ----------------------- |
| Algemeen | [Inleiding NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Inleiding/) | Vastgesteld </br> (door Kennisplatform) | 09-03-2022 |
| Algemeen | [Architectuur NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Architectuur/) | Vastgesteld </br> (door Kennisplatform) | 09-03-2022 |
| Algemeen | [Gebruikerswensen NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Gebruikerswensen/) | Vastgesteld </br> (door Kennisplatform) | 09-03-2022 |
| Normatieve standaard | [API Design Rules (ADR)](https://gitdocumentatie.logius.nl/publicatie/api/adr/) | Verplicht </br> (pas toe leg uit) | 09-07-2020 </br> v1.0.0 |
| Verplichte standaard | [Open API Specification (OAS)](https://forumstandaardisatie.nl/open-standaarden/openapi-specification) | Verplicht </br> (pas toe leg uit) | 25-05-2018 </br> v3.0.0 |
| Normatieve standaard | [NL GOV OAuth profiel](https://gitdocumentatie.logius.nl/publicatie/api/oauth/) | Verplicht </br> (pas toe leg uit) | 09-07-2020 </br> v1.0.0 |
| Voorgestelde standaard | [NL GOV OpenID Connect profile](https://logius.gitlab.io/oidc/) | Bijna Verplicht* </br> (pas toe leg uit)| 18-02-2021 </br> v1.0.0 |
| Verplichte standaard | [Digikoppeling REST API koppelvlak specificatie](https://gitdocumentatie.logius.nl/publicatie/dk/restapi/) | Verplicht </br> (pas toe leg uit) | 14-11-2022 </br> v1.1.1 |
| Aanvullende module | [API Geospatial Design Rules module](https://docs.geostandaarden.nl/api/API-Strategie-mod-geo/) | Vastgesteld </br> (door Kennisplatform) | 23-05-2023 |
| Aanvullende module | [API Transport Security module](https://geonovum.github.io/KP-APIs/API-strategie-modules/transport-security/) | Stabiel </br> (Werkgroep Kennisplatform)| 11-07-2023 |
| Aanvullende module | [API Access control module](https://geonovum.github.io/KP-APIs/API-strategie-modules/access-control/) | Stabiel </br> (Werkgroep Kennisplatform)| 11-07-2023 |
| Aanvullende module | [API Naming conventions module](https://geonovum.github.io/KP-APIs/API-strategie-modules/naming-conventions/) | Stabiel </br> (Werkgroep Kennisplatform)| 12-07-2023 |
| Aanvullende module | [API Hypermedia module](https://geonovum.github.io/KP-APIs/API-strategie-modules/hypermedia/) | Stabiel </br> (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 & </br> Verwijzing naar de gepubliceerde versie | Status | Versie |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ----------------------- |
| Algemeen | [Inleiding NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Inleiding/) | Vastgesteld </br> (door Kennisplatform) | 09-03-2022 |
| Algemeen | [Architectuur NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Architectuur/) | Vastgesteld </br> (door Kennisplatform) | 09-03-2022 |
| Algemeen | [Gebruikerswensen NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Gebruikerswensen/) | Vastgesteld </br> (door Kennisplatform) | 09-03-2022 |
| Normatieve standaard | [API Design Rules (ADR)](https://gitdocumentatie.logius.nl/publicatie/api/adr/) | Verplicht </br> (pas toe leg uit) | 09-07-2020 </br> v1.0.0 |
| Verplichte standaard | [Open API Specification (OAS)](https://forumstandaardisatie.nl/open-standaarden/openapi-specification) | Verplicht </br> (pas toe leg uit) | 25-05-2018 </br> v3.0.0 |
| Normatieve standaard | [NL GOV OAuth profiel](https://gitdocumentatie.logius.nl/publicatie/api/oauth/) | Verplicht </br> (pas toe leg uit) | 09-07-2020 </br> v1.0.0 |
| Voorgestelde standaard | [NL GOV OpenID Connect profile](https://logius.gitlab.io/oidc/) | Verplicht </br> (pas toe leg uit) | 18-02-2021 </br> v1.0.0 |
| Verplichte standaard | [Digikoppeling REST API koppelvlak specificatie](https://gitdocumentatie.logius.nl/publicatie/dk/restapi/) | Verplicht </br> (pas toe leg uit) | 14-11-2022 </br> v1.1.1 |
| Aanvullende module | [API Geospatial Design Rules module](https://docs.geostandaarden.nl/api/API-Strategie-mod-geo/) | Vastgesteld * </br> (door Kennisplatform) | 23-05-2023 |
| Aanvullende module | [API Transport Security module](https://geonovum.github.io/KP-APIs/API-strategie-modules/transport-security/) | Stabiel * </br> (Werkgroep Kennisplatform)| 11-07-2023 |
| Aanvullende module | [API Access control module](https://geonovum.github.io/KP-APIs/API-strategie-modules/access-control/) | Stabiel </br> (Werkgroep Kennisplatform) | 11-07-2023 |
| Aanvullende module | [API Naming conventions module](https://geonovum.github.io/KP-APIs/API-strategie-modules/naming-conventions/) | Stabiel </br> (Werkgroep Kennisplatform) | 12-07-2023 |
| Aanvullende module | [API Hypermedia module](https://geonovum.github.io/KP-APIs/API-strategie-modules/hypermedia/) | Stabiel </br> (Werkgroep Kennisplatform) | 12-07-2023 |

* Deze modules zijn voordragen als normatief, vaststellingsproces is nog niet compleet
Loading

0 comments on commit 43fdb68

Please sign in to comment.