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 some services from examples to openApi part 44; affects [sonar] #9919

Merged
merged 3 commits into from
Feb 5, 2024

Conversation

chris48s
Copy link
Member

Refs #9285

Made a start on this service family. Submitting a WIP PR for now, just to lick the cookie. I'll finish it later in the week.

@chris48s chris48s added service-badge New or updated service badge documentation Developer and end-user documentation labels Jan 22, 2024
@chris48s chris48s changed the title WIP migrate some services from examples to openApi part 42; affects [sonar] WIP migrate some services from examples to openApi part 44; affects [sonar] Jan 22, 2024
Copy link
Contributor

github-actions bot commented Jan 22, 2024

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

Generated by 🚫 dangerJS against 36c76e9

@chris48s
Copy link
Member Author

I've tried to provide working examples for as many of these as possible, but there are a couple of these where I couldn't find any working example - in those cases, the tests are already mocks so I can't grab one from there and I wasn't able to find any examples in public repos on github. I've just left those with plausible but non-working values.

@chris48s chris48s changed the title WIP migrate some services from examples to openApi part 44; affects [sonar] migrate some services from examples to openApi part 44; affects [sonar] Jan 27, 2024
@chris48s chris48s marked this pull request as ready for review January 27, 2024 10:18
component: 'swellaby:azdo-shellcheck',
metric: 'quality_gate',
branch: 'master',
static openApi = {
Copy link
Member

Choose a reason for hiding this comment

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

Should there be an alert_status example?

component: 'org.ow2.petals:petals-se-ase',
metric: 'tech_debt',
branch: 'master',
static openApi = {
Copy link
Member

Choose a reason for hiding this comment

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

Should there be a sqale_debt_ratio example?

@chris48s
Copy link
Member Author

chris48s commented Feb 4, 2024

In both the cases you've flagged the metric param doesn't really do anything - we show the same value either way. I think this is a case where we changed the route at some point in the past and the enum is there to keep the old name working but we only document the new one.

@PyvesB
Copy link
Member

PyvesB commented Feb 4, 2024

Okay, I guess we could implement a route redirector at some point instead!

@chris48s
Copy link
Member Author

chris48s commented Feb 5, 2024

There are one or two other services where we do something like this. Here's another example that springs to mind:

static route = {
base: 'vaadin-directory',
pattern: ':alias(v|version)/:packageName',
}
static openApi = {
'/vaadin-directory/v/{packageName}': {
get: {

I don't really have strong views about replacing with a redirect, but maybe that pattern of calling the param :alias makes it clearer?

@chris48s chris48s added this pull request to the merge queue Feb 5, 2024
Merged via the queue into badges:master with commit 39ec093 Feb 5, 2024
24 checks passed
@chris48s chris48s deleted the 9285-part44 branch February 5, 2024 11:07
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