You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This means if we have 2 services in the same category where the path is /github/{variant}/{user}/{repo} one overwrites the other and only one shows up in the docs.
📋 Description
For historic reasons, we have a handful of badges that use the same 'path' in the Open API specs:
https://github.com/search?q=repo%3Abadges%2Fshields+path%3A%2F%5Eservices%5C%2Fgithub%5C%2F%2F+github%2F%7Bvariant%7D%2F%7Buser%7D%2F%7Brepo%7D&type=code
This is mostly fine, except we use path as the key in an object here:
shields/core/base-service/openapi.js
Lines 81 to 94 in e4a9c73
This means if we have 2 services in the same category where the path is
/github/{variant}/{user}/{repo}
one overwrites the other and only one shows up in the docs.Because both
https://github.com/badges/shields/blob/master/services/github/github-contributors.service.js
and
https://github.com/badges/shields/blob/master/services/github/github-release-date.service.js
are in the activity category, only one of them shows up in the docs.
I need to find a way round this. Probably make it an array instead of object.
While we are sorting this out, we should also document the difference between the contributors and contributors-anon variants.
The text was updated successfully, but these errors were encountered: