Redocly / Redocly/redocly-cli

is pagination not possible any more?

Open
#2,531 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Bug
Dominant language
TypeScript
Stars
1.5k
Forks
228
Avg merge
1d 14h
Merged PRs (30d)
48

Description

Describe the bug

pagination does not seem to be possible in redoc anymore

im following the instructions at https://redocly.com/docs-legacy/api-reference-docs/configuration/functionality but it doesnt do anything

To Reproduce

this syntax:

  rest-v1:
    root: rest/v1/openapi/api_v1.yaml
    openapi:
      htmlTemplate: redoc_template/index.php
      theme:
        pagination: item

results in:

[1] redocly.yaml:8:9 at #/apis/rest-v1/openapi/theme/pagination

Property `pagination` is not expected here.

Warning was generated by the configuration struct rule.

and this syntax:

  rest-v1:
    root: rest/v1/openapi/api_v1.yaml
    openapi:
      htmlTemplate: redoc_template/index.php
      pagination: item

doesnt cause an error in validation, but also does not work on the generated output

Expected behavior

pagination should work

Logs

n/a

OpenAPI description

openapi: 3.1.0

Redocly version(s)

2.14.3 and also 2.15.1

Node.js version(s)

node v23.7.0
npm 10.9.2

OS, environment

MacOS Tahoe 26.2 (25C56)

Additional context

i know redoc has lately made tonnes of changes around the openapi property & theme support

it would be nice if the docs kept up :'(

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the redocly.yaml examples and the legacy pagination documentation linked in the issue, then compare both configuration forms with the generated output from redoc_template/index.php. Check how the OpenAPI 3.1 API definition at rest/v1/openapi/api_v1.yaml is processed in Redocly CLI 2.15.1. Done means the supported pagination configuration is clear, validates, and affects the generated documentation, or the documentation explains that pagination is no longer supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript
Domain
documentation, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.