api-flow/resources/raml/resource-example.yml

A flow written in ES6 using Immutable to convert between API description formats (Swagger, etc.) and other programs such as cURL command lines.

#%RAML 0.8
title: GitHub API
version: v3
baseUri: https://api.github.com
securitySchemes:
  - basic:
      type: Basic Authentication
  - digest:
      type: Digest Authentication
  - oauth_1_0:
      type: OAuth 1.0
      settings:
        authorizationUri: https://www.box.com/api/oauth1/authorize
        requestTokenUri: https://www.box.com/api/oauth1/authorize
        tokenCredentialsUri: https://www.box.com/api/oauth1/authorize
  - oauth_2_0:
      description: |
        The Box API uses OAuth 2 for authentication. An authorization header containing
        a valid access_token must be included in every request.
      type: OAuth 2.0
      describedBy:
        headers:
          Authorization:
            description: |
              Used to send a valid OAuth 2 access token. Do not use together with
              the "access_token" query string parameter.
            type: string
        queryParameters:
          access_token:
            description: |
              Used to send a valid OAuth 2 access token. Do not use together with
              the "Authorization" header
            type: string
      settings:
        authorizationUri: https://www.box.com/api/oauth2/authorize
        accessTokenUri: https://www.box.com/api/oauth2/token
        authorizationGrants: [ code, token ]
/user:
/users:
  /{userId}:
    uriParameters:
      userId:
        type: integer
    /followers:
    /following:
    /keys:
      /{keyId}:
        uriParameters:
          keyId:
            type: integer