Skip to content

[Feature]Generate API Docs - OpenAPI Specs #31

Description

Feature Set:

  • GitHub Actions Workflow
    • Set up tooling for Spec to Markdown generation (tool to be determined)
    • Clone our existing repo
    • Retrieve Open API Specs from: https://github.com/Software-Hardware-Integration-Lab/OpenAPI/tree/main/specs
    • Generate markdown
    • Move generated markdown into our folder structure
    • Create PR for human review of the generated docs
    • Run this job automatically (method TBD)
      • Schedule?
      • Event/Webhook/dynamic trigger of some sort when spec gets updates?

Metadata

Metadata

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions