Ingest Swagger from private GitHub Repository

matthew.seaborn

The Swagger UI App for Compass allows for a variety of methods of ingesting an OpenAPI definition, as defined in Integrate Compass with Swagger UI .

However it does not appear to support the simple case of a the swagger.yml sitting along side the compass.yml in a private GitHub repository.  The token generated by generating the 'raw' link is only valid for a short period of time, and there is no way to include a personal token in the request from Compass, as defined here.

Is there a way to include a swagger.yml private GitHub repository, especially the same repository that contains the compass.yml file?

IMO ideal method would be to simply be able to have a relative path in compass.yml, for example

links:
  - name: API
    type: OTHER_LINK
    url: ./swagger.yml

 

Katie Silver

Hi again, Matthew! Thanks for your question. 

We're in the process of adding this for Bitbucket, although it's not a super high priority given our other work, so it's going a bit slowly. I've raised a ticket for us to add something similar for Github. Hoping we can get to it in the next couple months!