Skip to content

Commit d789823

Browse files
paulOsinskiPaul Osinski
andauthored
Changelog update 2.42.3 + fix docs image refs (#11679)
* fix broken image embeds * update changelog 2.42.3 * change versioning format to clean up sidebar --------- Co-authored-by: Paul Osinski <paul.m.osinski@gmail.com>
1 parent 4154927 commit d789823

3 files changed

Lines changed: 47 additions & 29 deletions

File tree

84.2 KB
Loading

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

Lines changed: 5 additions & 5 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/oa3/swagger-ui`](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/)) 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](../archived_docs/integrations/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](en/customize_dojo/user_management/configure_sso/ 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

docs/content/en/changelog/changelog.md

Lines changed: 42 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,26 @@ Here are the release notes for **DefectDojo Pro (Cloud Version)**. These release
77

88
For Open Source release notes, please see the [Releases page on GitHub](https://github.com/DefectDojo/django-DefectDojo/releases), or alternatively consult the Open Source [upgrade notes](../../open_source/upgrading/upgrading_guide).
99

10-
## Jan 21, 2025: v2.42.2
10+
## Jan 2025: v2.42
11+
12+
### Jan 27, 2025: v2.42.3
13+
14+
- **(Connectors)** Added 'minimum severity' filter for Semgrep and Tenable Connectors. If you want to only upload Findings of a certain severity and up, you can set a filter for this under 'Minimum Severity' in your Connector options.
15+
16+
![image](images/connectors_min_severity.png)
17+
18+
Previously synced Findings that are no longer within the filter parameters will be set to Closed upon the following Sync operation.
19+
- **(API)** Prefetching multiple parameters now returns all prefetched objects in an array.
20+
21+
### Jan 21, 2025: v2.42.2
1122

1223
- **(Classic UI)** Corrected link to Smart Upload form.
1324
- **(CLI Tools)** Fixed issue with .exe extensions not getting added to Windows binaries
1425
- **(Findings)** `Mitigated` filter now uses datetime instead of date for filtering.
1526
- **(OAuth)** Clarified Azure AD labels to better align with Azure's language. Default value for Azure Resource is now set. <span style="background-color:rgba(242, 86, 29, 0.5)">(Pro)</span>
1627
- **(RBAC)** Request Review now applies RBAC properly with regard to User Groups.
1728

18-
## Jan 13, 2025: v2.42.1
29+
### Jan 13, 2025: v2.42.1
1930

2031
- **(API)** Pro users can now specify the fields they want to return in a given API payload. For example, this request will only return the title, severity and description fields for each Finding. <span style="background-color:rgba(242, 86, 29, 0.5)">(Pro)</span>
2132
```
@@ -28,19 +39,21 @@ curl -X 'GET' \
2839
- **(Risk Acceptance)** Simple Risk Acceptances now have a 'paper trail' created - when they are added or removed, a note will be added to the Finding to log the action.
2940
- **(Tools)** ImageTags are now included with AWS SecurityHub and AWS inspector parsers.
3041

31-
## Jan 6, 2025: v2.42.0
42+
### Jan 6, 2025: v2.42.0
3243

3344
- **(API)** `/test_reimport` results can now be ordered via id, created, modified, version, branch_tag, build_id, and commit_hash.
3445
- **(Jira)** When a Risk Acceptance expires, linked Jira Group issues will now be updated to reflect the status change.
3546

36-
## Dec 31, 2024: v2.41.4
47+
## Dec 2024: v2.41
48+
49+
#### Dec 31, 2024: v2.41.4
3750

3851
- **(API)** 'Force To Active / Verified' flag is no longer required when calling `/import-scan`, `/reimport-scan` endponts: a value of True now forces to Active, False now forces to Inactive, while setting a value of none (or not using the flag) will use the tool's status.
3952
- **(Beta UI)** Added ability to regenerate / copy your API token.
4053
- **(Beta UI)** Fixed bug preventing date / planned remediation dates from being added via Bulk Edit.
4154
- **(Import)** Added fields for EPSS score and percentile to Generic Findings Import parser.
4255

43-
## Dec 24, 2024: v2.41.3
56+
#### Dec 24, 2024: v2.41.3
4457

4558
- **(API)** Added `/request_response_pairs` endpoint.
4659
- **(Beta UI)** When sorting by Severity, Findings will now be ordered by **severity level** rather than alphabetically.
@@ -51,19 +64,19 @@ curl -X 'GET' \
5164
- **(Tools)** Qualys HackerGuardian now uses hashcode against "title", "severity", "description" for deduplication.
5265
- **(Tools)** Horusec scan now uses hashcode against "title", "description", "file_path", and "line" for deduplication.
5366

54-
## Dec 16, 2024: v2.41.2
67+
#### Dec 16, 2024: v2.41.2
5568

5669
- **(Connectors)** Remove the 'Beta' logo from Connectors
5770

58-
## Dec 9, 2024: v2.41.1
71+
#### Dec 9, 2024: v2.41.1
5972

6073
- **(API)** When using the jira_finding_mappings API endpoint, trying to update a finding's Jira mapping with a Jira issue that is already assigned to another finding will now raise a validation error.
6174
- **(Beta UI)** A Test's Import History is now paginated by default.
6275
- **(Findings)** New Filter: 'Has Any JIRA' which accounts for Findings with single Issues or Findings that were pushed to Jira as part of a Group.
6376
- **(Classic UI)** Filters have been added to the Product Type view. This is useful for when a single Product Type contains many Products which need to be filtered down.
6477
- **(Classic UI)** Reported Finding Severity by Month graph now tracks the X axis by month correctly.
6578

66-
## Dec 2, 2024: v2.41.0
79+
#### Dec 2, 2024: v2.41.0
6780

6881
- **(API)** `engagements/{id}/update_jira_epic` endpoint path added so that users can now push an updated Engagement to Jira, without creating a new Jira Epic.
6982
- **(Beta UI)** Columns can now be reordered in tables, by clicking and dragging the column header.
@@ -74,7 +87,9 @@ curl -X 'GET' \
7487
- **(Classic UI)** Reviewers are now displayed on Finding pages.
7588
- **(Docs)** New integrated docs site: https://docs.defectdojo.com/
7689

77-
## Nov 25, 2024: v2.40.4
90+
## Nov 2024: v2.40
91+
92+
#### Nov 25, 2024: v2.40.4
7893

7994
- **(Beta UI)** Improved Metadata tables with Parent object relationships for Products, Engagements, Tests, Findings, Endpoints/Hosts
8095
- **(Beta UI)** Deleting an object now returns you to a page which makes more sense.
@@ -85,7 +100,7 @@ curl -X 'GET' \
85100
- **(Tools)** AnchorCTL Policies tool has been fortified to handle new severity values.
86101

87102

88-
## Nov 17, 2024: v2.40.2
103+
#### Nov 17, 2024: v2.40.2
89104

90105
- **(API)** Added an API endpoint to get the DefectDojo version number: `/api/v2/version` <span style="background-color:rgba(242, 86, 29, 0.5)">(Pro)</span>
91106
- **(API)** Multiple Metadata objects can now be added to a single Endpoint, Finding or Product via POST or PATCH to `/api/v2/metadata/` . Previously, only one Metadata key/value pair could be updated per call.
@@ -97,7 +112,7 @@ curl -X 'GET' \
97112
- **(Tools)** Update to AWS Prowler parser - can now handle the ‘event_time’ parameter
98113

99114

100-
## Nov 14, 2024: v2.40.1
115+
#### Nov 14, 2024: v2.40.1
101116

102117
- **(API)** Added a method to validate for file extensions, when 'artifact' files are added to a test (images, for example)
103118
- **(Cloud Portal)** Fixed an issue where QR codes were not being generated correctly for MFA setup. <span style="background-color:rgba(242, 86, 29, 0.5)">(Pro)</span>
@@ -108,7 +123,7 @@ curl -X 'GET' \
108123

109124

110125

111-
## Nov 4, 2024: v2.40.0
126+
#### Nov 4, 2024: v2.40.0
112127

113128
- **(API)** Engagement_End_Date is now honored when submitted via /import /reimport endpoint.
114129
- **(API)** Corrected an issue with the /import endpoint where old Findings were not being mitigated correctly.
@@ -136,14 +151,16 @@ configuration fields.
136151
* The "Location" field should be populated with the appropriate API endpoint for your region. For example, to retrieve results from the us-east-1 region, you would supply https://securityhub.us-east-1.amazonaws.com.
137152
* Note that we rely on Security Hub's cross-region aggregation to pull findings from more than one region. If cross-region aggregation is enabled, you should supply the API endpoint for your "Aggregation Region". Additional linked regions will have ProductRecords created for them in DefectDojo based on your AWS account IDs and the region names.
138153

139-
## Oct 29, 2024: v2.39.4
154+
## Oct 2024: v2.39
155+
156+
#### Oct 29, 2024: v2.39.4
140157

141158
- **(API)** Corrected 'multiple positional arguments' issue with `/import` endpoint
142159
- **(Metrics)** Dashboards can now handle multiple Products or Product Types simultaneously: this includes the Executive, Program, Remediation and Tool insights dashboards. <span style="background-color:rgba(242, 86, 29, 0.5)">(Pro)</span>
143160
- **(Tools)** OSV, Tenable parsers have been made more robust
144161

145162

146-
## Oct 21, 2024: v2.39.1
163+
#### Oct 21, 2024: v2.39.1
147164

148165
- **(Beta UI)** Parent Object links have been added to the Metadata table to help contextualize the page you're on
149166
- **(Beta UI)** Improved "Toggle Columns" menu on tables
@@ -153,24 +170,25 @@ configuration fields.
153170
- **(Metrics)** All Metrics dashboards can now be exported as a PDF (Remediation Insights, Program Insights, Tool Insights) <span style="background-color:rgba(242, 86, 29, 0.5)">(Pro)</span>
154171

155172

156-
## Oct 7, 2024: v2.39.0
173+
#### Oct 7, 2024: v2.39.0
157174

158175
- **(Beta UI)** Dropdown menus for Import Scan / Reimport Scan no longer block the active element of a form.
159176
- **(Beta UI)** Finding counts by Severity now disregard Out Of Scope / False Positive Findings.
160177
- **(Dashboard)** Tile filters with a Boolean filter of False are now saving correctly. E.G. If you tried to create a Tile with a filter condition of “Has Jira = No” previously this would not be applied correctly.
161178
- **(Jira)** Added help text for 'Push All Issues'.
162179
- **(Tools)** AWS Security Hub EPSS score now parses correctly.
163180

181+
## Sept 2024: v2.38
164182

165-
## Sept 30, 2024: v2.38.4
183+
#### Sept 30, 2024: v2.38.4
166184

167185
- **(API)** Object History can now be accessed via the API.
168186
- **(API Docs)** Generating the response schema for certain API endpoints no longer breaks the Swagger interface.
169187
- **(Metrics)** Added Executive Insights dashboard, Select a Product or Product type, and you can view an executive summary of that Product/Product Type’s security posture with relevant stats. <span style="background-color:rgba(242, 86, 29, 0.5)">(Pro)</span>
170188
- **(Passwords)** Password creation for new users can now be made optional upon request. This feature is toggled via the back-end.
171189

172190

173-
## Sept 23, 2024: v2.38.3
191+
#### Sept 23, 2024: v2.38.3
174192

175193
- **(API)** `/global_role` endpoint now supports prefetching.
176194
- **(API)** It is now possible to prefetch a Finding with attached files via API.
@@ -182,7 +200,7 @@ configuration fields.
182200
- **Tools** fixed an issue where certain tools would not process asyncronously: Whitehat_Sentinel, SSLyze, SSLscan, Qualys_Webapp, Mend, Intsights, H1, and Blackduck.
183201

184202

185-
## Sept 16, 2024: v2.38.2
203+
#### Sept 16, 2024: v2.38.2
186204

187205
- **(Beta UI)** Jira integration in Beta UI now has parity with Legacy UI. Ability to Push To Jira has been added, and the Jira ticket view has been added to Findings, Engagements, and all other related objects in DefectDojo.
188206
- **(Finding SLAs)** Added “Mitigated Within SLA” Finding filter, so that users can now count how many Findings were mitigated on time, and how many were not. Previously, we were only able to filter Findings that were currently violating SLA or not, rather than ones that had historically violated SLA or not.
@@ -195,7 +213,7 @@ configuration fields.
195213

196214

197215

198-
## Sept 9, 2024: v2.38.1
216+
#### Sept 9, 2024: v2.38.1
199217

200218
- **(Beta UI)** Clearing a date filter and re-applying it no longer throws a 400 error.
201219
- **(Dashboard)** Dashboard Tag Filters now work correctly in both legacy and beta UIs.
@@ -207,7 +225,7 @@ configuration fields.
207225
- **(Tools)** EPSS score / percentile will now be imported from Aquasec files
208226

209227

210-
## Sept 3, 2024: v2.38.0
228+
#### Sept 3, 2024: v2.38.0
211229

212230
- **(API)** Better naming conventions on Mitigated and Discovered date filters: these are now labeled Mitigated/Discovered On, Mitigated/Discovered Before, Mitigated/Discovered After.
213231
- **(Beta UI)** Pre-filtered Finding Routes added to Sidebar: you can now quickly filter for Active Findings, Mitigated Findings, All Risk Acceptances, All Finding Groups.
@@ -222,8 +240,9 @@ configuration fields.
222240
- **(Reimport)** Reimporting Findings that have been Risk-Accepted no longer changes their status to ‘Mitigated’.
223241
- **(Risk Acceptance)** Updating the Simple Risk Acceptance or the Full Risk Acceptance flag on a Product now updates the Product as expected.
224242

243+
## Aug 2024: v2.37
225244

226-
## Aug 28, 2024: v2.37.3
245+
#### Aug 28, 2024: v2.37.3
227246

228247
- **(API)** New Endpoint: /finding_groups allows you to GET, add Findings to, delete, or otherwise interact with Finding Groups. <span style="background-color:rgba(242, 86, 29, 0.5)">(Pro)</span>
229248
- **(Beta UI)** Relative date ranges for Findings have been added to Finding Filters (last 30 days, last 90 days, etc)
@@ -238,8 +257,7 @@ configuration fields.
238257
- **(Tools)** New Parser: AppCheck Web Application Scanning
239258
- **(Tools)** Nmap Parser now handles script output
240259

241-
242-
## Aug 7, 2024: v2.37.0
260+
#### Aug 7, 2024: v2.37.0
243261

244262
- **(API)** Created a method to handle simultaneous async reimports to the same Test via API
245263
- **(API)** Minimum Severity flag now works as expected on /import, /reimport endpoints (Clearsale)
@@ -258,7 +276,7 @@ configuration fields.
258276
- **(Tools)** Kiuwan SCA Parser released
259277
- **(Tools)** Test Types can now be set to Inactive so that they won’t appear in menus. This ‘inactive’ setting can only be applied in the legacy UI, via Engagements > Test Types (or defectdojo.com/test_type)
260278

261-
## Jul 8, 2024: v2.36.0
279+
## Jul 2024: v2.36.0
262280

263281
- **(Notifications)** Improved email notifications with collapsible Finding lists for greater readability
264282
- **(SLAs)** SLAs can now be optionally enforced. For each SLA associated with a Product you can set or unset the Enforce __ Finding Days box in the relevant SLA Configuration screen. When this box is unchecked, SLAs for Findings that match that Severity level will not be tracked or displayed in the UI.

0 commit comments

Comments
 (0)