Changed endpoint star to stars

[binbalenci]

No description provided.

[shields-ci]

	Messages
📖	✨ Thanks for your contribution to Shields, @binhbbui411!
📖	Thanks for contributing to our documentation. We ❤️ our documentarians!

Generated by 🚫 dangerJS

[paulmelnikow]

(Reopen of #1597)

[PyvesB]

Given this hasn't been deployed yet I think its reasonable to change the endpoint because every other service uses /stars as opposed to /star and there is no backwards-compatibility to break yet.

Careful, we have now deployed these badges, so there may be an impact on early users. 😉

[binbalenci]

@PyvesB I have noticed that today too! It's awesome that we have the badge ready now. Huge thanks to the team!

And yes I will take responsibility for my code. 💪

[chris48s]

Careful, we have now deployed these badges, so there may be an impact on early users

I had spotted this complication. Given that if we merge this now, there's probably a few weeks between now and the next deploy, I think it would be better if the examples say /stars but the regex/case statement accepts star|stars so we don't unexpectedly break badges for people who have adopted it in the meantime.

Do you mind making that change @binhbbui411 - apologies for the bad timing

[PyvesB]

@chris48s there are quite a few issues with the current deployment (see all the issues opened by @paulmelnikow in the past hours), so I suspect we might be deploying sooner than in a few weeks. Should we take that into account?

[binbalenci]

@chris48s @PyvesB No problem, that makes sense as well. I have committed those changes.

Also, we have only announced the badge to our internal staffs, so if you guys plan to make the next deploy in the next 2 weeks, I can postpone the announcement to our users and thus, accept only the endpoint stars for the consistency. I would like to get a notice about that.

[chris48s]

As it stands we can merge this and whether the next deploy is next few days or next few weeks, we minimise the chance of a breaking change. The additional overhead of supporting both endpoints is negligible so I'm inclined to go with both. I'm not strongly committed to that though: If we know there will be another deploy in the near future and nobody is using it yet, just changing it is fine.

[platan]

I agree with you we should support an old endpoint.