Skip to content

Commit 0d8b7b5

Browse files
stevenbalstevenbal
authored
Merge pull request #73 from VNG-Realisatie/issue/dashboard-github
Issue/dashboard GitHub
2 parents e3d2fc2 + 78eb39a commit 0d8b7b5

File tree

7 files changed

+119
-9
lines changed

7 files changed

+119
-9
lines changed

‎README.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ API specificaties
1919

2020
|lint-oas| |generate-sdks| |generate-postman-collection|
2121

22-
========== ============== =============================
23-
Versie Release datum API specificatie
24-
========== ============== =============================
25-
1.0.x n.v.t. `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/stable/1.0.x/src/openapi.yaml>`_,
22+
========== ============== ==================================================================================================================================================================================================== ======================================================================================================================= =================================================================================================================================
23+
Versie Release datum API specificatie Autorisaties Notificaties
24+
========== ============== ==================================================================================================================================================================================================== ======================================================================================================================= =================================================================================================================================
25+
1.0.x n.v.t. `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/stable/1.0.x/src/openapi.yaml>`_, `Scopes <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/stable/1.0.x/src/autorisaties.md>`_ `Berichtkenmerken <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/stable/1.0.x/src/notificaties.md>`_
2626
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/stable/1.0.x/src/openapi.yaml>`_
2727
(`verschillen <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/compare/1.0.1..stable/1.0.x?diff=split#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
28-
1.0.1 2019-12-16 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/1.0.1/src/openapi.yaml>`_,
28+
1.0.1 2019-12-16 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/1.0.1/src/openapi.yaml>`_, `Scopes <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/1.0.1/src/autorisaties.md>`_ `Berichtkenmerken <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/1.0.1/src/notificaties.md>`_
2929
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/1.0.1/src/openapi.yaml>`_
3030
(`verschillen <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/compare/1.0.0..1.0.1?diff=split#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
31-
1.0.0 2019-11-18 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/1.0.0/src/openapi.yaml>`_,
31+
1.0.0 2019-11-18 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/1.0.0/src/openapi.yaml>`_, `Scopes <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/1.0.0/src/autorisaties.md>`_ `Berichtkenmerken <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/1.0.0/src/notificaties.md>`_
3232
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/1.0.0/src/openapi.yaml>`_
33-
========== ============== =============================
33+
========== ============== ==================================================================================================================================================================================================== ======================================================================================================================= =================================================================================================================================
3434

3535
Zie ook: `Alle versies en wijzigingen <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/master/CHANGELOG.rst>`_
3636

‎requirements/base.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ sqlparse==0.3.0 # via django
6161
unidecode==1.0.22 # via vng-api-common
6262
uritemplate==3.0.0 # via coreapi, drf-yasg
6363
urllib3==1.24.3 # via requests
64-
vng-api-common==1.0.34
64+
vng-api-common==1.0.53

‎requirements/jenkins.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,5 +75,5 @@ text-unidecode==1.2 # via faker
7575
unidecode==1.0.22
7676
uritemplate==3.0.0
7777
urllib3==1.24.3
78-
vng-api-common==1.0.34
78+
vng-api-common==1.0.53
7979
wrapt==1.10.11 # via astroid

‎src/autorisaties.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
2+
# Autorisaties
3+
## Scopes voor Besluiten API
4+
5+
Scopes worden typisch per component gedefinieerd en geven aan welke rechten er zijn.
6+
Zie de repository van de [Autorisaties API](https://github.com/VNG-Realisatie/autorisaties-api)
7+
8+
9+
### audittrails.lezen
10+
11+
**Scope**
12+
`audittrails.lezen`
13+
14+
15+
**Laat toe om**:
16+
17+
* audittrails op te lijsten
18+
* audittrail details op te vragen
19+
20+
21+
### besluiten.aanmaken
22+
23+
**Scope**
24+
`besluiten.aanmaken`
25+
26+
27+
**Laat toe om**:
28+
29+
* besluiten aan te maken
30+
31+
32+
### besluiten.bijwerken
33+
34+
**Scope**
35+
`besluiten.bijwerken`
36+
37+
38+
**Laat toe om**:
39+
40+
* attributen van een besluit te wijzingen
41+
42+
43+
### besluiten.lezen
44+
45+
**Scope**
46+
`besluiten.lezen`
47+
48+
49+
**Laat toe om**:
50+
51+
* besluiten te lezen
52+
* besluitdetails op te vragen
53+
54+
55+
### besluiten.verwijderen
56+
57+
**Scope**
58+
`besluiten.verwijderen`
59+
60+
61+
**Laat toe om**:
62+
63+
* besluiten te verwijderen
64+
65+

‎src/brc/conf/api.py

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import os
12
from vng_api_common.conf.api import * # noqa - imports white-listed
23

34
API_VERSION = "1.0.1"
@@ -41,3 +42,7 @@
4142
zrc_repo = "vng-Realisatie/gemma-zaakregistratiecomponent"
4243
zrc_commit = "8ea1950fe4ec2ad99504d345eba60a175eea3edf"
4344
ZRC_API_SPEC = f"https://raw.githubusercontent.com/{zrc_repo}/{zrc_commit}/src/openapi.yaml" # noqa
45+
46+
SELF_REPO = "VNG-Realisatie/gemma-besluitregistratiecomponent"
47+
SELF_BRANCH = os.getenv("SELF_BRANCH") or API_VERSION
48+
GITHUB_API_SPEC = f"https://raw.githubusercontent.com/{SELF_REPO}/{SELF_BRANCH}/src/openapi.yaml" # noqa

‎src/brc/utils/context_processors.py

+5
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ def settings(request):
88
"SHOW_ALERT",
99
"PROJECT_NAME",
1010
"SITE_TITLE",
11+
"API_VERSION",
12+
"GIT_SHA",
13+
"GITHUB_API_SPEC",
14+
"SELF_REPO",
15+
"SELF_BRANCH",
1116
)
1217

1318
return {

‎src/notificaties.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## Notificaties
2+
## Berichtkenmerken voor Besluiten API
3+
4+
Kanalen worden typisch per component gedefinieerd. Producers versturen berichten op bepaalde kanalen,
5+
consumers ontvangen deze. Consumers abonneren zich via een notificatiecomponent (zoals <a href="https://notificaties-api.vng.cloud/api/v1/schema/" rel="nofollow">https://notificaties-api.vng.cloud/api/v1/schema/</a>) op berichten.
6+
7+
Hieronder staan de kanalen beschreven die door deze component gebruikt worden, met de kenmerken bij elk bericht.
8+
9+
De architectuur van de notificaties staat beschreven op <a href="https://github.com/VNG-Realisatie/notificaties-api" rel="nofollow">https://github.com/VNG-Realisatie/notificaties-api</a>.
10+
11+
12+
### besluiten
13+
14+
**Kanaal**
15+
`besluiten`
16+
17+
**Main resource**
18+
19+
`besluit`
20+
21+
22+
23+
**Kenmerken**
24+
25+
* `verantwoordelijke_organisatie`: Het RSIN van de niet-natuurlijk persoon zijnde de organisatie die het besluit heeft vastgesteld.
26+
* `besluittype`: URL-referentie naar het BESLUITTYPE (in de Catalogi API).
27+
28+
**Resources en acties**
29+
30+
31+
* <code>besluit</code>: create, update, destroy
32+
33+
* <code>besluitinformatieobject</code>: create, destroy
34+
35+

0 commit comments

Comments
 (0)