github.com/apremalal/vamps-core@v1.0.1-0.20161221121535-d430b56ec174/server/webapps/apieditor/spec-files/guide.yaml (about)

     1  # Example YAML to get you started quickly.
     2  # Be aware that YAML has indentation based scoping.
     3  # Code completion support is available so start typing for available options.
     4  swagger: '2.0'
     5  
     6  # This is your document metadata
     7  info:
     8    version: "0.0.0"
     9    title: <enter your title>
    10  
    11  # Describe your paths here
    12  paths:
    13    # This is a path endpoint. Change it.
    14    /persons:
    15      # This is a HTTP operation
    16      get:
    17        # Describe this verb here. Note: you can use markdown
    18        description: |
    19          Gets `Person` objects.
    20          Optional query param of **size** determines
    21          size of returned array
    22        # This is array of GET operation parameters:
    23        parameters:
    24          # An example parameter that is in query and is required
    25          -
    26            name: size
    27            in: query
    28            description: Size of array
    29            required: true
    30            type: number
    31            format: double
    32        # Expected responses for this operation:
    33        responses:
    34          # Response code
    35          200:
    36            description: Successful response
    37            # A schema describing your response object.
    38            # Use JSON Schema format
    39            schema:
    40              title: ArrayOfPersons
    41              type: array
    42              items:
    43                title: Person
    44                type: object
    45                properties:
    46                  name:
    47                    type: string
    48                  single:
    49                    type: boolean