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

Update Swagger config to new naming #11960

Merged
merged 1 commit into from
Dec 22, 2023
Merged

Update Swagger config to new naming #11960

merged 1 commit into from
Dec 22, 2023

Conversation

mkllnk
Copy link
Member

@mkllnk mkllnk commented Dec 21, 2023

What? Why?

Avoids deprecation warnings:

DEPRECATION WARNING: swagger_root= is deprecated and will be removed from rswag-api 3.0 (use openapi_root= instead) (called from block in <main> at config/initializers/rswag_api.rb:8)
DEPRECATION WARNING: Rswag::Ui: WARNING: The method will be renamed to "openapi_endpoint" in v3.0 (called from block in <main> at config/initializers/rswag_ui.rb:12)
DEPRECATION WARNING: Rswag::Ui: WARNING: The method will be renamed to "openapi_endpoint" in v3.0 (called from block in <main> at config/initializers/rswag_ui.rb:13)

What should we test?

  • No test, specs only.

Release notes

Changelog Category (reviewers may add a label for the release notes):

  • User facing changes
  • API changes (V0, V1, DFC or Webhook)
  • Technical changes only
  • Feature toggled

The title of the pull request will be included in the release notes.

Dependencies

Documentation updates

@mkllnk
Update Swagger config to new naming
82d3199 
Avoids deprecation warnings:

```
DEPRECATION WARNING: swagger_root= is deprecated and will be removed from rswag-api 3.0 (use openapi_root= instead) (called from block in <main> at config/initializers/rswag_api.rb:8)
DEPRECATION WARNING: Rswag::Ui: WARNING: The method will be renamed to "openapi_endpoint" in v3.0 (called from block in <main> at config/initializers/rswag_ui.rb:12)
DEPRECATION WARNING: Rswag::Ui: WARNING: The method will be renamed to "openapi_endpoint" in v3.0 (called from block in <main> at config/initializers/rswag_ui.rb:13)
```
@mkllnk mkllnk added the technical changes only These pull requests do not contain user facing changes and are grouped in release notes label Dec 21, 2023
@mkllnk mkllnk self-assigned this Dec 21, 2023
@mkllnk mkllnk marked this pull request as ready for review December 21, 2023 05:26
rioug
rioug approved these changes Dec 22, 2023
View reviewed changes
Copy link
Collaborator

@rioug rioug left a comment

Choose a reason for hiding this comment

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

Thanks for that, those warning are so annoying :)

@rioug rioug merged commit ffbdb17 into openfoodfoundation:master Dec 22, 2023
52 checks passed
lokeshk88
lokeshk88 reviewed Dec 27, 2023
View reviewed changes
Copy link

@lokeshk88 lokeshk88 left a comment

Choose a reason for hiding this comment

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

Is it working properly on others OS ?

@mkllnk mkllnk deleted the rswag-deprecations branch January 2, 2024 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lokeshk88 lokeshk88 lokeshk88 left review comments

@rioug rioug rioug approved these changes

Assignees

@mkllnk mkllnk

Labels
technical changes only These pull requests do not contain user facing changes and are grouped in release notes
Projects
OFN Delivery board
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@mkllnk @rioug @lokeshk88