Skip to content

Commit 96558c7

Browse files
Update docs to reflect API case sensitivity and python version (#2289)
#1637: Add case sensitive requirement to API docs #2281: Update Python required version to 3.11+ --------- Co-authored-by: Andrew Pollock <[email protected]>
1 parent a7f4b50 commit 96558c7

File tree

4 files changed

+6
-1
lines changed

4 files changed

+6
-1
lines changed

docs/api/get-v1-vulns.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ The only parameter you need for this API call is the vulnerability id, in order
2525

2626
`https://api.osv.dev/v1/vulns/{id}`
2727

28+
Case Sensitivity: API requests are case-sensitive. Please ensure that you use the correct case for parameter names and values. For example, use 'GHSA' instead of 'ghsa'.
29+
2830
## Request sample
2931

3032
```bash

docs/api/post-v1-determineversion.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ If you want to use the API manually, or build your own tool to use the endpoint,
7272
| `file_hashes.hash` | string | the MD5 hash bytes encoded in base64. |
7373
| `file_hashes.file_path` | string | the path to the file that's hashed, relative to the root directory of the library |
7474

75+
Case Sensitivity: API requests are case-sensitive. Please ensure that you use the correct case for parameter names and values. For example, use 'stdlib' instead of 'Stdlib'.
7576

7677
### Manual API calls
7778
After locating the library directory, walk through the directory, saving the MD5 hash of every file with the following extensions:

docs/api/post-v1-query.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ Package Objects can be described by package name AND ecosystem OR by the package
4141
| `ecosystem` | string | The ecosystem for this package. For the complete list of valid ecosystem names, see [here](https://ossf.github.io/osv-schema/#affectedpackage-field). Must be included if identifying the package by `name`. If specifying by `name` and `ecosystem`, `purl` should not be set. |
4242
| `purl` | string | The package URL for this package. If `purl` is used to specify the package, `name` and `ecosystem` should not be set. |
4343

44+
Case Sensitivity: API requests are case-sensitive. Please ensure that you use the correct case for parameter names and values. For example, use 'PyPI' instead of 'pypi'.
45+
4446
## Payload
4547
```json
4648
{

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,6 @@
5151
# Include any JSON schemas.
5252
'': ['*.json'],
5353
},
54-
python_requires='>=3.7',
54+
python_requires='>=3.11',
5555
zip_safe=False,
5656
)

0 commit comments

Comments
 (0)