Skip to content

Commit 4154927

Browse files
paulOsinskiPaul Osinski
andauthored
January wk 3/4 docs maintenance (#11632)
* exclude old notifications from search * sso page updates * clarify intended docs use * exclude old notifications from search * sso page updates * clarify intended docs use * rm duplicate api article --------- Co-authored-by: Paul Osinski <paul.m.osinski@gmail.com>
1 parent 72ac386 commit 4154927

13 files changed

Lines changed: 645 additions & 237 deletions

File tree

-138 KB
Binary file not shown.
73.9 KB
Loading
193 KB
Loading
File renamed without changes.
235 KB
Loading
File renamed without changes.

docs/content/en/about_defectdojo/about_docs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ cascade:
1919

2020
![image](images/dashboard.png)
2121

22+
<span style="background-color:rgba(242, 86, 29, 0.3)">DefectDojo Inc. and open-source contributors maintain this documentation to support both the Community and Pro editions of DefectDojo.</span>
23+
2224
### What is DefectDojo?
2325

2426
DefectDojo is a DevSecOps platform. DefectDojo streamlines DevSecOps by serving as an aggregator and single pane of glass for your security tools. DefectDojo has smart features to enhance and tune the results from your security tools including the ability to merge findings, remember false positives, and distill duplicates. DefectDojo also integrates with JIRA, provides metrics / reports, and can also be used for traditional pen test management.

docs/content/en/api/api-v2-docs.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ weight: 2
88
DefectDojo\'s API is created using [Django Rest
99
Framework](http://www.django-rest-framework.org/). The documentation of
1010
each endpoint is available within each DefectDojo installation at
11-
[`/api/v2/doc/`](https://demo.defectdojo.org/api/v2/) and can be accessed by choosing the API v2
11+
[`/api/v2/oa3/swagger-ui`](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/)) and can be accessed by choosing the API v2
1212
Docs link on the user drop down menu in the header.
1313

14-
![image](images/api_v2_1.png)
14+
![image](../../images/api_v2_1.png)
1515

1616
The documentation is generated using [drf-spectacular](https://drf-spectacular.readthedocs.io/) at [`/api/v2/oa3/swagger-ui/`](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/), and is
1717
interactive. On the top of API v2 docs is a link that generates an OpenAPI v3 spec.
@@ -20,12 +20,12 @@ To interact with the documentation, a valid Authorization header value
2020
is needed. Visit the `/api/key-v2` view to generate your
2121
API Key (`Token <api_key>`) and copy the header value provided.
2222

23-
![image](images/api_v2_2.png)
23+
![image](../../images/api_v2_2.png)
2424

2525
Each section allows you to make calls to the API and view the Request
2626
URL, Response Body, Response Code and Response Headers.
2727

28-
![image](images/api_v2_3.png)
28+
![image](../../images/api_v2_3.png)
2929

3030
If you're logged in to the Defect Dojo web UI, you do not need to provide the authorization token.
3131

@@ -42,7 +42,7 @@ For example: :
4242

4343
### Alternative authentication method
4444

45-
If you use [an alternative authentication method](../social-authentication/) for users, you may want to disable DefectDojo API tokens because it could bypass your authentication concept. \
45+
If you use [an alternative authentication method](../archived_docs/integrations/social-authentication/) for users, you may want to disable DefectDojo API tokens because it could bypass your authentication concept. \
4646
Using of DefectDojo API tokens can be disabled by specifying the environment variable `DD_API_TOKENS_ENABLED` to `False`.
4747
Or only `api/v2/api-token-auth/` endpoint can be disabled by setting `DD_API_TOKEN_AUTH_ENDPOINT_ENABLED` to `False`.
4848

@@ -125,7 +125,7 @@ The json object result is: :
125125
{{< /highlight >}}
126126

127127
See [Django Rest Framework\'s documentation on interacting with an
128-
API](http://www.django-rest-framework.org/topics/api-clients/) for
128+
API](https://www.django-rest-framework.org/) for
129129
additional examples and tips.
130130

131131
## Manually calling the API
@@ -178,4 +178,4 @@ Example for importing a scan result:
178178
| [.Net/C# library](https://www.nuget.org/packages/DefectDojo.Api/) | working (2021-06-08) | |
179179
| [dd-import](https://github.com/MaibornWolff/dd-import) | working (2021-08-24) | dd-import is not directly an API wrapper. It offers some convenience functions to make it easier to import findings and language data from CI/CD pipelines. |
180180

181-
Some of the api wrappers contain quite a bit of logic to ease scanning and importing in CI/CD environments. We are in the process of simplifying this by making the DefectDojo API smarter (so api wrappers / script can be dumber).
181+
Some of the api wrappers contain quite a bit of logic to ease scanning and importing in CI/CD environments. We are in the process of simplifying this by making the DefectDojo API smarter (so api wrappers / script can be dumber).

docs/content/en/customize_dojo/user_management/configure_sso.md

Lines changed: 633 additions & 49 deletions
Large diffs are not rendered by default.

docs/content/en/open_source/api-v2-docs.md

Lines changed: 0 additions & 181 deletions
This file was deleted.

0 commit comments

Comments
 (0)