Sha256: da4b2172b177d2a4674942f77b51efd13eaedbf175c78953d458af8711b923a1

Contents?: true

Size: 1.26 KB

Versions: 11

Compression:

Stored size: 1.26 KB

Contents

description: The list of members.
requestParameters:
  properties:
    limit:
      type: integer
      required: no
      default: 50
      description: Limits the number of results returned, used for paging.
    offset:
      type: integer
      required: no
      default: 0
      description: Offsets the results returned, used for paging.
    order_by:
      type: string
      enum:
        - name
        - email
        - member_since
responseParameters:
  properties:
    members:
      type: array
      items:
        title: member
        description: Representation of a member
        type: object
        properties:
          name:
            description: Member's name
            type: string
            required: yes
            example: Captain Smellypants
          email:
            description: Member's email
            type: string
            required: no
            example: smelly@pants.com
          member_since:
            description: The date the member joined
            type: string
            format: date-time
            example: 2012-01-01T13:00:00Z
responseCodes:
  - status: 200 OK
    successful: yes
    description: A list of current members
  - status: 400 Bad Request
    successful: no
    description: Indicates malformed parameters

Version data entries

11 entries across 11 versions & 1 rubygems

Version Path
fdoc-0.3.3 spec/fixtures/members/list/GET.fdoc
fdoc-0.3.2 spec/fixtures/members/list/GET.fdoc
fdoc-0.3.1 spec/fixtures/members/list/GET.fdoc
fdoc-0.3.0 spec/fixtures/members/list/GET.fdoc
fdoc-0.2.7 spec/fixtures/members/list/GET.fdoc
fdoc-0.2.6 spec/fixtures/members/list/GET.fdoc
fdoc-0.2.5 spec/fixtures/members/list/GET.fdoc
fdoc-0.2.4 spec/fixtures/members/list/GET.fdoc
fdoc-0.2.3 spec/fixtures/members/list/GET.fdoc
fdoc-0.2.2 spec/fixtures/members/list/GET.fdoc
fdoc-0.2.1 spec/fixtures/members/list/GET.fdoc