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: include enum options for array values in OpenAPI spec #818

Merged
merged 1 commit into from
Feb 29, 2024

Conversation

nathanaelhoun
Copy link
Contributor

The enum values for an array query parameter are correctly identified in the Scribe documentation, but are not shown in the generated OpenAPI document.

This PR adds to the enum values for the array query parameter in the OpenAPI document.

Before / After OpenAPI document

Before

     parameters:
       -
         in: query
         name: type
         description: 'Filtre sur le type'
         example:
           - fichier
         required: false
         schema:
           type: array
           description: 'Filtre sur le type'
           example:
             - fichier
           items:
             type: string

After

 parameters:
        -
          in: query
          name: type
          description: 'Filtre sur le type'
          example:
            - fichier
          required: false
          schema:
            type: array
            description: 'Filtre sur le type'
            example:
              - fichier
            items:
              type: string
              enum:
                - app
                - app_inst
                - bdd
                - fichier
                - rpa
                - monarch

@shalvah shalvah merged commit 60d6f82 into knuckleswtf:master Feb 29, 2024
6 checks passed
@nathanaelhoun nathanaelhoun deleted the patch-1 branch March 1, 2024 06:43
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.

2 participants