Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Add Example Value for 'page' Parameter and Clarify Handling of Empty 'page' Values

Abierto
  • ¿Algo no está bien?
#7,015 1 comentario 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 1 día

@soyuka ya está trabajando en esto.

Desde el 13/5/2025.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

OpenAPI

Description

Currently, the page query parameter in API Platform OpenAPI documentation is defined with a default value of 1 but lacks an example value. This absence can lead to issues with tools like ApiDog, which may import and activate the page parameter without an example.

Image

Resulting in requests such as: url.org?page= by default after import.

Such requests cause failures ‘Page should not be less than 1‘ due to the empty page parameter.

Proposed Solution

1. Add an Example Value to the page Parameter

To align with the OpenAPI specification and improve compatibility with tools that consume OpenAPI, it is recommended to add an example value of 1 to the page parameter. This can be achieved by modifying the parameter definition as follows:

$parameters[] = new Parameter(
    $this->paginationOptions->getPaginationPageParameterName(),
    'query',
    'The collection page number',
    false,
    false,
    true,
    ['type' => 'integer', 'default' => 1],
    example: 1
);
2. Define Behavior for Empty page Parameter Values

Clarify how API Platform should handle cases where the page parameter is provided with an empty value. There are two potential approaches:

  • Fallback to Default: Treat an empty page value as if the default value (1) was provided.
  • Return Bad Request (current behavior): Respond with a 400 Bad Request status, indicating that the page parameter should not be empty.

I am open to working on a PR to implement this change if the proposal is accepted.

Lenguaje dominante
PHP
Estrellas
2.6k
Forks
989
Merge medio
1 d 22 h
PR fusionados (30 d)
100

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de api-platform/core

Todos los issues de api-platform/core

Issues similares

Más issues de PHP

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.