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

chore: remove phoenix_swagger #912

Merged
merged 6 commits into from
Sep 25, 2022
Merged

chore: remove phoenix_swagger #912

merged 6 commits into from
Sep 25, 2022

Conversation

jyeshe
Copy link
Member

@jyeshe jyeshe commented Sep 23, 2022

What

  • Removes phoenix_swagger lib

Why

  • Latest riverside requires poison 5.0 and phoenix_swagger up to 3.0.
  • phoenix_swagger is not used anymore to generate swagger files, only to render the Swagger UI

@jyeshe
Copy link
Member Author

jyeshe commented Sep 23, 2022

@thepiwo @sborrazas a PR for the phoenix_swagger was submitted. If preferred for some reason to avoid the static assets there is also this option:

ae_mdw/mix.exs

Line 143 in e81a2b6

git: "https://github.com/jyeshe/phoenix_swagger.git", branch: "bump-poison"},
(to be removed if the static assets are merged)

@jyeshe jyeshe self-assigned this Sep 23, 2022
@jyeshe jyeshe marked this pull request as draft September 23, 2022 02:40
@jyeshe
Copy link
Member Author

jyeshe commented Sep 23, 2022

Drafting to solve existing issue of: https://mainnet.aeternity.io/mdw/swagger

@jyeshe jyeshe marked this pull request as ready for review September 23, 2022 09:25
@jyeshe
Copy link
Member Author

jyeshe commented Sep 23, 2022

Drafting to solve existing issue of: https://mainnet.aeternity.io/mdw/swagger

Prefixed the /mdw when not present on the forwarding path (currently applies to dev, test and prod and after reorganizing the prod we might remove from dev and test).

@jyeshe jyeshe requested review from sborrazas and thepiwo and removed request for sborrazas and thepiwo September 23, 2022 09:28
Copy link
Collaborator

@thepiwo thepiwo left a comment

Choose a reason for hiding this comment

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

do we really need to serve the swagger UI? as long as we expose the definitions any hosted UI can be used right? Maybe we can include an example for that in the docs

@jyeshe jyeshe requested a review from thepiwo September 23, 2022 23:32
@jyeshe
Copy link
Member Author

jyeshe commented Sep 23, 2022

do we really need to serve the swagger UI? as long as we expose the definitions any hosted UI can be used right? Maybe we can include an example for that in the docs

Done (cc @sborrazas)

@jyeshe jyeshe merged commit 05ece6c into master Sep 25, 2022
@jyeshe jyeshe deleted the remove-phoenix-swagger branch September 25, 2022 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants