[Schema Inaccuracy] Dependabot Alert "relationship" enum is incomplete
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- openapi
- Domain
- api
Research direction
Start with the organization Dependabot alerts endpoint documentation and the dependabot-alert-with-repository response schema. Locate the dependency.relationship enum and verify the API's possible values, including inconclusive. Done means the schema lists all valid values and any relevant schema validation checks pass.
Written by the indexing model from the issue text.
Description
Schema Inaccuracy
The Response Schema for the dependabot alert endpoint (for organizations) defines 3 valid values for relationship. When using this endpoint we sometimes get the value "inconclusive" which is not listed.
"dependabot-alert-with-repository": {
"type": "object",
"description": "A Dependabot alert.",
"properties": {
"number": {
"$ref": "#/components/schemas/alert-number"
},
"state": {
...
},
"dependency": {
"type": "object",
"description": "Details for the vulnerable dependency.",
"readOnly": true,
"properties": {
...
"relationship": {
"type": "string",
"description": "...",
"readOnly": true,
"nullable": true,
"enum": [
"unknown",
"direct",
"transitive"
]
}
}
},
Expected
The schema should include all values
"dependabot-alert-with-repository": {
"type": "object",
"description": "A Dependabot alert.",
"properties": {
"number": {
"$ref": "#/components/schemas/alert-number"
},
"state": {
...
},
"dependency": {
"type": "object",
"description": "Details for the vulnerable dependency.",
"readOnly": true,
"properties": {
...
"relationship": {
"type": "string",
"description": "...",
"readOnly": true,
"nullable": true,
"enum": [
"unknown",
"direct",
"transitive",
"inconclusive"
]
}
}
},
Reproduction Steps
Due to the sensitive nature of alerts I cannot provide an explicit example.
- Dominant language
- No language data
- Stars
- 1.6k
- Forks
- 342
- Avg merge
- 3h 33m
- Merged PRs (30d)
- 51
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/rest-api-description
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
github/rest-api-description#7201 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
github/rest-api-description#7163 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7162 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7135 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
github/rest-api-description#7111 · 1 comment ·
All issues in github/rest-api-description
Similar issues
-
area/sessions comp/cron comp/gateway P2 sweeper:risk-message-delivery sweeper:risk-session-state type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
NousResearch/hermes-agent#118863 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
use-agent-os/agent-os#3312 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
needs-acceptance wg/data-plane-networking
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vllm-project/semantic-router#4024 · 1 comment ·