Open
Description
Schema Inaccuracy
It appears the description for some endpoints use broken anchor links for nested objects; affected (list might be incomplete):
- https://docs.github.com/rest/reference/checks#output-object
- https://docs.github.com/rest/reference/checks#annotations-object
- https://docs.github.com/rest/reference/checks#images-object
- https://docs.github.com/rest/reference/checks#actions-object
- https://docs.github.com/rest/reference/checks#output-object-1
- https://docs.github.com/rest/reference/checks#annotations-object-1
- https://docs.github.com/rest/reference/checks#auto_trigger_checks-object
For example for annotations the correct anchor would be #create-a-check-run-annotations-items
; however even if the correct URL was used, e.g. https://docs.github.com/en/rest/reference/checks#create-a-check-run-annotations-items it would be confusing because (1) the annotations
description is collapsed by default, (2) scrolling does not seem to account for the floating table header so the annotations
description is not visible (though maybe that should be raised as issue for the docs repo?).
Expected
Correct links are used.