Obtener las páginas
API operation: Open the endpoint in Scalar
Usa GET /pages para listar las páginas del proyecto. La operación pública actual es Page.findAll.
Un usuario no autenticado recibe solo las páginas que sean enabled y public. Un usuario autenticado que no sea administrador puede listar las páginas habilitadas, mientras que un administrador puede listar páginas sin importar esos valores. Esto corrige la redacción contradictoria del archivo.
Consulta Modelo de páginas.
Referencia de OpenAPI
Operación: GET /pages
Parámetros de consulta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
params | string | No | Lista de campos separados por comas. La lista se cruza con $fillable del modelo; si está vacía o no es válida, se devuelven todos los campos. |
orderBy | string | No | Campo de ordenamiento, con - como prefijo para indicar orden descendente. Se pueden encadenar varios campos separados por comas. |
where | string | No | Filtro en JSON sobre los campos que el modelo declara como filtrables. Los campos válidos de cada recurso se exponen en la extensión de schema x-ordering-whereable. |
page | integer | No | Número de página, empezando en 1. Solo se aplica a las listas que devuelven un bloque de paginación. |
page_size | integer | No | Cantidad de elementos por página. |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta exitosa. El contenido de result varía según la operación y se devuelve como JSON. |
| 400 | Respuesta de error (error=true). Los errores de validación y de negocio comparten este código. |
| 401 | Envelope de error: el proyecto no existe o no tiene una suscripción activa. |
| 404 | Respuesta vacía: la versión de API solicitada no está admitida. |
| 429 | Envelope de error: se excedió un límite de consumo del proyecto (o el sujeto está baneado). Lleva Retry-After y X-RateLimit-Limit/Remaining/Reset/Scope/Key. |
| 500 | Respuesta de error: falló la búsqueda o inicialización del proyecto. |
| 503 | Envelope de error: la aplicación está temporalmente en mantenimiento. Envelope de error: el proyecto está temporalmente en mantenimiento, o los límites de consumo no se pudieron evaluar y el límite aplicable está configurado con on_error = closed (cabecera Retry-After: 1). |