Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove no download handling and add API warning to [Wordpress] badges #7606

Merged
merged 2 commits into from Feb 13, 2022
Merged

Remove no download handling and add API warning to [Wordpress] badges #7606

merged 2 commits into from Feb 13, 2022

Conversation

PyvesB
Copy link
Member

@PyvesB PyvesB commented Feb 12, 2022

Fixes #7356.

@PyvesB PyvesB added the service-badge Accepted and actionable changes, features, and bugs label Feb 12, 2022
PyvesB
PyvesB commented Feb 12, 2022
View reviewed changes
services/wordpress/wordpress-rating.service.js
@@ -78,7 +79,7 @@ function StarsForExtensionType(extensionType) {
staticPreview: this.render({
rating: 80,
}),
documentation: 'There is an alias <code>/r/:slug.svg</code> as well.',
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're not consistent with our usage of the /r/ abbreviation in the rating category, I chose to stop advertising it in the docs.

@shields-ci
Copy link

shields-ci commented Feb 12, 2022 •
edited

Messages
📖 ✨ Thanks for your contribution to Shields, @PyvesB!

Generated by 🚫 dangerJS against 4e4e44f

@shields-cd shields-cd temporarily deployed to shields-staging-pr-7606 February 12, 2022 11:01 Inactive
calebcartwright
calebcartwright approved these changes Feb 12, 2022
View reviewed changes
Copy link
Member

@calebcartwright calebcartwright left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks!

@chris48s
Copy link
Member

Based on the comment in https://meta.trac.wordpress.org/ticket/6061#comment:3 and https://meta.trac.wordpress.org/ticket/6061#comment:5 do we want to apply this documentation to all wordpress badges (including the ones calling the /info endpoint, or just the ones calling the /stats endpoint)? It seems like the ones calling /info are more reliable.

@PyvesB
Copy link
Member Author

PyvesB commented Feb 12, 2022 •
edited

Based on the comment in https://meta.trac.wordpress.org/ticket/6061#comment:3 and https://meta.trac.wordpress.org/ticket/6061#comment:5 do we want to apply this documentation to all wordpress badges (including the ones calling the /info endpoint, or just the ones calling the /stats endpoint)? It seems like the ones calling /info are more reliable.

Yeah, I did hesitate, and was leaning slightly towards applying the documentation everywhere for three reasons:

  • they state that /info is "not intended to be used outside of WordPress.org/WordPress but we don't prevent it", which still feels like "unsupported for external users".
  • their doc page will apparently soon be removed due to the Codex shutdown. All Wordpress badges will effectively start breaching our guideline of "should not obtain data from undocumented or reverse-engineered API endpoints". I thought it'd be good to somehow reflect "we know this is not right and not an example to follow for new badges".
  • the downloads badge actually uses both /info and /stats, the former for the dt variant, the latter for the dy, dm, dw, and dd variants. They're part of the same example, to be precise we'd have to highlight the difference in the documentation text, making it a little less straightforward to grasp for users.

I don't feel too strongly though, so happy to go down the other route if you think it's preferable.

chris48s
chris48s approved these changes Feb 13, 2022
View reviewed changes
Copy link
Member

@chris48s chris48s left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds reasonable

@PyvesB PyvesB merged commit a1885cd into badges:master Feb 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chris48s chris48s chris48s approved these changes

@calebcartwright calebcartwright calebcartwright approved these changes

Assignees
No one assigned
Labels
service-badge Accepted and actionable changes, features, and bugs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

wordpress downloads service tests failing
5 participants
@PyvesB @shields-ci @chris48s @calebcartwright @shields-cd