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

fix(api spec): issues/17 local run openapi spec #31

Merged
merged 1 commit into from
Jul 3, 2019

Conversation

cdcabrera
Copy link
Member

What's included

  • fix(api spec): issues/17 local run openapi spec
    • remove local openapi/swagger spec in favor of remote rhsm resource

How to test

Run the OpenApi spec from RHSM

  1. update the NPM packages with $ yarn
  2. $ yarn api:docs, the terminal output should contain
    Success -> rhsm-subscriptions-api-spec.yaml
    You can now view API docs for rhsm-subscriptions-api-spec.yaml in the browser.
        Open: http://localhost:5050/docs/api
    

Run the OpenApi spec from RHSM without wifi/network

  1. after you do a first run with your network enabled you can try the script with disabled network connection
  2. $ yarn api:docs, the terminal output should contain
     Unable to load rhsm-subscriptions-api-spec.yaml -> rhsm.yaml, checking cache...
     Success -> rhsm-subscriptions-api-spec.yaml
     You can now view API docs for rhsm-subscriptions-api-spec.yaml in the browser.
         Open: http://localhost:5050/docs/api
    

Example

...

Updates issue/story

Closes #17

* remove local openapi/swagger spec in favor of remote rhsm resource
@codecov-io
Copy link

Codecov Report

Merging #31 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #31   +/-   ##
=======================================
  Coverage   80.84%   80.84%           
=======================================
  Files          21       21           
  Lines         214      214           
  Branches       46       46           
=======================================
  Hits          173      173           
  Misses         31       31           
  Partials       10       10

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ccb73ae...3bf3376. Read the comment docs.

@cdcabrera cdcabrera merged commit 1aa0bcd into RedHatInsights:master Jul 3, 2019
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.

Apply Swagger UI local display for OpenAPI RHSM spec
2 participants