3468 swagger clean up follow up #1387
Conversation
| @@ -5,7 +5,14 @@ | |||
| get :sha, controller: :heartbeat | |||
| get :reporting, controller: :reporting | |||
|
|
|||
| # NOTE: this has questionable existance. | |||
There was a problem hiding this comment.
do we actually need this?
There was a problem hiding this comment.
I don't think this is needed any more. originally we had an open api spec but no way of presenting it, this was then added to fit that space. However it needed to be gov branded so was not fit for purpose. This is now presented thru the tech docs gem
| # NOTE: this has questionable existance. | ||
| # Why do we need api? | ||
| # When it seems to be a static file server... | ||
| # That only works after `bundle exec rake rswag:specs:swaggerize` |
There was a problem hiding this comment.
if we dont actual use the ui is there away to
bundle exec rake rswag:specs:swaggerize
which uses really just generates swagger/public_v1/api_spec.json
and then server is via /api-docs/public_v1/api_spec.json
There was a problem hiding this comment.
the command needs to be fired at some point to generate the new open api spec if there have been any changes. this could be made as part of the build process
|
the placeholder code is needed as i believe some tests depend on it. you can try deleting and see if the tests still pass |
Context
Changes proposed in this pull request
Guidance to review
Checklist