Details
-
Task
-
Status: Closed (View Workflow)
-
P2
-
Resolution: Done
-
-
DevOps Sprint 108
-
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
-
MSEARCH-51 Generate static OpenAPI doc page
-
- Closed
-
- relates to
-
FOLIO-2898 Create folio-tools/api-doc, from RAML or OpenAPI source files
-
- Closed
-
-
FOLIO-3018 Utilise the new configuration data to display dev.f.o/reference/api
-
- Closed
-
-
FOLIO-3028 Temporary display of build-generated API docs dev.f.o/reference/api
-
- Closed
-
-
FOLIO-2922 Automate the configuration of API documentation
-
- Closed
-