coala webservices raml

webservices.raml.yaml

#%RAML 1.0

title: coala webservices
version: v1
protocols: [ HTTP, HTTPS ]
baseUri: http://webservices.coala.io
mediaType: application/json

types:
    Bear:
        type: object
        properties:
            ASCIINEMA_URL: string
            AUTHORS: string[]
            AUTHORS_EMAILS: string[]
            BEAR_DEPS: string[]
            CAN_DETECT: string[]
            CAN_FIX: string[]
            INCLUDE_LOCAL_FILES: string[]
            LANGUAGES: string[]
            LICENSE: string
            MAINTAINERS: string[]
            MAINTAINERS_EMAILS: string[]
            PLATFORMS: string[]
            can_detect: string[]
            data_dir: string
            maintainers: string[]
            maintainers_emails: string[]
            metadata: BearMetaData
            name: string
    BearInfo:
        type: object
        properties:
            desc: string
            languages: string[]
    BearMetaData:
        type: object
        properties:
            desc: string
            non_optional_params: string[]
            optional_params: string[]

/list:
    /bears:
        get:
            responses:
                200:
                    body:
                        application/json:
                            type: BearInfo


/search:
    /bears:
        get:
            responses:
                200:
                    body:
                        application/json:
                            type: Bear
            queryParameters:
                bear:
                    type: string
                    required: true