Skip to content

docs: Update REST API docs to clarify HEAD request #4565

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jess-lowe merged 1 commit into from
Jan 5, 2026
+2 −0
Merged

docs: Update REST API docs to clarify HEAD request #4565

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/rest-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ To contribute, we will need to know the following information:
```
The endpoint may contain more information, but at a minimum it must contain the ID and modified date of each vulnerability.

This endpoints must be configured to allow both HEAD and GET requests, with Last-Modified metadata provided to reduce unnecessary requests and traffic.

### 2. The base url of the endpoints:
This is the base url for which the full, individual vulnerability endpoints will be appended to.

Expand Down
Loading