diff --git a/CHANGELOG.md b/CHANGELOG.md index ac831eb..35a10e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## [1.5.0](https://github.com/RedHatProductSecurity/cvelib/compare/1.4.0...1.5.0) (Jul 18, 2024) + +* The `-u/--username` option is now required when updating a user or resetting the token of a user (#86). +* Updated CVE record schemas to final 5.1.0 version; the previous 5.1.0 were still RC versions that later changed (#87). +* The called command is shown in an error message that refers users to read help text (#84). + ## [1.4.0](https://github.com/RedHatProductSecurity/cvelib/compare/1.3.0...1.4.0) (May 15, 2024) * Updated CVE JSON schema to version 5.1.0, which makes it compatible with CVE Services 2.3.x (#79). diff --git a/cvelib/__init__.py b/cvelib/__init__.py index 3e8d9f9..5b60188 100644 --- a/cvelib/__init__.py +++ b/cvelib/__init__.py @@ -1 +1 @@ -__version__ = "1.4.0" +__version__ = "1.5.0" diff --git a/man/cve-list.1 b/man/cve-list.1 index 0ff7949..2423b00 100644 --- a/man/cve-list.1 +++ b/man/cve-list.1 @@ -1,4 +1,4 @@ -.TH "CVE LIST" "1" "2024-05-15" "1.4.0" "cve list Manual" +.TH "CVE LIST" "1" "2024-07-18" "1.5.0" "cve list Manual" .SH NAME cve\-list \- Filter and list reserved CVE IDs owned by... .SH SYNOPSIS diff --git a/man/cve-org-users.1 b/man/cve-org-users.1 index 751fed5..dd86ec2 100644 --- a/man/cve-org-users.1 +++ b/man/cve-org-users.1 @@ -1,4 +1,4 @@ -.TH "CVE ORG USERS" "1" "2024-05-15" "1.4.0" "cve org users Manual" +.TH "CVE ORG USERS" "1" "2024-07-18" "1.5.0" "cve org users Manual" .SH NAME cve\-org\-users \- List all users in your organization. .SH SYNOPSIS diff --git a/man/cve-org.1 b/man/cve-org.1 index f9a6b28..94ebae6 100644 --- a/man/cve-org.1 +++ b/man/cve-org.1 @@ -1,4 +1,4 @@ -.TH "CVE ORG" "1" "2024-05-15" "1.4.0" "cve org Manual" +.TH "CVE ORG" "1" "2024-07-18" "1.5.0" "cve org Manual" .SH NAME cve\-org \- Show information about your organization. .SH SYNOPSIS diff --git a/man/cve-ping.1 b/man/cve-ping.1 index 0ca083a..0b0f985 100644 --- a/man/cve-ping.1 +++ b/man/cve-ping.1 @@ -1,4 +1,4 @@ -.TH "CVE PING" "1" "2024-05-15" "1.4.0" "cve ping Manual" +.TH "CVE PING" "1" "2024-07-18" "1.5.0" "cve ping Manual" .SH NAME cve\-ping \- Ping the CVE Services API to see if it is up. .SH SYNOPSIS diff --git a/man/cve-publish-adp.1 b/man/cve-publish-adp.1 index 495caa0..5f2d0e5 100644 --- a/man/cve-publish-adp.1 +++ b/man/cve-publish-adp.1 @@ -1,4 +1,4 @@ -.TH "CVE PUBLISH-ADP" "1" "2024-05-15" "1.4.0" "cve publish-adp Manual" +.TH "CVE PUBLISH-ADP" "1" "2024-07-18" "1.5.0" "cve publish-adp Manual" .SH NAME cve\-publish-adp \- Add or update an ADP container in a CVE... .SH SYNOPSIS diff --git a/man/cve-publish.1 b/man/cve-publish.1 index 533bc51..24d700c 100644 --- a/man/cve-publish.1 +++ b/man/cve-publish.1 @@ -1,4 +1,4 @@ -.TH "CVE PUBLISH" "1" "2024-05-15" "1.4.0" "cve publish Manual" +.TH "CVE PUBLISH" "1" "2024-07-18" "1.5.0" "cve publish Manual" .SH NAME cve\-publish \- Publish a CNA container of a CVE record... .SH SYNOPSIS diff --git a/man/cve-quota.1 b/man/cve-quota.1 index bcfc545..5517314 100644 --- a/man/cve-quota.1 +++ b/man/cve-quota.1 @@ -1,4 +1,4 @@ -.TH "CVE QUOTA" "1" "2024-05-15" "1.4.0" "cve quota Manual" +.TH "CVE QUOTA" "1" "2024-07-18" "1.5.0" "cve quota Manual" .SH NAME cve\-quota \- Display the available CVE ID quota for... .SH SYNOPSIS diff --git a/man/cve-reject.1 b/man/cve-reject.1 index 6b71bef..3fb384d 100644 --- a/man/cve-reject.1 +++ b/man/cve-reject.1 @@ -1,4 +1,4 @@ -.TH "CVE REJECT" "1" "2024-05-15" "1.4.0" "cve reject Manual" +.TH "CVE REJECT" "1" "2024-07-18" "1.5.0" "cve reject Manual" .SH NAME cve\-reject \- Reject a CVE record for a reserved or... .SH SYNOPSIS diff --git a/man/cve-reserve.1 b/man/cve-reserve.1 index 6ab6db3..d5aff32 100644 --- a/man/cve-reserve.1 +++ b/man/cve-reserve.1 @@ -1,4 +1,4 @@ -.TH "CVE RESERVE" "1" "2024-05-15" "1.4.0" "cve reserve Manual" +.TH "CVE RESERVE" "1" "2024-07-18" "1.5.0" "cve reserve Manual" .SH NAME cve\-reserve \- Reserve one or more CVE IDs. .SH SYNOPSIS diff --git a/man/cve-show.1 b/man/cve-show.1 index a4ce2ea..886571a 100644 --- a/man/cve-show.1 +++ b/man/cve-show.1 @@ -1,4 +1,4 @@ -.TH "CVE SHOW" "1" "2024-05-15" "1.4.0" "cve show Manual" +.TH "CVE SHOW" "1" "2024-07-18" "1.5.0" "cve show Manual" .SH NAME cve\-show \- Display a specific CVE ID (and optionally... .SH SYNOPSIS diff --git a/man/cve-undo-reject.1 b/man/cve-undo-reject.1 index c2f8b89..14bb2b3 100644 --- a/man/cve-undo-reject.1 +++ b/man/cve-undo-reject.1 @@ -1,4 +1,4 @@ -.TH "CVE UNDO-REJECT" "1" "2024-05-15" "1.4.0" "cve undo-reject Manual" +.TH "CVE UNDO-REJECT" "1" "2024-07-18" "1.5.0" "cve undo-reject Manual" .SH NAME cve\-undo-reject \- Move a rejected CVE ID without a record... .SH SYNOPSIS diff --git a/man/cve-user-create.1 b/man/cve-user-create.1 index 97da939..c8e93ac 100644 --- a/man/cve-user-create.1 +++ b/man/cve-user-create.1 @@ -1,4 +1,4 @@ -.TH "CVE USER CREATE" "1" "2024-05-15" "1.4.0" "cve user create Manual" +.TH "CVE USER CREATE" "1" "2024-07-18" "1.5.0" "cve user create Manual" .SH NAME cve\-user\-create \- Create a user in your organization. .SH SYNOPSIS diff --git a/man/cve-user-reset-key.1 b/man/cve-user-reset-key.1 index 5302d9d..e3d5fdd 100644 --- a/man/cve-user-reset-key.1 +++ b/man/cve-user-reset-key.1 @@ -1,4 +1,4 @@ -.TH "CVE USER RESET-KEY" "1" "2024-05-15" "1.4.0" "cve user reset-key Manual" +.TH "CVE USER RESET-KEY" "1" "2024-07-18" "1.5.0" "cve user reset-key Manual" .SH NAME cve\-user\-reset-key \- Reset a user's personal access token (API... .SH SYNOPSIS @@ -6,13 +6,15 @@ cve\-user\-reset-key \- Reset a user's personal access token (API... [OPTIONS] .SH DESCRIPTION Reset a user's personal access token (API key). +.PP + You must explicitly specify the user being updated using the `-u` option. .PP This API key is used to authenticate each request to the CVE API. .SH OPTIONS .TP \fB\-u,\fP \-\-username TEXT -User whose API key should be reset (only ADMIN role users can update other users). [default: (Current user specified in global -u/--username/CVE_USER)] +User whose API key should be reset (only ADMIN role users can update other users). [required] .TP \fB\-\-raw\fP Print response JSON. diff --git a/man/cve-user-update.1 b/man/cve-user-update.1 index 4dd23d2..f85d7cf 100644 --- a/man/cve-user-update.1 +++ b/man/cve-user-update.1 @@ -1,4 +1,4 @@ -.TH "CVE USER UPDATE" "1" "2024-05-15" "1.4.0" "cve user update Manual" +.TH "CVE USER UPDATE" "1" "2024-07-18" "1.5.0" "cve user update Manual" .SH NAME cve\-user\-update \- Update a user. .SH SYNOPSIS @@ -6,13 +6,15 @@ cve\-user\-update \- Update a user. [OPTIONS] .SH DESCRIPTION Update a user. +.PP + You must explicitly specify the user being updated using the `-u` option. .PP To reset a user's API key, use `cve user reset-key`. .SH OPTIONS .TP \fB\-u,\fP \-\-username TEXT -Username of the user being updated (only ADMIN role users can update other users). [default: (Current user specified in global -u/--username/CVE_USER)] +Username of the user being updated (only ADMIN role users can update other users). [required] .TP \fB\-\-mark\-active\fP / \-\-mark\-inactive Mark user as active or inactive. diff --git a/man/cve-user.1 b/man/cve-user.1 index 737653f..604f21b 100644 --- a/man/cve-user.1 +++ b/man/cve-user.1 @@ -1,4 +1,4 @@ -.TH "CVE USER" "1" "2024-05-15" "1.4.0" "cve user Manual" +.TH "CVE USER" "1" "2024-07-18" "1.5.0" "cve user Manual" .SH NAME cve\-user \- Show information about a user. .SH SYNOPSIS @@ -9,7 +9,7 @@ Show information about a user. .SH OPTIONS .TP \fB\-u,\fP \-\-username TEXT -Specify the user to show. [default: (Current user specified in -u/--username/CVE_USER)] +Specify the user to show. [default: (Current user specified in top-level -u/--username/$CVE_USER)] .TP \fB\-\-raw\fP Print response JSON. diff --git a/man/cve.1 b/man/cve.1 index 6a8e61f..7f3b2ad 100644 --- a/man/cve.1 +++ b/man/cve.1 @@ -1,4 +1,4 @@ -.TH "CVE" "1" "2024-05-15" "1.4.0" "cve Manual" +.TH "CVE" "1" "2024-07-18" "1.5.0" "cve Manual" .SH NAME cve \- A CLI interface for the CVE Services API. .SH SYNOPSIS