[FOLIO-1911] Enhance generate-api-docs to record metadata about "interface" and "version" each RAML file Created: 26/Mar/19  Updated: 03/Jun/20

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

Type: Task Priority: P3
Reporter: David Crossley Assignee: David Crossley
Resolution: Unresolved Votes: 0
Labels: platform-backlog, raml
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Blocks
blocks FOLIO-1912 Aggregate metadata about RAMLs config... Closed
Relates
relates to FOLIO-1767 Ensure that ModuleDescriptor and RAML... Open
relates to FOLIO-1908 Enhance lint-raml to process ModuleDe... Open
Sprint:
Development Team: Core: Platform

 Description   

With the folio-tools/generate-api-docs CI job.
This job runs at the end of a Jenkins pipeline to generate and deploy the API docs from input of each RAML file.

While doing so, it also gathers some metadata about the repository and deploys it to the same space:
e.g. mod-circulation-storage config.json

(This metadata is not yet utilised, but may later be used instead of the manually maintained api.yml data file.)

Also add metadata about the "interface" and "version" to which each RAML file pertains.

Acceptance criteria:
The extra metadata is deployed.


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