Uploaded image for project: 'FOLIO'
  1. FOLIO
  2. FOLIO-2898

Create folio-tools/api-doc, from RAML or OpenAPI source files

    XMLWordPrintable

Details

    • DevOps Sprint 106, DevOps: Sprint 104, DevOps: Sprint 105, DevOps Sprint 107, DevOps Sprint 108, DevOps Sprint 109
    • FOLIO DevOps

    Description

      Develop an application to discover and process API description files (RAML or OpenAPI OAS) in a module repository, and generate standalone API documentation.

      The generated documentation would be published by CI and integrated to the "API documentation" at https://dev.folio.org/reference/api/

      For OAS, use https://github.com/Redocly/redoc

      For RAML, use https://github.com/raml2html/raml2html (i.e. as currently used for folio-tools/generate-api-docs)

      The application would be able to be run locally, and during CI on merge to main branch. And on finalising a release.

      TestRail: Results

        Attachments

          Issue Links

            Activity

              People

                dcrossley David Crossley
                dcrossley David Crossley
                Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  TestRail: Runs

                    TestRail: Cases