Sha256: c736b31231c24739a2cf26116867c22c8b655b614a54e5bc10aa2ea5cb2fcd9b

Contents?: true

Size: 1.48 KB

Versions: 10

Compression:

Stored size: 1.48 KB

Contents

class ApiSpec::Spec

  endpoint 'People Tags' do |tags|

    tags.method('Index') do |method|
      method.synopsis = 'Returns a list of previously used tags'
      method.http_method = 'GET'
      method.uri = '/tags'

      method.parameter('__token') do |p|
        p.required = 'N'
        p.type = 'string'
        p.description = 'pagination token'
      end

      method.parameter('__nonce') do |p|
        p.required = 'N'
        p.type = 'string'
        p.description = 'pagination nonce'
      end

      method.parameter('limit') do |p|
        p.required = 'N'
        p.default = '10'
        p.type = 'int'
        p.description = 'maximum number of results to return'
      end
    end

    tags.method('People') do |method|
      method.synopsis = 'Searches for people with the given tag'
      method.http_method = 'GET'
      method.uri = '/tags/:tag/people'

      method.parameter('tag') do |p|
        p.required = 'Y'
        p.type = 'string'
        p.description = 'the name of the tag'
      end

      method.parameter('__token') do |p|
        p.required = 'N'
        p.type = 'string'
        p.description = 'pagination token'
      end

      method.parameter('__nonce') do |p|
        p.required = 'N'
        p.type = 'string'
        p.description = 'pagination nonce'
      end

      method.parameter('limit') do |p|
        p.required = 'N'
        p.default = '10'
        p.type = 'int'
        p.description = 'maximum number of results to return'
      end
    end
  end
end

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
nationbuilder-rb-1.6.2 lib/api_spec/lib/api_spec/specs/people_tags.rb
nationbuilder-rb-1.6.1 lib/api_spec/lib/api_spec/specs/people_tags.rb
nationbuilder-rb-1.6.0 lib/api_spec/lib/api_spec/specs/people_tags.rb
nationbuilder-rb-1.5.0 lib/api_spec/lib/api_spec/specs/people_tags.rb
nationbuilder-rb-1.4.3 lib/api_spec/lib/api_spec/specs/people_tags.rb
nationbuilder-rb-1.4.2 lib/api_spec/lib/api_spec/specs/people_tags.rb
nationbuilder-rb-1.4.1 lib/api_spec/lib/api_spec/specs/people_tags.rb
nationbuilder-rb-1.3.9 lib/api_spec/lib/api_spec/specs/people_tags.rb
nationbuilder-rb-1.3.7 lib/api_spec/lib/api_spec/specs/people_tags.rb
nationbuilder-rb-1.3.6 lib/api_spec/lib/api_spec/specs/people_tags.rb