Release versie 4.1.1+230512.44

Aedes-datastandaarden · May 12, 2023 · 10afbd3 · 10afbd3
1 parent ea56cfa
commit 10afbd3
Show file tree

Hide file tree

Showing 45 changed files with 19,666 additions and 14,593 deletions.
diff --git a/Informatiedomeinen/Algemeen.yaml b/Informatiedomeinen/Algemeen.yaml
@@ -9,7 +9,7 @@ info:
   license:
     name: "Copyright (c) Aedes vereniging van woningcorporaties"
     url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
-  version: '4.1.0+230422.8'
+  version: '4.1.1+230512.44'
 servers:
   - url: https://algemeen.vera.io:{port}/{basePath}
     description: Productieserver
@@ -31,7 +31,7 @@ tags:
 paths:
   /ping:
     get:
-      description: |
+      summary: |
         Een ping wordt beantwoord met response code 200
       operationId: ping
       responses:
@@ -47,7 +47,7 @@ paths:
     get:
       tags:
       - 'ExtraAttributen'
-      description: Ophalen van ExtraAttributen
+      summary: Ophalen van ExtraAttributen
       operationId: listExtraAttributen
       parameters:
       - name: params
@@ -97,7 +97,7 @@ paths:
     post:
       tags:
       - 'ExtraAttributen'
-      description: Voegt een nieuw(e) ExtraAttribuut toe.
+      summary: Voegt een nieuw(e) ExtraAttribuut toe.
       operationId: createExtraAttribuut
       parameters:
       - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -137,7 +137,7 @@ paths:
     put:
       tags:
       - 'ExtraAttributen'
-      description: |
+      summary: |
         Vervangen van een ExtraAttribuut op basis van overeenkomstige sleutelvelden.
       operationId: replaceExtraAttribuut
       parameters:
@@ -172,7 +172,7 @@ paths:
     patch:
       tags:
       - 'ExtraAttributen'
-      description: |
+      summary: |
         Wijzigen van afzonderlijke attributen van een ExtraAttribuut. In de meegestuurde entiteit moeten
         sleutelvelden aanwezig zijn.
       operationId: updateExtraAttribuut
@@ -209,7 +209,7 @@ paths:
     get:
       tags:
       - 'ExtraAttributen'
-      description: Retourneert een ExtraAttribuut met de gegeven identifier
+      summary: Retourneert een ExtraAttribuut met de gegeven identifier
       operationId: readExtraAttribuutById
       parameters:
       - name: id
@@ -246,7 +246,7 @@ paths:
     put:
       tags:
       - 'ExtraAttributen'
-      description: Vervangen van een ExtraAttribuut
+      summary: Vervangen van een ExtraAttribuut
       operationId: replaceExtraAttribuutById
       parameters:
       - name: 'id'
@@ -284,7 +284,7 @@ paths:
     patch:
       tags:
       - 'ExtraAttributen'
-      description: Wijzigen van een ExtraAttribuut
+      summary: Wijzigen van een ExtraAttribuut
       operationId: updateExtraAttribuutById
       parameters:
       - name: 'id'
@@ -323,7 +323,7 @@ paths:
     get:
       tags:
       - 'Referentiedata'
-      description: Ophalen van Referentiedata
+      summary: Ophalen van Referentiedata
       operationId: listReferentiedata
       parameters:
       - name: params
@@ -373,7 +373,7 @@ paths:
     post:
       tags:
       - 'Referentiedata'
-      description: Voegt een nieuw(e) Referentiedata toe.
+      summary: Voegt een nieuw(e) Referentiedata toe.
       operationId: createReferentiedata
       parameters:
       - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -413,7 +413,7 @@ paths:
     put:
       tags:
       - 'Referentiedata'
-      description: |
+      summary: |
         Vervangen van een Referentiedata op basis van overeenkomstige sleutelvelden.
       operationId: replaceReferentiedata
       parameters:
@@ -448,7 +448,7 @@ paths:
     patch:
       tags:
       - 'Referentiedata'
-      description: |
+      summary: |
         Wijzigen van afzonderlijke attributen van een Referentiedata. In de meegestuurde entiteit moeten
         sleutelvelden aanwezig zijn.
       operationId: updateReferentiedata
@@ -485,7 +485,7 @@ paths:
     get:
       tags:
       - 'Referentiedata'
