sample.yml

name: 'Calamum Rest Api'
url: 'http://calamum-sample:3000/api'
version: '1.0'
description: 'Calamum is a simple ruby build program to generate a REST API documentation from a YAML file definition'
resources:
    user:   
     -
      uri: '/users'
      action: 'get'
      authentication: 'false'
      headers:
        content_type: 'application/json'
      description: 'Get the users list'
      response: {"users":[{"id":"12354","name":"test", "mail":"test@test.com"}, {"id":"123789","name":"test2", "mail":"test@test.com"}]}
     -
      uri: '/users/:id'
      action: 'get'
      authentication: 'false'
      headers:
        content_type: 'application/json'
        content_language: 'en-US'
      params:
        id: 
          type: 'String'
          description: 'User id'
          required: true
      description: 'get the user'
      response: {"user": {"name": "test", "mail": "test@test.com"}}

     -
      uri: '/users'
      action: 'post'
      description: 'Create a new user'
      authentication: 'false'
      headers:
        content_type: 'application/json'
        content_language: 'en-US'
      params:
        id: 
          type: 'String'
          description: 'User id'
          required: true
        name:
          type: 'String'
          description: 'User name'
          required: false
        email:
          type: 'String'
          description: 'User email'
          required: true
     -
      uri: '/users/:id'
      action: 'put'
      description: 'Update the user'
      headers:
        content_type: 'application/json'
        content_language: 'en-US'
      params:
        id: 
          type: 'String'
          description: 'User id'
          required: true
        name:
          type: 'String'
          description: 'User name'
          required: false
        email:
          type: 'String'
          description: 'User email'
          required: true
     -
      uri: '/users/:id'
      action: 'delete'
      description: 'Delete the user'
      headers:
        content_type: 'application/json'
        content_language: 'en-US'
      params:
        id: 
          type: 'String'
          description: 'User id'
          required: true
    group:
     -
      uri: '/groups'
      action: 'get'
      headers:
        content_type: 'application/json'
      description: 'Get the list of groups'