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

Upload build-generated HTML API docs to S3

    XMLWordPrintable

    Details

    • Template:
    • Sprint:
      DevOps Sprint 108
    • Development Team:
      FOLIO DevOps

      Description

      For mod-search we're using OpenAPI 3.0 as API specification (vs RAML as most of the modules) and we want to upload our API documentation to https://dev.folio.org/reference/api/.

      We're able to generate the API doc during build time, the CI process should pick the page (for now it is target/docs/index.html) and upload it to S3.

      Sample generated page index.html

        TestRail: Results

          Attachments

            Issue Links

            blocks

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MSEARCH-51 Generate static OpenAPI doc page

            • P2 - normal priority level, must be included in the current development cycle
            • Closed
            relates to

            Task - A task that needs to be done. FOLIO-2898 Create folio-tools/api-doc, from RAML or OpenAPI source files

            • TBD - To be determined
            • Closed

            Task - A task that needs to be done. FOLIO-3018 Utilise the new configuration data to display dev.f.o/reference/api

            • TBD - To be determined
            • Closed

            Task - A task that needs to be done. FOLIO-3028 Temporary display of build-generated API docs dev.f.o/reference/api

            • TBD - To be determined
            • Closed

            Task - A task that needs to be done. FOLIO-2922 Automate the configuration of API documentation

            • TBD - To be determined
            • Closed

              Activity

                People

                Assignee:
                dcrossley David Crossley
                Reporter:
                bohdan-suprun Bohdan Suprun
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                  Dates

                  Created:
                  Updated:
                  Resolved:

                    TestRail: Runs

                      TestRail: Cases