https://github.com/paysera/lib-raml-common
Common RAML Types, Traits, Libraries and other stuff
https://github.com/paysera/lib-raml-common
raml raml-library
Last synced: 4 months ago
JSON representation
Common RAML Types, Traits, Libraries and other stuff
- Host: GitHub
- URL: https://github.com/paysera/lib-raml-common
- Owner: paysera
- Created: 2018-04-30T14:20:09.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-01-21T14:22:11.000Z (over 4 years ago)
- Last Synced: 2025-01-03T16:37:00.290Z (6 months ago)
- Topics: raml, raml-library
- Language: RAML
- Size: 7.81 KB
- Stars: 2
- Watchers: 9
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# lib-raml-common
A set of common RAML Types, Traits and other stuff.
### Usage
```yaml
uses:
Paysera: https://raw.githubusercontent.com/paysera/lib-raml-common/{version}/rest.raml
```
Replace `{version}` with latest tag.
### Libraries
#### rest.raml
Provides mostly used items when building RESTful APIs
* Types:
* `File` - common used properties for file (name, size, content, mime type).
* `Money` - holds amount ant currency.
* `Result` - used for pagination, holds `items` - list of returned objects. Ofter used together with
* `ResultMetadata` - gives info about `items` count, page number and other pagination related stuff.
* Traits:
* `Filter` - provides SQL-like `Result` filtering.
* Annotation Types
* `datetimeTimestamp` - used to mark `integer` property as DateTime instance
* `enitityType` - used to mark Type recognisable as Entity
* `streamResponse` - used to mark Response recognisable as Stream