-      description: Retourneert een Referentiedata met de gegeven identifier
+      summary: Retourneert een Referentiedata met de gegeven identifier
       operationId: readReferentiedataById
       parameters:
       - name: id
@@ -522,7 +522,7 @@ paths:
     put:
       tags:
       - 'Referentiedata'
-      description: Vervangen van een Referentiedata
+      summary: Vervangen van een Referentiedata
       operationId: replaceReferentiedataById
       parameters:
       - name: 'id'
@@ -560,7 +560,7 @@ paths:
     patch:
       tags:
       - 'Referentiedata'
-      description: Wijzigen van een Referentiedata
+      summary: Wijzigen van een Referentiedata
       operationId: updateReferentiedataById
       parameters:
       - name: 'id'
@@ -599,7 +599,7 @@ paths:
     get:
       tags:
       - 'Sturingslabels'
-      description: Ophalen van Sturingslabels
+      summary: Ophalen van Sturingslabels
       operationId: listSturingslabels
       parameters:
       - name: params
@@ -649,7 +649,7 @@ paths:
     post:
       tags:
       - 'Sturingslabels'
-      description: Voegt een nieuw(e) Sturingslabel toe.
+      summary: Voegt een nieuw(e) Sturingslabel toe.
       operationId: createSturingslabel
       parameters:
       - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -689,7 +689,7 @@ paths:
     put:
       tags:
       - 'Sturingslabels'
-      description: |
+      summary: |
         Vervangen van een Sturingslabel op basis van overeenkomstige sleutelvelden.
       operationId: replaceSturingslabel
       parameters:
@@ -724,7 +724,7 @@ paths:
     patch:
       tags:
       - 'Sturingslabels'
-      description: |
+      summary: |
         Wijzigen van afzonderlijke attributen van een Sturingslabel. In de meegestuurde entiteit moeten
         sleutelvelden aanwezig zijn.
       operationId: updateSturingslabel
@@ -761,7 +761,7 @@ paths:
     get:
       tags:
       - 'Sturingslabels'
-      description: Retourneert een Sturingslabel met de gegeven identifier
+      summary: Retourneert een Sturingslabel met de gegeven identifier
       operationId: readSturingslabelById
       parameters:
       - name: id
@@ -798,7 +798,7 @@ paths:
     put:
       tags:
       - 'Sturingslabels'
-      description: Vervangen van een Sturingslabel
+      summary: Vervangen van een Sturingslabel
       operationId: replaceSturingslabelById
       parameters:
       - name: 'id'
@@ -836,7 +836,7 @@ paths:
     patch:
       tags:
       - 'Sturingslabels'
-      description: Wijzigen van een Sturingslabel
+      summary: Wijzigen van een Sturingslabel
       operationId: updateSturingslabelById
       parameters:
       - name: 'id'
@@ -908,10 +908,22 @@ components:
       name: X-API-KEY
     OAuth2:
       type: oauth2
-      description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+      description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
       flows:
-        implicit:
-          authorizationUrl: https://api.vera.nl/oauth2/authorize
+        authorizationCode:
+          authorizationUrl: /oauth/authorize
+          tokenUrl: /oauth/token
+          scopes:
+            Algemeen.All.Read: alleen lezen van alle resources
+            Algemeen.All.ReadWrite: lezen en schrijven van alle resources
+            Algemeen.ExtraAttributen.Read: alleen lezen van ExtraAttributen
+            Algemeen.ExtraAttributen.ReadWrite: lezen en schrijven van ExtraAttributen
+            Algemeen.Referentiedata.Read: alleen lezen van Referentiedata
+            Algemeen.Referentiedata.ReadWrite: lezen en schrijven van Referentiedata
+            Algemeen.Sturingslabels.Read: alleen lezen van Sturingslabels
+            Algemeen.Sturingslabels.ReadWrite: lezen en schrijven van Sturingslabels
+        clientCredentials:
+          tokenUrl: /oauth/token
           scopes:
             Algemeen.All.Read: alleen lezen van alle resources
             Algemeen.All.ReadWrite: lezen en schrijven van alle resources
@@ -970,7 +982,7 @@ components:
         soort:
           allOf:
           - $ref: '#/components/schemas/Referentiedata-sleutels'
-          description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+          description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
         naam:
           type: string
           format: any
@@ -982,7 +994,7 @@ components:
         parent:
           allOf:
           - $ref: '#/components/schemas/Referentiedata-sleutels'
-          description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+          description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
         begindatum:
           type: string
           format: date