[FOLIO-1912] Aggregate metadata about RAMLs configuration from all RAML-based repos Created: 26/Mar/19  Updated: 01/Sep/22  Resolved: 01/Sep/22

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: New Feature Priority: P3
Reporter: David Crossley Assignee: David Crossley
Resolution: Duplicate Votes: 0
Labels: raml
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Blocks
blocks FOLIO-1913 Provide cross-references to API docs ... Open
blocks FOLIO-1316 Provide cross-references to API docs ... Closed
is blocked by FOLIO-1911 Enhance generate-api-docs to record m... Open
Duplicate
is duplicated by FOLIO-2922 Automate the configuration of API doc... Closed
Sprint:
Development Team: FOLIO DevOps

 Description   

The dev.folio.org website Jekyll Liquid code that generates the "Reference API documentation" tables needs to be efficient, so requires a pre-prepared up-to-date data file.

Currently it uses the manually maintained api.yml data file.

As explained in FOLIO-1911 Open , the generate-api-docs CI job assembles and deploys a summary metadata file to AWS S3 for that particular raml-based repository.

Add a new Jenkins automation job, to regularly gather the metadata file for each repository, and then consolidate it into one single file.

Publish this file so that it is available for Jekyll.

Ideally it would be committed to the dev website source repository "_data" directory, where it can be automatically utilised by Jekyll Liquid.

Otherwise it can be deployed to the top-level API docs space on AWS S3. Then an additional facility would be required by our Jekyll to retrieve that data file, at website generation time. This would require developing a Jekyll plugin for custom Liquid Tags (a small Ruby script).

Acceptance criteria:
The aggregated metadata file is published.

Update: 2022-09-01 This is now handled by FOLIO-2922 Closed


Generated at Thu Feb 08 23:16:48 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.