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

Enums values for nested objects in a Swagger schema #193

Open
regel opened this issue Oct 18, 2019 · 0 comments
Open

Enums values for nested objects in a Swagger schema #193

regel opened this issue Oct 18, 2019 · 0 comments

Comments

@regel
Copy link

regel commented Oct 18, 2019

Enums values for nested objects in a Swagger schema are not visible in the HTML files produced by Spectacle.

Swagger schema example:

definitions:
  Addr:
    type: object
    properties:
      remarks:
        description: >-
          Additional remarks to return partial or exact match information
        type: object
        properties:
          street:
            description: >-
              Partial match information for street field
            type: string
            enum:
              - 'exact_match'
              - 'did not match exactly'

The valid enum values "exact_match" and "did not match exactly" are not documented in the HTML file.

Environment:

2019-10-18 latest Docker image:

Digest: sha256:d1b38c1c5d557fbf635d38cf2c1d847d759ea3d991c0f93d57ef64c0a098d0d8
Status: Downloaded newer image for sourcey/spectacle:latest
docker.io/sourcey/spectacle:latest
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

No branches or pull requests

1 participant