Skip to content

CI/CD: Add GitHub Actions Workflow to validate Swagger documentation #2487

@andrewpollock

Description

@andrewpollock

#2485 identified it's possible for the API implementation and Swagger documentation to accidentally become divergent.

It looks like the swagger spec can be generated from the build_swagger.py script. We can make a workflow to run that and check the diff between the generated swagger and the one checked in.

Originally posted by @another-rex in #2486 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    apiAPI-related infrastructurebacklogImportant but currently unprioritizeddocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions