We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
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
As per the response schema for:
the submission field's schema is as follows:
submission
"submission": { "type": [ "object", "null" ], "readOnly": true, "properties": { "accepted": { "type": "boolean", "description": "Whether a private vulnerability report was accepted by the repository's administrators.", "readOnly": true } }, "required": [ "accepted" ] }
i.e. the submission field in the response should be as follows:
"submission": { "accepted": true }
But the response example for both these API calls have the submission field as:
"submission": [ { "accepted": true } ]
Screenshot from official documentation:
The response example for both the above API calls should have the submission field as:
For the Report a security vulnerability (/repos/{owner}/{repo}/security-advisories/reports) API call, the submission field's schema is the same as above 2 API calls but the response example has the submission field in correct format.
Since this is an issue with documentation, there no requirement for reproducing anything.
The text was updated successfully, but these errors were encountered:
This would need the documentation to be updated. I can take up the task for fixing the documentation as well.
Sorry, something went wrong.
Just checked the CONTRIBUTING.md and got to know that the description artifacts cannot be directly modified.
@bearcherian So the correct schema for submission field is as per the response schema, right? i.e.:
Hey @anishrajan25 we cleaned up this discrepancy in the docs here! https://github.com/github/github/pull/293752#issuecomment-1773261901
No branches or pull requests
Schema Inaccuracy
As per the response schema for:
the
submission
field's schema is as follows:i.e. the
submission
field in the response should be as follows:But the response example for both these API calls have the
submission
field as:Screenshot from official documentation:
Expected
The response example for both the above API calls should have the
submission
field as:For the Report a security vulnerability (/repos/{owner}/{repo}/security-advisories/reports) API call, the
submission
field's schema is the same as above 2 API calls but the response example has thesubmission
field in correct format.Reproduction Steps
Since this is an issue with documentation, there no requirement for reproducing anything.
The text was updated successfully, but these errors were encountered: