Contents

user:
  type: "api"
  path: "user"
  sample: "https://localhost:3000/api/user"
  description: "Returns information about yourself."
  status: updated

  fields:
    name: 
      description: "The user's name"
      type: "String"
    first_name: 
      description: "The user's first name"
      type: "String"
      status: added
    last_name: 
      description: "The user's last name"
      type: "String"
      status: added
    created_at: 
      description: "The user's creation timestamp"
      type: "Number"
      status: updated

  actions:
    bookmarks:
      path: "user/bookmarks" 
      method: GET
      status: added
      description: "Gets a list of user's bookmark."
      sample: "http://localhost:3000/user/bookmarks"
      fields: 
        results: 
          description: "List of user's bookmarks"
          type: "Array"
          array_type: "Bookmark"

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
platform-3.1.1	test/dummy/config/platform/api/1/user.yml