An open API service indexing awesome lists of open source software.

https://github.com/folio-org/raml

Repository of RAML files, including JSON schemas, traits and resource types centralized for re-usability
https://github.com/folio-org/raml

Last synced: 12 months ago
JSON representation

Repository of RAML files, including JSON schemas, traits and resource types centralized for re-usability

Awesome Lists containing this project

README

          

# Shared RAML and schema files (raml-util)

Copyright (C) 2016-2023 The Open Library Foundation

This software is distributed under the terms of the Apache License,
Version 2.0. See the file "[LICENSE](LICENSE)" for more information.

## Introduction

Repository of RAML traits and resource type files.

This repository contains traits and resource types that can be re-used
by other projects to limit duplication. It is utilized as a git submodule
in each such repository as its "raml-util" directory.

Trait examples:

- Authorization
- Pagination
- etc.

Resource types:

- Get, Post, Delete, Put, File upload, etc.

This is the master location for the traits and resource types, while each module is the master for its own schemas, examples, and actual RAML files.

## Additional information

The [raml-module-builder](https://github.com/folio-org/raml-module-builder) framework.

Other [modules](https://dev.folio.org/source-code/#server-side).

[API reference documentation](https://dev.folio.org/reference/api/).

See project [RMB](https://issues.folio.org/browse/RMB)
at the [FOLIO issue tracker](https://dev.folio.org/guidelines/issue-tracker).

Other FOLIO Developer documentation is at [dev.folio.org](https://dev.folio.org/)