[Schema Inaccuracy] Code Scanning Alert
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 55/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- github, openapi
- Domain
- api, documentation
Research direction
Start with the organization code scanning alerts endpoint schema linked in the issue and inspect how its response classification enum is defined. Confirm that "documentation" is a valid observed value, then update the schema so the enum includes it and verify the endpoint description remains consistent.
Written by the indexing model from the issue text.
Description
Schema Inaccuracy
The Response Schema for the code scanning alert endpoint(for organizations) defines 4 valid values for classifications. When using this endpoint we sometimes get the value "documentation" which is not listed.
"code-scanning-alert-classification": {
"type": "string",
"description": "A classification of the file. For example to identify it as generated.",
"nullable": true,
"enum": [
"source",
"generated",
"test",
"library"
]
},
Expected
The schema should include all values
"code-scanning-alert-classification": {
"type": "string",
"description": "A classification of the file. For example to identify it as generated.",
"nullable": true,
"enum": [
"source",
"generated",
"test",
"library",
"documentation"
]
},
Reproduction Steps
Due to the sensitive nature of the 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
-
clawsweeper:linked-pr-open clawsweeper:no-new-fix-pr clawsweeper:source-repro impact:message-loss issue-rating: 🦞 diamond lobster maturity:stable P2
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
growthbook/growthbook#7100 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
punkpeye/mcp-remote#369 ·
-
Client customer-reported needs-team-attention question Service Attention WebPubSub
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Azure/azure-sdk-for-net#63292 · 3 comments · 1 reaction ·
-
bug p:3-mid pydanty:bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
pydantic/pydantic-ai#8643 · 1 comment ·