[Schema Inaccuracy] Mismatch between the response schema and response example for "List repository security advisories" API call

[anishrajan25]

Schema Inaccuracy

As per the response schema for:

• Lists repository security advisories for an organization - /orgs/{org}/security-advisories
• Lists security advisories in a repository - /repos/{owner}/{repo}/security-advisories

the submission field's schema is as follows:

"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:

Expected

The response example for both the above API calls should have the submission field as:

"submission": {
    "accepted": true
}

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.

Reproduction Steps

Since this is an issue with documentation, there no requirement for reproducing anything.

[anishrajan25]

This would need the documentation to be updated. I can take up the task for fixing the documentation as well.

[anishrajan25]

Just checked the CONTRIBUTING.md and got to know that the description artifacts cannot be directly modified.

[anishrajan25]

@bearcherian So the correct schema for submission field is as per the response schema, right? i.e.:

"submission": {
    "accepted": true
}

[KateCatlin]

Hey @anishrajan25 we cleaned up this discrepancy in the docs here! https://github.com/github/github/pull/293752#issuecomment-1773261901