seomoz/interpol

View on GitHub
example/definitions/show_address.yml

Summary

Maintainability
Test Coverage
---
name: show_contact_address
route: /contacts/:contact_id/address
method: GET
definitions:
  - versions: ["1.0"]
    schema:
      description: Returns the address information for a contact.
      type: object
      properties:
        street:
          description: "Street address"
          type: string
        city:
          description: "The City"
          type: string
        state:
          description: "The State"
          type: string
        zip:
          description: "Zip code"
          type: string

    examples:
      - street: 1300 Pine St.
        city: Seattle
        state: WA
        zip: '98111'