Module: API::PaginationParams

Extended by:

ActiveSupport::Concern

Included in:

AccessRequests, Admin::BroadcastMessages, Admin::Ci::Variables, Admin::InstanceClusters, AwardEmoji, Badges, Boards, Branches, BulkImports, Ci::JobArtifacts, Ci::Jobs, Ci::PipelineSchedules, Ci::Pipelines, Ci::ResourceGroups, Ci::Runners, Ci::SecureFiles, Ci::Triggers, Ci::Variables, Clusters::AgentTokens, Clusters::Agents, Commits, DeployKeys, DeployTokens, Deployments, Discussions, Environments, Events, FeatureFlags, FeatureFlagsUserLists, FreezePeriods, GroupBoards, GroupClusters, GroupContainerRepositories, GroupLabels, GroupMilestones, GroupPackages, GroupVariables, Groups, Hooks::Events, Invitations, IssueLinks, Issues, Labels, MarkdownUploads, Members, MergeRequestDiffs, MergeRequests, Namespaces, Notes, OfflineTransfers, PackageFiles, PagesDomains, PersonalAccessTokens, API::PersonalAccessTokens::SelfInformation, ProjectClusters, ProjectContainerRepositories, ProjectEvents, ProjectHooks, ProjectImport, ProjectJobTokenScope, ProjectMilestones, ProjectPackages, ProjectRepositoryStorageMoves, ProjectSnippets, ProjectTemplates, Projects, ProtectedBranches, ProtectedTags, Release::Links, Releases, RemoteMirrors, Repositories, ResourceAccessTokens, ResourceLabelEvents, ResourceMilestoneEvents, ResourceStateEvents, Search, SnippetRepositoryStorageMoves, Snippets, SupplyChain::Attestations, SystemHooks, Tags, Templates, Todos, Topics, Unleash, Users

Defined in:

lib/api/pagination_params.rb

Overview

Concern for declare pagination params.

Examples:

class CustomApiResource < Grape::API::Instance
  include PaginationParams

  params do
    use :pagination
  end
end