Skip to content

Common RAML Types, Traits, Libraries and other stuff

Notifications You must be signed in to change notification settings

paysera/lib-raml-common

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 

Repository files navigation

lib-raml-common

A set of common RAML Types, Traits and other stuff.

Usage

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