add doc about wrappers and branching model

BRANCHING-MODEL.MD

@@ -0,0 +1,29 @@
+# Introduction
+This section describes
+- how branches are handled
+- defectdojo release cycle
+
+Please be careful to submit your pull requests to the correct branch: 
+- bugfix: latest release branch
+- evolutions: dev branch
+
+If in doubt please use dev branch.
+
+# Release model
+![Release model](doc/branching_model_releasing.png)
+
+- Start a release x.x.x branch off dev branch
+- Commit only bug fixes on this branch (and merge those fixes back to dev)
+- Dev keeps living with further evolutions
+- Every 4-8 weeks, merge the release branch to master and tag: this is when the new release is out.
+
+# Hotfix model
+![Release model](doc/branching_model_hotfix.png)
+
+
+- In case of major issue found after releasing, issue a hotfix branch which is merged to master, dev, and the next release branch
+
+
+(Schemes created with draw.io)
+
+(This model is inspired by https://nvie.com/posts/a-successful-git-branching-model/ but without feature branches.)

README.md

@@ -56,13 +56,15 @@ We've also created some example
 [workflows](https://defectdojo.readthedocs.io/en/latest/workflows.html) that
 should give you an idea of how to use DefectDojo for your own team.
 
-## Client APIs
+## Client APIs and wrappers
+This section presents different ways to programmatically interact with defectdojo APIs.
+
+See [Wrappers](WRAPPERS.MD)
+
+
+## Release and branch model
+See [Release and branch model](BRANCHING-MODEL.MD)
 
-* Install the DefectDojo Python API via `pip install defectdojo_api` or clone
-  the [repository](https://github.com/aaronweaver/defectdojo_api).
-* Browse the API on
-  [SwaggerHub](https://app.swaggerhub.com/apis/DefectDojo/defect-dojo_api_v_2/1.0.0).
-  [![Swagger Status](http://online.swagger.io/validator?url=https://api.swaggerhub.com/apis/DefectDojo/defect-dojo_api_v_2/1.0.0)](https://app.swaggerhub.com/apis/DefectDojo/defect-dojo_api_v_2/1.0.0)
 
 ## Getting Involved
 

WRAPPERS.MD

@@ -0,0 +1,23 @@
+| Wrapper                     | APIV1  | APIV2  | Notes                   |
+| ----------------------------| -------|   ---- | ------------------------|
+| Specific python wrapper     | Yes    | Yes    | Python 2 only           |
+| Openapi python wrapper      | No     | Yes    |                         |
+| Bash wrapper                | No     | Yes    |                         |
+| Java wrapper                | No     | Yes    |                         |
+
+### Specific python wrapper
+* Install the DefectDojo Python API via `pip install defectdojo_api` or clone
+  the [repository](https://github.com/DefectDojo/defectdojo_api).
+* Browse the API on
+  [SwaggerHub](https://app.swaggerhub.com/apis/DefectDojo/defect-dojo_api_v_2/1.0.0).
+  [![Swagger Status](http://online.swagger.io/validator?url=https://api.swaggerhub.com/apis/DefectDojo/defect-dojo_api_v_2/1.0.0)](https://app.swaggerhub.com/apis/DefectDojo/defect-dojo_api_v_2/1.0.0)
+
+### Openapi python wrapper
+https://github.com/alles-klar/defectdojo-api-v2-client
+
+### Bash wrapper
+https://github.com/wurstbrot/defectdojo-client
+
+### Java wrapper
+
+https://github.com/DefectDojo/defectdojo-java-client

doc/branching_model_hotfix.xml

@@ -0,0 +1 @@
+<mxfile host="www.draw.io" modified="2020-03-07T23:33:49.555Z" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/65.0.3325.181 Chrome/65.0.3325.181 Safari/537.36" etag="JoiKrJ5v2sL0ERLouTOz" version="12.8.1" type="device"><diagram name="Page-1" id="9361dd3d-8414-5efd-6122-117bd74ce7a7">7VrLcqM4FP0alnEBQmAvg530LKaretqLSVZTCsg2FYwoIcd2f/0IEC+JuOkYW3F1ZxPrgYSOzj33XgkDzLeHLxSlm68kxLFhm+HBAAvDti3HNvm/vOZY1ngWKCvWNApFp6ZiGf3AolI8t95FIc46HRkhMYvSbmVAkgQHrFOHKCX7brcVibuzpmgtZjSbimWA4uo9JrCp/zcK2aasn9puU/8Xjtabam7LnZUtLyh4XVOyS8SMhg1WxV/ZvEXVWGLmbINCsm9VgQcDzCkhrPy1PcxxnKNbAVc+9/hOa71AihM25AGnfOANxTux+AV+y9dBURJsxDuyY4VM/bqWAfxVFMdzEhNatIF7e+7MZ7w+Y5S84qolIQlW30q86BumDB9aVeItv2CyxYweeZeqFdrVrghWuQLCfbNBlim6bFqbA0U/JFixrsducOE/BDT9MHkKTNbEmvCBTYpjjDL8GSGzZz8HzLoQYHlXCbEtyhimnxEoaJramOWYClDfObMKbjG0NnLJAVwYgd8HWIoLFBj/56M4Wie8GOMVy5EqZRXY9aPnYTTtYmQ5fSCZKkjOCCAt7X8evpkPr//Z/tMc7/+mOEvv6i1pQadghJPwPvcIFVmAH6Jsg0NBsw3bxuInh4Yen3jB5Dojis/ttkWOhFmXjqJUTonDyqX0SHDlwxBd4wqVfrBbYMIeLKs6LjqIRW/dGfsAFjN8IxF/l0YYzK4wQFvao4zsaIDFU23vIQ0EZxIpZtJA5ZKVgYr9rpd9DgVmt0WBEthTK/JsncwA0ByHGfJAlnVlZliqrt44M6CrkxlQjb9kZR+sGtDWyw1HjXpzl2vlyBG2ig59rvbjsYniZHsI8K7f9QbEJpcK4t5B78bc7gDLgjoty4OebFny5g21LD5U17Jk+b60ZUF3ADfimCfyOSf2m4jhZYqK3dlTlHapgbK0zO65RebU8UcwJ+jIMmZ5qkXZPbstQzmeQUE1u7xxg3IFDdoR7x+ndmHTmyosWmJuK8XRxI4nkmbh2MxWRrkieTqeUhLuAhaRRGFdcZBVk2xFErYUjT1+8PFxMeMbfyk/KOWf/Y6wjyrwYnY7xBHqFDvPkT2L3ZO1X1nsbixjGyBhmqOHaWeHP5yxaY8dXPuXmBHEKMuiQOLDIWItOvDSc6ulIUNeOLaZ8dQuPHc4c634cwjX9J4OeK6kwd4HuSafDgDz2lwDCtd8FLymhDKFc1x/maTV4qQ14FuNuY/zc5WOAhTfi4ZtFIb54z6fLfqBXoqhctak+YqKNULfgAteE6MXHPv1rVHLn4p7oxOeQNx/ifGN1nVWQ8JTtvau47gzJ9yZdrbozhmFQnfW1JkAe9b8TSUmTKxpd1CyWmX4QjRQDwI+LDnWYMEZVTqGR9pa3ZQrnRQD+aR4sJuSNci9tnT8WrZ22k21ONO4rHNZ83MuuFqzLmULP3rcAXW7EU897viK+ZS/hw/xTvoQLuRg6nQ3+jz6XMMhqNnJ9+poeOTb2POOsVz54KIOqfTdx1bR4FnKWAXjdWHcYHxAiK31anY0baw/ptKmjZbCht8qxPbMfh5dPsS2p3AC3FaILSmFe80Q2xuS1es8JAPKjQAAug/JPDU9PaWkN3BI9uezhpHMaUjGqtOcLFlttBuTe3t3kvpB827skv+z57wQgnEUSL2yHO+jO15svjwvuzcf+IOH/wE=</diagram></mxfile>

doc/branching_model_releasing.xml

@@ -0,0 +1 @@
+<mxfile host="www.draw.io" modified="2020-03-07T23:16:27.704Z" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/65.0.3325.181 Chrome/65.0.3325.181 Safari/537.36" etag="C3uKTkN0XbeQs7f3M_up" version="12.8.1" type="device"><diagram name="Page-1" id="9361dd3d-8414-5efd-6122-117bd74ce7a7">7Vxbd6o4FP41PJYFSUB5rNqeeZgz68z4MD1Ps1KIyioaF8Sq59dPkEQgQUutXGyPL8oO5PLt+07QgOPl7luM14vvNCCRAaxgZ8CJAYCNgMW/Uso+owxsmBHmcRiIm3LCNPxFBFE8N9+EAUlKNzJKIxauy0SfrlbEZyUajmO6Ld82o1F51DWeixGtnDD1cSTnYTo5/d8wYIuMPgRuTv+DhPOFHNt2vazlGfsv85huVmJEA8DZ4ZM1L7HsS4ycLHBAtwUSfDDgOKaUZb+WuzGJUnQlcNlzjydajwuMyYrVeQBlD7ziaCMWPyGv6TpivPIXYo5sL5E5Ttc24GgWRtGYRjQ+tMF7MEZjj9MTFtMXIltWdEX0WYmJvpKYkV2BJGb5jdAlYfGe3yJbHSC5IqTKFRBucwbZlrhlUWCOI+7DQirmx75zXPgPAU01TAMNJtu0TN6xFZOI4IT0ETLgvQ2Y3RBg6a0KYkucMBL3EShXGp4OJAtZGlB/kW1BsOC9MQbGPb+NGx/IZwpHd7z5HymADM+VpglZR3R/MJqpEab+ywH2xea5CvM1OQDJ+NcIR+F8xS8jMmNXwHVglXFFqAJYSVuU7Ok1dFYXwYdXGm1YSFeJhsTBZpNAih9dsalorBDHx8eJ57pNiaNXRg24jobacGBWyCO8AmpT8PfDD+vh5T8wehqT7Z8xSdZ3nu4mRpt56lrDHWkaSw24CnhPYgndMpgQ6iLYMphHU1JAU4OQrIL7NJKRSMBRgJPFEdMFW0biJwci3j/xC4uvQlz+LLZNUiis49VeXGVDkkCGQqeg5dOim9gn51ZkyygNx3PCCpGFzpcC7k6F5ksat36Yha/luVWxQozwg4Z81rnrs8quD1kKN7M1iaeK8ZHSkaMoo+0pHWVL1jo6SMZx2R8RFu/TCcugS8mAjnUdyVA70nxW05Jh65FDjyWjK367LiqxyUUX8tt1oZKAtM9xuwbHo4inySmnt4uQkekaH7RxyzP1MsNxss5y59SHB0dOfsjb2krGYTu6twUVvAaN+VpbDwJ7rCS1zCfSfe05cbl5F6x21L7avS9e8yOcJKGvSM4uZE+F3z9zIeJXudikF81FaN3JwkC1ne6lbhcp2VHr0qAHZFM+JjNq1IK4ZWWKFRYZt89ZyrN0OErtb+jj6F40LMMgSB8f8dHDX/j50FUqHet0hYc1OyPDmXBKhJ9JNDoWIAs5lihBnrHxopQq+jcKldFc2M5px0mXcGeZQPotwbI7dBWhsgcmGJYforNZQhpiu14C7Jfv1RTDQubQ7tr9Dj+b+5VY1XC/v/Ocq2geqJPn9ErzPL1g167agTqJwk2pHawd9Ra20Xqgdo6qLZeqHddgc2h5+cdpVwtl2tFbLVRzT1Cx2dCyFtaB7La00K3t/D5H+VfLPQdtO786YWfN3FMmmG3nnt1aZN7ReRbWlgVllxiq27+Ny4IeTKfZ3prGTJOJz5hpghMBdeOZJjB5iFf42G5pFNeUVcYW8lBQZz+oT34Ydl4DhnUSiJvyw2hQ1w9n4tIXP+you6eX+mGglg+btr0Q3JIM9SX7uVrRQeuocX73Pd1Riw5HhLozszd2rOVt4wk7TWJUHbh451rtCNot1w5k2thbZdJqB51X8OD78r7OlalGFujVVju3S7VTQw0tzbudmOV9my+t1w46M6xIqQ5dWqMFttKR07Zh1ZPBL1URyCT8i1cEKt4g6Ld3RZ1XBND7srlKy9h7K+dcycq5yhF6bUuraSuHoMat74QP+SVMXCaqX93E6dm4bdotvH/3IbuHFMVp8/27EzjeVIreleV05BG/jybejj3s+sg46nvq7Wrv9TqdV7JQ38/6qRGVU/FWW8uQ3dhBv7erEKjT43tq8eBiG6SVM9o+wYDe9wJb66fnO+OwcpzAudzLKGFG2z5GAvL7RHxR4jsI2ds9Ee/0/W00R3vrxG0utOCX+b+2ZBjnf44DH/4H</diagram></mxfile>