swagger-blocks-example.rb

class AutocompleteControllerDoc
  include Swagger::Blocks

  swagger_path '/autocomplete.json' do
    operation :get,
              summary: 'Fetches autocompletes on Cards titles and tags',
              description: 'Returns nearest completions for words in card titles and tags,'\
                            ' respects card restrictions and privacy rules',
              tags: ['autocomple'] do

      # predefined and preregistered params          
      parameter :page
      extend SearchParams

      extend SwaggerResponses::NotAuthorized
                
      response 200, description: 'Autocomplete results' do
        schema do
          property :data, required: [:cards_words, :tags, :authors, :types] do
            array :cards_words, :string
            array :tags, :string
            array :types, :string, enum: Card::TYPES
            array :authors, :UserShort
          end
        end
      end
    end
  end

end