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.

Sign up for GitHub

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

Jump to bottom

Docs won't finish loading? #209

Closed
Kamil1 opened this issue Feb 19, 2017 · 1 comment
Closed

Docs won't finish loading? #209

Kamil1 opened this issue Feb 19, 2017 · 1 comment

Comments

@Kamil1
Copy link

Kamil1 commented Feb 19, 2017 •
edited
Loading

I've decided to try out ReDoc (it looks great!), and have my api.yaml spec done.

I created an index page using the template provided in the README, below:

<!DOCTYPE html>
<html>
  <head>
    <title>ReDoc</title>
    <!-- needed for adaptive design -->
    <meta name="viewport" content="width=device-width, initial-scale=1">

    <!--
    ReDoc doesn't change outer page styles
    -->
    <style>
      body {
        margin: 0;
        padding: 0;
      }
    </style>
  </head>
  <body>
    <redoc spec-url='https://site/api.yaml'></redoc>
    <script src="https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js"> </script>
  </body>
</html>

For some reason... the page won't load. It seems to be "Loading" forever...

Is this a bug, or am I doing something wrong?
@RomanHotsiy
Copy link
Member

@Kamil1 you have an issue in your spec: 400 response for /feed endpoint is indented not correctly.
You have:

400:
    headers:
        Content-Type:
            description: application/json
            type: string
        description: |
            Bad Request response may occur if before and/or after parameters are
            incorrectly used.
        schema:
            response:
                - $ref: '#/definitions/HTTPCode'

while it should be

400:
    headers:
        Content-Type:
            description: application/json
            type: string
    description: |
        Bad Request response may occur if before and/or after parameters are
        incorrectly used.
    schema:
        response:
            - $ref: '#/definitions/HTTPCode'

But this is an issue that ReDoc is not showing an error and just hangs. It will be tracked in #208

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@RomanHotsiy @Kamil1