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.

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

migrate examples to openApi part 7; affects [reuse sourceforge sourcegraph spack stackexchange testspace treeware twitch] #9464

Merged
merged 2 commits into from
Sep 4, 2023

Conversation

chris48s
Copy link
Member

Refs #9285

..and so begins the long slow process of working through these. The first batch I am working on is classes with:

  • currently passing service tests
  • only path params
  • either one example, or two examples due to optional path params (e.g: branch*)
  • no documentation string

These are the most trivial services to convert, requiring the least manual work.
I am going to submit PRs touching batches of about 15-20 files at a time as I work through these.
Then I'll start moving onto slightly more complicated cases.

@chris48s chris48s added service-badge New or updated service badge documentation Developer and end-user documentation labels Aug 11, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Aug 11, 2023

Warnings
⚠️ This PR modified service code for reuse but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for sourceforge but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for sourcegraph but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for spack but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for stackexchange but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for testspace but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for treeware but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for twitch but not its test code.
That's okay so long as it's refactoring existing code.
Messages
📖 ✨ Thanks for your contribution to Shields, @chris48s!

Generated by 🚫 dangerJS against 12a2092

PyvesB
PyvesB previously approved these changes Sep 2, 2023
Copy link
Member

@PyvesB PyvesB left a comment

Choose a reason for hiding this comment

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

Looks good to me!

static openApi = {
'/sourceforge/commit-count/{project}': {
get: {
summary: 'SourceForge commit count',
Copy link
Member

Choose a reason for hiding this comment

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

Nit: we seem to prefer capitalising all words within the badge title, even though we're not consistent across the board. We should probably agree on one or the other. In this particular instance, there's inconsistency within different SourceForge badges themselves, so maybe we could at least fix these? Feel free to dismiss if you don't want to do this now, after all this inconsistency was already present before.

@chris48s chris48s merged commit 0bc5127 into badges:master Sep 4, 2023
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Developer and end-user documentation service-badge New or updated service badge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants