Merge pull request #73 from VNG-Realisatie/issue/dashboard-github

Issue/dashboard GitHub
VNG-Realisatie · Dec 11, 2020 · 0d8b7b5 · 0d8b7b5
2 parents e3d2fc2 + 78eb39a
commit 0d8b7b5
Show file tree

Hide file tree

Showing 7 changed files with 119 additions and 9 deletions.
diff --git a/README.rst b/README.rst
@@ -19,18 +19,18 @@ API specificaties
 
 |lint-oas| |generate-sdks| |generate-postman-collection|
 
-==========  ==============  =============================
-Versie      Release datum   API specificatie
-==========  ==============  =============================
-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>`_,
+==========  ==============  ====================================================================================================================================================================================================  =======================================================================================================================  =================================================================================================================================
+Versie      Release datum   API specificatie                                                                                                                                                                                      Autorisaties                                                                                                             Notificaties
+==========  ==============  ====================================================================================================================================================================================================  =======================================================================================================================  =================================================================================================================================
+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>`_
                             `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/stable/1.0.x/src/openapi.yaml>`_
                             (`verschillen <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/compare/1.0.1..stable/1.0.x?diff=split#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
-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>`_,
+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>`_
                             `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/1.0.1/src/openapi.yaml>`_
                             (`verschillen <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/compare/1.0.0..1.0.1?diff=split#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
-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>`_,
+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>`_
                             `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/1.0.0/src/openapi.yaml>`_
-==========  ==============  =============================
+==========  ==============  ====================================================================================================================================================================================================  =======================================================================================================================  =================================================================================================================================
 
 Zie ook: `Alle versies en wijzigingen <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/master/CHANGELOG.rst>`_
 

diff --git a/requirements/base.txt b/requirements/base.txt
@@ -61,4 +61,4 @@ sqlparse==0.3.0           # via django
 unidecode==1.0.22         # via vng-api-common
 uritemplate==3.0.0        # via coreapi, drf-yasg
 urllib3==1.24.3           # via requests
-vng-api-common==1.0.34
+vng-api-common==1.0.53
diff --git a/requirements/jenkins.txt b/requirements/jenkins.txt
@@ -75,5 +75,5 @@ text-unidecode==1.2       # via faker
 unidecode==1.0.22
 uritemplate==3.0.0
 urllib3==1.24.3
-vng-api-common==1.0.34
+vng-api-common==1.0.53
 wrapt==1.10.11            # via astroid
diff --git a/src/autorisaties.md b/src/autorisaties.md
@@ -0,0 +1,65 @@
+
+# Autorisaties
+## Scopes voor Besluiten API
+
+Scopes worden typisch per component gedefinieerd en geven aan welke rechten er zijn.
+Zie de repository van de [Autorisaties API](https://github.com/VNG-Realisatie/autorisaties-api)
+
+
+### audittrails.lezen
+
+**Scope**
+`audittrails.lezen`
+
+
+**Laat toe om**:
+
+* audittrails op te lijsten
+* audittrail details op te vragen
+
+
+### besluiten.aanmaken
+
+**Scope**
+`besluiten.aanmaken`
+
+
+**Laat toe om**:
+
+* besluiten aan te maken
+
+
+### besluiten.bijwerken
+
+**Scope**
+`besluiten.bijwerken`
+
+
+**Laat toe om**:
+
+* attributen van een besluit te wijzingen
+
+
+### besluiten.lezen
+
+**Scope**
+`besluiten.lezen`
+
+
+**Laat toe om**:
+
+* besluiten te lezen
+* besluitdetails op te vragen
+
+
+### besluiten.verwijderen
+
+**Scope**
+`besluiten.verwijderen`
+
+
+**Laat toe om**:
+
+* besluiten te verwijderen
+
+
diff --git a/src/brc/conf/api.py b/src/brc/conf/api.py
@@ -1,3 +1,4 @@
+import os
 from vng_api_common.conf.api import *  # noqa - imports white-listed
 
 API_VERSION = "1.0.1"
@@ -41,3 +42,7 @@
 zrc_repo = "vng-Realisatie/gemma-zaakregistratiecomponent"
 zrc_commit = "8ea1950fe4ec2ad99504d345eba60a175eea3edf"
 ZRC_API_SPEC = f"https://raw.githubusercontent.com/{zrc_repo}/{zrc_commit}/src/openapi.yaml"  # noqa
+
+SELF_REPO = "VNG-Realisatie/gemma-besluitregistratiecomponent"
+SELF_BRANCH = os.getenv("SELF_BRANCH") or API_VERSION
+GITHUB_API_SPEC = f"https://raw.githubusercontent.com/{SELF_REPO}/{SELF_BRANCH}/src/openapi.yaml"  # noqa
diff --git a/src/brc/utils/context_processors.py b/src/brc/utils/context_processors.py
@@ -8,6 +8,11 @@ def settings(request):
         "SHOW_ALERT",
         "PROJECT_NAME",
         "SITE_TITLE",
+        "API_VERSION",
+        "GIT_SHA",
+        "GITHUB_API_SPEC",
+        "SELF_REPO",
+        "SELF_BRANCH",
     )
 
     return {

diff --git a/src/notificaties.md b/src/notificaties.md
@@ -0,0 +1,35 @@
+## Notificaties
+## Berichtkenmerken voor Besluiten API
+
+Kanalen worden typisch per component gedefinieerd. Producers versturen berichten op bepaalde kanalen,
+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.
+
+Hieronder staan de kanalen beschreven die door deze component gebruikt worden, met de kenmerken bij elk bericht.
+
+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>.
+
+
+### besluiten
+
+**Kanaal**
+`besluiten`
+
+**Main resource**
+
+`besluit`
+
+
+
+**Kenmerken**
+
+* `verantwoordelijke_organisatie`: Het RSIN van de niet-natuurlijk persoon zijnde de organisatie die het besluit heeft vastgesteld.
+* `besluittype`: URL-referentie naar het BESLUITTYPE (in de Catalogi API).
+
+**Resources en acties**
+
+
+* <code>besluit</code>: create, update, destroy
+
+* <code>besluitinformatieobject</code>: create, destroy
+
+