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

Upgrade swagger and use open api 3.0 #1736

Merged
merged 30 commits into from
May 9, 2018
Merged

Upgrade swagger and use open api 3.0 #1736

merged 30 commits into from
May 9, 2018

Conversation

ssalinas
Copy link
Member

@ssalinas ssalinas commented Feb 23, 2018

This PR is step 1 in reorganizing SingularityBase and making the whole project more usable

  • Adds a large pile of missing documentation
  • Upgrades swagger to 2.x versions which use openapi 3.0 spec
  • serves up the openapi.json via an endpoint rather than compiling markdown into the jar

TODO:

  • finish off annotation and docs updates
  • set up swagger-ui-react to read the openapi.json within the ui

@ssalinas ssalinas changed the title (WIP) upgrade swagger and use open api 3.0 Upgrade swagger and use open api 3.0 Feb 27, 2018
@ssalinas
Copy link
Member Author

/fixes #1444

@ssalinas ssalinas added this to the 0.20.0 milestone Mar 26, 2018
@ssalinas
Copy link
Member Author

ssalinas commented Apr 2, 2018

Filed swagger-api/swagger-core#2740 for the circular reference issue we ran into. Will try to make a PR for that later if I have time

class ApiDocs extends Component {

componentDidMount() {
SwaggerUi({
Copy link
Member Author

Choose a reason for hiding this comment

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

@kwm4385 no rush, but if you get a chance I'm a bit stumped. This works locally when running with gulp serve, pointed against a local singularity or against our staging environment. But, the deployed version doesn't work. Comes back with errors of Expected the reducer to be a function.

@ssalinas ssalinas added the hs_qa label May 4, 2018
@pschoenfelder
Copy link
Contributor

🚢

@ssalinas ssalinas merged commit 67f6475 into master May 9, 2018
@ssalinas ssalinas deleted the swagger_upgrade branch May 9, 2018 18:57
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.

2 participants