[FOLIO-2855] Amend generate-api-docs CI job to use dereferenced parent JSON Schemas Created: 27/Oct/20  Updated: 04/Nov/20  Resolved: 04/Nov/20

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

Type: Task Priority: P3
Reporter: David Crossley Assignee: David Crossley
Resolution: Done Votes: 0
Labels: devdoc, raml
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Sprint: DevOps: Sprint 101, DevOps: Sprint 100
Development Team: FOLIO DevOps

 Description   

Many JSON Schemas use "$ref" to refer to child JSON Schema. When the API docs are generated from the RAML, then the presentation does not show the child schema.

Amend the folio-tools/generate-api-docs job to dereference and expand each parent schema that is declared as "types" in each RAML file. Use those when running the generate-api-docs job.



 Comments   
Comment by David Crossley [ 04/Nov/20 ]

This is now in operation.

Each module's docs will be fixed when next they do a merge to their mainline branch.

See the Okapi API documentation, for example the complete expanded ModuleDescriptor schema.

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