documentation (#53)

Author: fopina

.openapi-generator-ignore

@@ -21,4 +21,4 @@
 #docs/*.md
 # Then explicitly reverse the ignore rule for a single file:
 #!docs/README.md
-*README.md
+README.md

.openapi-generator/FILES

@@ -10,25 +10,65 @@
 
 Python library to interact with DefectDojo - generated from OpenAPI definition using https://openapi-generator.tech/
 
-## Install
+Multiple changes done on top of default openapi-generator:
+* A friendlier Client class
+* Tweak validations to reduce package import time to about 1/3
+* Remove most of pydantic/schema validations due to inconsistencies with actual database schema/requirements (tracked in https://github.com/fopina/defectdojo-api-generated/issues/39)
+* A nice CLI exposing all the API methods <3
+  * installed only as an extra, to keep everything clean when package is used as library only
+
+## Example
+
+### Library
 
 ```
 pip install defectojo-api-generated
 ```
 
-## Usage
-
 ```python
 from defectdojo_api_generated import DefectDojo
 
 # password publicly available in https://github.com/DefectDojo/django-DefectDojo/?tab=readme-ov-file#demo
-# then get API token from https://demo.defectdojo.org/api/key-v2
-dojo = DefectDojo('https://demo.defectdojo.org/', token=...)
+dojo = DefectDojo('https://demo.defectdojo.org/', username='admin', password='...')
 r = dojo.findings_api.list()
 print(r.json())
 ```
 
-## Build
+#### **Full documentation** [in docs](docs/README.md)
+
+### CLI
+
+[![asciicast](https://asciinema.org/a/fIPDy8iYxGL85pXb.svg)](https://asciinema.org/a/fIPDy8iYxGL85pXb)
+
+> [uv](https://docs.astral.sh/uv/) recommended or [pipx](https://github.com/pypa/pipx)
+
+```
+uv tool install 'defectojo-api-generated[cli]'
+```
+
+```
+$ dojo 
+Usage: dojo [OPTIONS] COMMAND [ARGS]...
+
+  DefectDojo CLI
+
+Options:
+  ...
+Commands:
+  api     Interact directly with any API/method
+  config  Show or edit the current CLI configuration
+  status  Quick connectivity check
+```
+
+You can also skip tool install and just run it with:
+
+```
+$ uvx 'defectojo-api-generated[cli]'
+Usage: dojo [OPTIONS] COMMAND [ARGS]...
+...
+```
+
+## Contributing
 
 Check out [CONTRIBUTING.md](CONTRIBUTING.md)
 

README.md

@@ -0,0 +1,31 @@
+# AcceptedRiskRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**vulnerability_id** | **str** | An id of a vulnerability in a security advisory associated with this finding. Can be a Common Vulnerabilities and Exposure (CVE) or from other sources. | [optional] 
+**justification** | **str** | Justification for accepting findings with this vulnerability id | [optional] 
+**accepted_by** | **str** | Name or email of person who accepts the risk | [optional] 
+
+## Example
+
+```python
+from defectdojo_api_generated.models.accepted_risk_request import AcceptedRiskRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AcceptedRiskRequest from a JSON string
+accepted_risk_request_instance = AcceptedRiskRequest.from_json(json)
+# print the JSON string representation of the object
+print(AcceptedRiskRequest.to_json())
+
+# convert the object into a dict
+accepted_risk_request_dict = accepted_risk_request_instance.to_dict()
+# create an instance of AcceptedRiskRequest from a dict
+accepted_risk_request_from_dict = AcceptedRiskRequest.from_dict(accepted_risk_request_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/README.md

@@ -0,0 +1,31 @@
+# AddNewNoteOptionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entry** | **str** |  | [optional] 
+**private** | **bool** |  | [optional] 
+**note_type** | **int** |  | [optional] 
+
+## Example
+
+```python
+from defectdojo_api_generated.models.add_new_note_option_request import AddNewNoteOptionRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AddNewNoteOptionRequest from a JSON string
+add_new_note_option_request_instance = AddNewNoteOptionRequest.from_json(json)
+# print the JSON string representation of the object
+print(AddNewNoteOptionRequest.to_json())
+
+# convert the object into a dict
+add_new_note_option_request_dict = add_new_note_option_request_instance.to_dict()
+# create an instance of AddNewNoteOptionRequest from a dict
+add_new_note_option_request_from_dict = AddNewNoteOptionRequest.from_dict(add_new_note_option_request_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/apimodels/AcceptedRiskRequest.md

@@ -0,0 +1,32 @@
+# Announcement
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | [optional] [readonly] 
+**message** | **str** | This dismissable message will be displayed on all pages for authenticated users. It can contain basic html tags, for example <a href='https://www.fred.com' style='color: #337ab7;' target='_blank'>https://example.com</a> | [optional] 
+**style** | **str** | The style of banner to display. (info, success, warning, danger)  * `info` - Info * `success` - Success * `warning` - Warning * `danger` - Danger | [optional] 
+**dismissable** | **bool** | Ticking this box allows users to dismiss the current announcement | [optional] 
+
+## Example
+
+```python
+from defectdojo_api_generated.models.announcement import Announcement
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Announcement from a JSON string
+announcement_instance = Announcement.from_json(json)
+# print the JSON string representation of the object
+print(Announcement.to_json())
+
+# convert the object into a dict
+announcement_dict = announcement_instance.to_dict()
+# create an instance of Announcement from a dict
+announcement_from_dict = Announcement.from_dict(announcement_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/apimodels/AddNewNoteOptionRequest.md

@@ -0,0 +1,31 @@
+# AnnouncementRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **str** | This dismissable message will be displayed on all pages for authenticated users. It can contain basic html tags, for example <a href='https://www.fred.com' style='color: #337ab7;' target='_blank'>https://example.com</a> | [optional] 
+**style** | **str** | The style of banner to display. (info, success, warning, danger)  * `info` - Info * `success` - Success * `warning` - Warning * `danger` - Danger | [optional] 
+**dismissable** | **bool** | Ticking this box allows users to dismiss the current announcement | [optional] 
+
+## Example
+
+```python
+from defectdojo_api_generated.models.announcement_request import AnnouncementRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AnnouncementRequest from a JSON string
+announcement_request_instance = AnnouncementRequest.from_json(json)
+# print the JSON string representation of the object
+print(AnnouncementRequest.to_json())
+
+# convert the object into a dict
+announcement_request_dict = announcement_request_instance.to_dict()
+# create an instance of AnnouncementRequest from a dict
+announcement_request_from_dict = AnnouncementRequest.from_dict(announcement_request_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+