You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The FOLIO modules are moving away from using the RAML directory plus JSON schema files to document their schemas using Swagger instead. Swagger APIs can be defined using schema files in either JSON or YAML. We will need to be able to handle new Swagger related paths from which to retrieve schema files, as well as to add support for converting YAML to JSON schemas.
Context:
Our fork of FOLIO GraphQL synchronizes with the schema files from upstream FOLIO's modules by providing a mechanism for copying over JSON files from cloned upstream FOLIO modules and then using those files to generate the FOLIO GraphQL schema. (See https://github.com/sul-dlss/folio-graphql/?tab=readme-ov-file#architecture) . The commands referenced in https://github.com/sul-dlss/folio-graphql/blob/main/json-schemas/README.md assume a particular directory structure with a RAML directory at the top level with JSON files within that directory.
The FOLIO modules are moving away from using the RAML directory plus JSON schema files to document their schemas using Swagger instead. Swagger APIs can be defined using schema files in either JSON or YAML. We will need to be able to handle new Swagger related paths from which to retrieve schema files, as well as to add support for converting YAML to JSON schemas.
Example:
mod-entities-links is an example of a module that uses Swagger API instead of RAMLS.
References: https://github.com/folio-org/mod-entities-links/tree/master/src/main/resources/swagger.api . As you can see, the path for the schemas has changed. The authority schema is now in YAML: https://github.com/folio-org/mod-entities-links/blob/master/src/main/resources/swagger.api/schemas/authority-storage/authorityDto.yaml . Compare to the authority schema in JSON in a previous version of mod-inventory-storage (from where the authority classes were moved out and into mod-entities-links): https://github.com/folio-org/mod-inventory-storage/blob/v26.0.0/ramls/authorities/authority.json
Similarly https://github.com/folio-org/mod-inventory-storage/blob/v26.0.0/ramls/authorities/authorities.json seems to correspond to https://github.com/folio-org/mod-entities-links/blob/master/src/main/resources/swagger.api/schemas/authority-storage/authorityDtoCollection.yaml .
We reviewed this module while working on #169
To Dos:
The text was updated successfully, but these errors were encountered: