Skip to content

Commit

Permalink
Merge branch 'develop' into rsin-als-basis-voor-oin
Browse files Browse the repository at this point in the history
  • Loading branch information
sanderke authored Sep 15, 2023
2 parents 225ae99 + e64cbcc commit 6946968
Show file tree
Hide file tree
Showing 10 changed files with 541 additions and 561 deletions.
File renamed without changes.
File renamed without changes.
64 changes: 20 additions & 44 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,44 +1,20 @@
name: Build and Check
on:
workflow_dispatch:
pull_request:
jobs:
build:
name: Build
uses: Logius-standaarden/Automatisering/.github/workflows/build.yml@main
check:
needs: build
name: Check
uses: Logius-standaarden/Automatisering/.github/workflows/check.yml@main

preview:
needs: build
name: Preview
runs-on: ubuntu-latest
if: ${{ github.event_name == 'pull_request' && !github.event.pull_request.head.repo.fork }}
steps:
- uses: actions/checkout@v2
- name: Recover HTML
uses: actions/cache@v2
with:
path: ~/static
key: ${{ github.run_id }}
- name: Gather files
run: |
rm index.html
mv ~/static/snapshot.html index.html
rm -f *.md *.pdf *.js snapshot.html
mkdir ~/content
mv ./* ~/content
git clone https://user:${{ secrets.BEHEER }}@github.com/Logius-standaarden/Publicatie-Preview.git
- name: Commit preview
run: |
cd Publicatie-Preview
rm -f -r ${{ github.event.repository.name }}/${{ github.head_ref }}
mkdir -p ${{ github.event.repository.name }}/${{ github.head_ref }}
mv ~/content/* ${{ github.event.repository.name }}/${{ github.head_ref }}
git add -A
git config user.name "GitHub Action"
git config user.email "[email protected]"
git commit -m "new preview build"
git push
name: Build and Check
on:
workflow_dispatch:
pull_request:
push:
branches:
- main
jobs:
build:
name: Build
uses: Logius-standaarden/Automatisering/.github/workflows/build.yml@main
check:
needs: build
name: Check
uses: Logius-standaarden/Automatisering/.github/workflows/check.yml@main
publish:
needs: build
name: Publish (Logius)
uses: Logius-standaarden/Automatisering/.github/workflows/publish.yml@main
secrets: inherit
Binary file modified OIN-Stelsel.pdf
Binary file not shown.
8 changes: 0 additions & 8 deletions ch01_Inleiding.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,6 @@

In dit document beschrijven we het doel en de werking van het OIN Stelsel. Het OIN is gestart als een noodzakelijk onderdeel van de Digikoppeling Standaard en is inmiddels een veel gebruikt identificatienummer binnen en maar ook buíten Digikoppeling. De regels van uitgifte en gebruik van het OIN staan beschreven in de *Voorwaarden Digikoppeling* en de *Gebruiksvoorwaarden Digikoppeling*. Daarnaast geeft Logius OINs en SubOINs uit en slaat de informatie hiervan op in het OIN register en ontsluit die met de *[=COR=]*, de Centrale OIN Raadpleegvoorziening. Dit geheel van regels en uitvoering noemen we het *OIN stelsel*.


Dit document is te raadplegen via:
- html (gepubliceerd): [https://publicatie.centrumvoorstandaarden.nl/dk/oin/](https://publicatie.centrumvoorstandaarden.nl/dk/oin/)
- html (werkversie): [https://Logius-standaarden.github.io/OIN-Stelsel](https://Logius-standaarden.github.io/OIN-Stelsel)
- html (snapshot): [https://Logius-standaarden.github.io/OIN-Stelsel/snapshot.html](https://Logius-standaarden.github.io/OIN-Stelsel/snapshot.html)
- pdf: [https://github.com/Logius-standaarden/OIN-Stelsel/blob/master/OIN-Stelsel.pdf](https://github.com/Logius-standaarden/OIN-Stelsel/blob/master/OIN-Stelsel.pdf)
- markdown (github): [https://github.com/Logius-standaarden/OIN-Stelsel](https://github.com/Logius-standaarden/OIN-Stelsel)

## Waarom dit document

De `Voorwaarden Digikoppeling` en de `Digikoppeling Gebruiksvoorwaarden` hebben een juridisch karakter en beantwoorden waarschijnlijk niet elke vraag van gebruikers van een OIN. In dit document proberen we daarom de werking van het OIN stelsel met al haar facetten nader te beschrijven in de hoop die vragen te beantwoorden.
Expand Down
15 changes: 9 additions & 6 deletions ch06_Data Architectuur.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,18 @@ De [=COR=] Website retourneert een relevante attributen van een OIN-registratie.

### [=COR=] API

Hieronder een voorbeeld van een REST-API call naar de [=COR=] API. In het voorbeeld wordt het OIN van de `Digilevering Integrator` opgevraagd, dit is een voorziening van Logius. Naast het OIN van de Digilevering Integrator, wordt ook een HAL referentie naar de SubOIN-Houder (in dit geval Logius) geretourneerd. Het valt op dat de [=COR=] API meer attributen vermeldt dan de [=COR=] website.
Hieronder een voorbeeld van een REST-API call naar de [=COR=] API. In het voorbeeld wordt het OIN van de `Digilevering Integrator` opgevraagd, dit is een voorziening van Logius. Naast het OIN van de Digilevering Integrator, wordt ook een HAL referentie naar de SubOIN-Houder (in dit geval Logius) geretourneerd. Het gebruik van de API staat verder beschreven op de [COR API website](https://portaal.digikoppeling.nl/registers/corApi/index).

Voorbeeldaanroep van de CORAPI
<aside class="example">
Voorbeeldaanroep van de COR API:

```HTTP
```
https://portaal.digikoppeling.nl/registers/api/v1/organisaties?naam=Digilevering Integrator
```

Voorbeeldresultaat van de CORAPI
</aside>

<aside class="example">
Voorbeeldresultaat van de COR API:

```JSON
{
Expand Down Expand Up @@ -128,4 +131,4 @@ Voorbeeldresultaat van de CORAPI
}]
}
```

</aside>
6 changes: 3 additions & 3 deletions ch09_Bijlage B - Nuttige links.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@

| Voorziening | url |
| ---- | --- |
| [=COR=] Web| [https://portaal.digikoppeling.nl/registers/](https://portaal.digikoppeling.nl/registers/)|
| [=COR=] API - handleiding| [https://portaal.digikoppeling.nl/registers/corApi/index](https://portaal.digikoppeling.nl/registers/corApi/index)|
| [=COR=] API - OpenAPI Specificatie| [https://portaal.digikoppeling.nl/registers/api/](https://portaal.digikoppeling.nl/registers/api/)|
| [=COR=] Web| https://oinregister.logius.nl/oin-register |
| [=COR=] API - handleiding| https://oinregister.logius.nl/documenten/api-documentatie |
| [=COR=] API - OpenAPI Specificatie| https://portaal.digikoppeling.nl/registers/api/ |
116 changes: 71 additions & 45 deletions index.html
Original file line number Diff line number Diff line change
@@ -1,48 +1,74 @@
<!DOCTYPE html>
<html lang="nl">

<head>
<meta content="text/html; charset=utf-8" http-equiv="content-type">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="shortcut icon" type="image/x-icon"
href="https://publicatie.centrumvoorstandaarden.nl/respec/style/logos/logius.ico" />
<title>OIN Stelsel</title>
<script src="js/config.js" class="remove"></script>
<!-- <script src="https://publicatie.centrumvoorstandaarden.nl/respec-tools/builds/respec-build.js" class="remove" async></script> -->
<script src="https://publicatie.centrumvoorstandaarden.nl/respec/builds/respec-logius.js" class="remove" async>
<head>
<meta content="text/html; charset=utf-8" http-equiv="content-type"/>
<meta content="width=device-width, initial-scale=1, shrink-to-fit=no" name="viewport"/>
<link href="https://gitdocumentatie.logius.nl/publicatie/respec/style/logos/logius.ico" rel="shortcut icon" type="image/x-icon"/>
<title>
OIN Stelsel
</title>
<script class="remove" src="https://gitdocumentatie.logius.nl/publicatie/respec/organisation-config.js">
</script>
<link rel="stylesheet" type="text/css" href="./media/style.css">
</head>

<body>
<section id='abstract' data-include-format="markdown" data-include="abstract.md"></section>
<section id='eerst' class="informative">
<aside class="note">
Voor dit gehele document geldt:<br><br>
De regels voor het gebruik van het OIN en SubOIN zijn beschreven in de volgende documenten:
<ul>
<li>[[Voorwaarden Digikoppeling]]</li>
<li>[[Gebruiksvoorwaarden Digikoppeling]]</li>
</ul>
Dit document is een <i>handreiking</i> en geeft een niet-normatieve beschrijving van de werking van het OIN stelsel.
</aside>
</section>
<section id='sotd'></section>


<section data-include-format="markdown" data-include="ch01_Inleiding.md"></section>
<section data-include-format="markdown" data-include="ch02_Architectuurvisie.md"></section>
<section data-include-format="markdown" data-include="ch03_Businessarchitectuur.md"></section>
<section data-include-format="markdown" data-include="ch04_Applicatie-architectuur.md"></section>
<section data-include-format="markdown" data-include="ch05_Het beheer van SubOINs in de [=COR=].md"></section>
<section data-include-format="markdown" data-include="ch06_Data Architectuur.md"></section>
<section data-include-format="markdown" data-include="ch07_Technologie-architectuur.md"></section>
<section data-include-format="markdown" data-include="ch08_Bijlage A - Begrippen.md"></section>
<section data-include-format="markdown" data-include="ch09_Bijlage B - Nuttige links.md"></section>
<section class="informative" data-include-format="markdown" data-include="OIN-SubOIN_in_PkioCert.md"></section>
<section id='conformance'></section>
<section id='tof'></section>
<section id="index"></section>
</body>

</html>
<script class="remove" src="js/config.js">
</script>
<script>
respecConfig = {...organisationConfig, ...respecConfig};
</script>
<script async="" class="remove" src="https://gitdocumentatie.logius.nl/publicatie/respec/builds/respec-nlgov.js">
</script>
<link href="./media/style.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<section data-include="abstract.md" data-include-format="markdown" id="abstract">
</section>
<section class="informative" id="eerst">
<aside class="note">
Voor dit gehele document geldt:
<br/>
<br/>
De regels voor het gebruik van het OIN en SubOIN zijn beschreven in de volgende documenten:
<ul>
<li>
[[Voorwaarden Digikoppeling]]
</li>
<li>
[[Gebruiksvoorwaarden Digikoppeling]]
</li>
</ul>
Dit document is een
<i>
handreiking
</i>
en geeft een niet-normatieve beschrijving van de werking van het OIN stelsel.
</aside>
</section>
<section id="sotd">
</section>
<section data-include="ch01_Inleiding.md" data-include-format="markdown">
</section>
<section data-include="ch02_Architectuurvisie.md" data-include-format="markdown">
</section>
<section data-include="ch03_Businessarchitectuur.md" data-include-format="markdown">
</section>
<section data-include="ch04_Applicatie-architectuur.md" data-include-format="markdown">
</section>
<section data-include="ch05_Het beheer van SubOINs in de [=COR=].md" data-include-format="markdown">
</section>
<section data-include="ch06_Data Architectuur.md" data-include-format="markdown">
</section>
<section data-include="ch07_Technologie-architectuur.md" data-include-format="markdown">
</section>
<section data-include="ch08_Bijlage A - Begrippen.md" data-include-format="markdown">
</section>
<section data-include="ch09_Bijlage B - Nuttige links.md" data-include-format="markdown">
</section>
<section class="informative" data-include="OIN-SubOIN_in_PkioCert.md" data-include-format="markdown">
</section>
<section id="conformance">
</section>
<section id="tof">
</section>
<section id="index">
</section>
</body>
</html>
Loading

0 comments on commit 6946968

Please sign in to comment.