[Schema Inaccuracy] Object properties are mistakenly under an array schema about rest-api-description HOT 4 CLOSED

Thanks a lot for that detail, @mattpolzin! I can see it now (I was previously looking in the api.github.com description).

After testing the functionality of the endpoint that uses that schema (e.g. GET /feeds on a GHES 2.22 server), it actually doesn't return an array. _links just contains objects.

I'll get this fixed up in the schema 👍

from rest-api-description.

@mattpolzin Thanks for this report, but I'm having trouble finding this array in the schema; it might have already been fixed. Can you check and let me know if it's still there? A commit SHA/filename/line number would be great 🙇‍♂️

from rest-api-description.

Sure, with the current HEAD commit of main (SHA 015ac73e48d69e9b2ee968682be32ab03865e5a2), the _links object is on line 34588 of /descriptions/ghes-2.22/ghes-2.22.yaml.

Line 34590 starts the required array:

required:
- timeline
- user

This required array is does not make sense on the _links object which is of type "array". On the other hand, timeline and user are both properties of the associated items object that starts on line 34593 which leads me to the "expected" section from my original issue report that suggests moving the required array into the items object is probably the desired course of action.

from rest-api-description.

This has been fixed internally, and should be propagated to the public schema soon 🚀

from rest-api-description.