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

Provide cross-references to API docs via endpoint

    XMLWordPrintable

Details

    • New Feature
    • Status: Closed (View Workflow)
    • P3
    • Resolution: Done
    • None
    • DevOps Sprint 146
    • FOLIO DevOps

    Description

      The API docs dev.folio.org/reference/api/ are generated from the RAML and OpenAPI (OAS) description files in each back-end module. This is done via the CI job api-doc.

      There could also be cross-references to those docs.

      That would assist a developer who knows a path URI, to find the responsible module and link directly to the particular API docs.

      Update: 2022-09-12 Done. https://dev.folio.org/reference/api/endpoints/ (See explanation in Jira comment.)

      TestRail: Results

        Attachments

          Issue Links

            Activity

              People

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

                Dates

                  Created:
                  Updated:
                  Resolved:

                  TestRail: Runs

                    TestRail: Cases