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

Swagger corrections #1465

Merged
merged 1 commit into from
Sep 27, 2023
Merged

Swagger corrections #1465

merged 1 commit into from
Sep 27, 2023

Conversation

kalbfled
Copy link
Member

@kalbfled kalbfled commented Sep 27, 2023

Description

Correct the v2 and v3 Swagger examples for POST e-mail notifications to show "email_address" instead of "email". The former is the actual attribute name. Also correct invalid uses of the "format" specification for strings. There is no associated ticket.

Type of change

Please check the relevant option(s).

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Documentation changes only

Additional Information

There is no "phone_number", "url", "base64", or "auth type" formatter. The e-mail address formatter is "email"; not "email_address". The datetime formatter is "date-time"; not "datetime".

How Has This Been Tested?

I pasted the OpenAPI document into Swagger Editor and manually inspected them.

Checklist

  • I have assigned myself to this PR
  • PR has an appropriate title: #9999 - What the thing does
  • PR has a detailed description, including links to specific documentation
  • I have added the appropriate labels to the PR.
  • I did not remove any parts of the template, such as checkboxes even if they are not used
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to any documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have ensured the latest master is merged into my branch and all checks are green prior to review
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • The ticket is now moved into the DEV test column

… "email_address" instead of "email" Also correct invalid uses of the "format" specification for strings.
@kalbfled kalbfled self-assigned this Sep 27, 2023
@kalbfled kalbfled requested a review from a team as a code owner September 27, 2023 14:39
Copy link

@babyjunior56 babyjunior56 left a comment

Choose a reason for hiding this comment

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

LGTM

@kalbfled kalbfled merged commit 39634f5 into master Sep 27, 2023
@kalbfled kalbfled deleted the swagger-correction branch September 27, 2023 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants