Production release to version v1.5.0 (#272)

* removed: unmutable put/patch validation on zaaktype

* removed: unit test unmutable put/patch validation on zaaktype

* Adds cicd pipeline with develop branch (#269)

* Issue/#2192 inclusions (#267)

**Enhancements, Bug Fixes, and Code Refactoring**

- **Added:** Extension of list call functionality to accept expand parameters for enriched data retrieval.
- **Added:** Introduction of 'ExpandField' class to manage and process expand parameters.
- **Added:** 'Inclusion' class to facilitate data inclusion and enhance response customization.
- **Added:** Method for building inclusion schemas.
- **Added:** Recursion logic in later stages to support nested data inclusion.
- **Added:** 'Inclusions' class for streamlined management of included external API calls.
- **Added:** External API calls within the 'Inclusions' class for comprehensive data integration.
- **Added:** Clear and descriptive text to the expand filter for better understanding.
- **Added:** Validation mechanism and resolved issues with external API calls within 'Inclusions'.
- **Added:** Regex validator to enhance input validation.
- **Added:** Explanation regarding the use of regex validation.
- **Added:** Support for nested dictionary types like 'relevante_andere_zaken' in the expansions model.
- **Added:** Integration of the 'expand' feature into the OpenAPI Specification (OAS) and expanded GET detail endpoints.
- **Changed:** Hard-coded mappings from 'expensions.py' for increased flexibility.
- **Changed:** Relocated 'routers' import into a function to address circular import concerns.
- **Changed:** Reworked the expansions model to resolve previous errors and improve reliability.
- **Changed:** Various issues related to specific problem reports: #2280, #2279, #2269, #2270, #2271,  #2288, #2287.
- **Changed:** Updated OAS description and resolved a bug in the expansions.
- **Updated:** Requirements files, including 'psyopg2' for proper functionality.

These changes encompass a wide range of enhancements, bug fixes, and code clean-up, significantly improving the functionality, stability, and maintainability of the system. The introduction of expand parameters, 'ExpandField' class, 'Expand' class, and various bug fixes contribute to a more robust and efficient system.

* Production release to version v1.5.0 (#271)

---------

Co-authored-by: matthijsbekendam <[email protected]>
Co-authored-by: MatthijsBekendam <[email protected]>

.bumpversion.cfg

@@ -1,7 +1,7 @@
 [bumpversion]
 commit = False
 tag = False
-current_version = 1.4.0
+current_version = 1.5.0
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)([-](?P<release>(rc|alpha))+(?P<build>\d+))?
 serialize =
 	{major}.{minor}.{patch}-{release}{build}

.github/workflows/ci.yml

@@ -4,8 +4,10 @@ on:
   push:
     branches:
       - "stable/*"
+      - "develop"
   pull_request:
     branches:
+      - "develop"
       - "master"
 
 env:

CHANGELOG.rst

@@ -1,7 +1,41 @@
 ===========
 Wijzigingen
 ===========
-1.4.0 (2022-03-27)
+1.5.0 (2023-08-22)
+===========
+
+Implementation changes
+----------------------
+
+`Issue 2192`_:
+
+**Enhancements, Bug Fixes, and Code Refactoring**
+
+- **Added:** Extension of list call functionality to accept expand parameters for enriched data retrieval.
+- **Added:** Introduction of 'ExpandField' class to manage and process expand parameters.
+- **Added:** 'Inclusion' class to facilitate data inclusion and enhance response customization.
+- **Added:** Method for building inclusion schemas.
+- **Added:** Recursion logic in later stages to support nested data inclusion.
+- **Added:** 'Inclusions' class for streamlined management of included external API calls.
+- **Added:** External API calls within the 'Inclusions' class for comprehensive data integration.
+- **Added:** Clear and descriptive text to the expand filter for better understanding.
+- **Added:** Validation mechanism and resolved issues with external API calls within 'Inclusions'.
+- **Added:** Regex validator to enhance input validation.
+- **Added:** Explanation regarding the use of regex validation.
+- **Added:** Support for nested dictionary types like 'relevante_andere_zaken' in the expansions model.
+- **Added:** Integration of the 'expand' feature into the OpenAPI Specification (OAS) and expanded GET detail endpoints.
+- **Changed:** Hard-coded mappings from 'expensions.py' for increased flexibility.
+- **Changed:** Relocated 'routers' import into a function to address circular import concerns.
+- **Changed:** Reworked the expansions model to resolve previous errors and improve reliability.
+- **Changed:** Various issues related to specific problem reports: #2280, #2279, #2269, #2270, #2271,  #2288, #2287.
+- **Changed:** Updated OAS description and resolved a bug in the expansions.
+- **Updated:** Requirements files, including 'psyopg2' for proper functionality.
+
+These changes encompass a wide range of enhancements, bug fixes, and code clean-up, significantly improving the functionality, stability, and maintainability of the system. The introduction of expand parameters, 'ExpandField' class, 'Expand' class, and various bug fixes contribute to a more robust and efficient system.
+
+.. _Issue 2192: https://github.com/VNG-Realisatie/gemma-zaken/issues/2192
+
+1.4.0 (2023-03-27)
 ===========
 
 Implementation changes

INSTALL.rst

@@ -1,4 +1,4 @@
-============
+pip============
 Installation
 ============
 

README.rst

@@ -2,7 +2,7 @@
 Zaken API
 =========
 
-:Version: 1.4.0
+:Version: 1.5.0
 :Source: https://github.com/VNG-Realisatie/zaken-api
 :Keywords: zaken, zaakgericht werken, GEMMA, RGBZ, ZRC
 
@@ -16,14 +16,14 @@ zaken moeten ergens geregistreerd worden en opvraagbaar zijn.
 API specificaties
 =================
 
-|lint-oas| |generate-sdks| |generate-postman-collection|
-
 ==========  ==============  ====================================================================================================================================================================================================  =======================================================================================================================  =================================================================================================================================
 Versie      Release datum   API specificatie                                                                                                                                                                                      Autorisaties                                                                                                             Notificaties
 ==========  ==============  ====================================================================================================================================================================================================  =======================================================================================================================  =================================================================================================================================
 master      n.v.t.          `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/zaken-api/master/src/openapi.yaml>`_,                                                                   `Scopes <https://github.com/VNG-Realisatie/zaken-api/blob/master/src/autorisaties.md>`_                                  `Berichtkenmerken <https://github.com/VNG-Realisatie/zaken-api/blob/master/src/notificaties.md>`_
                             `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/zaken-api/master/src/openapi.yaml>`_
                             (`verschillen <https://github.com/VNG-Realisatie/zaken-api/compare/1.4.0..master?diff=split#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
+1.5.0       2023-08-22      `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/zaken-api/1.5.0/src/openapi.yaml>`_,                                                                    `Scopes <https://github.com/VNG-Realisatie/zaken-api/blob/1.5.0/src/autorisaties.md>`_                                   `Berichtkenmerken <https://github.com/VNG-Realisatie/zaken-api/blob/1.5.0/src/notificaties.md>`_
+                            `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/zaken-api/1.5.0/src/openapi.yaml>`_
 1.4.0       2023-03-27      `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/zaken-api/1.4.0/src/openapi.yaml>`_,                                                                    `Scopes <https://github.com/VNG-Realisatie/zaken-api/blob/1.4.0/src/autorisaties.md>`_                                   `Berichtkenmerken <https://github.com/VNG-Realisatie/zaken-api/blob/1.4.0/src/notificaties.md>`_
                             `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/zaken-api/1.4.0/src/openapi.yaml>`_
                             (`verschillen <https://github.com/VNG-Realisatie/zaken-api/compare/1.4.0..1.3.2?diff=split#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "zrc",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "zrc referentie implementatie API",
   "directories": {
     "doc": "doc"