Files
NodeBB/public/openapi/components/schemas/Pagination.yaml
Julian Lam ccc6118d30 Testing suite integration for openapi spec (#8263)
* feat: testing suite integration for openapi spec

The testing suite now takes the openapi spec into account. It will
check each route defined, make a call to it, and compare the
response with the defined schema. Any mismatches will cause the
test to fail.

* fix(openapi): removed debug stuff from tests

* fix(openapi): fixed some tests

* fix(openapi): added additional check to tests, test fixes

* fix(openapi): better tests, fixed spec errors

* fix(openapi): bad conditional in test

* fix: oops

* fix(openapi): more tests fixing

* fix(openapi): more tests

* fix(openapi): fix some more tests

* fix: verbose'd an info log

* fix: topic pagination route returns schema-optimized pagination block

* fix(openapi): more test/spec fixes

* fix(openapi): accidentally sending in authenticated jar for anon routes

* fix(openapi): more test/spec fixes

* fix(openapi): more spec fixes

* fix: timestampReadable Invalid Date

* fix(openapi): more tests... almost there

* fix(openapi): more tests fixing

* fix(openapi): finally all tests passing

* fix(openapi): added reverse test to compare response to spec

... and fixed all the tests that broke

* fix: remove tests related to group covers, as route is gone

* fix(openapi): broken test on travis

* fix(openapi): broken test on travis

* fix(openapi): broken test on travis

* fix(openapi): object cache is not present for psql

* fix: tests

Co-authored-by: Barış Soner Uşaklı <barisusakli@gmail.com>
2020-04-23 21:50:08 -04:00

64 lines
1.6 KiB
YAML

Pagination:
type: object
properties:
pagination:
type: object
properties:
prev:
type: object
properties:
page:
type: number
active:
type: boolean
next:
type: object
properties:
page:
type: number
active:
type: boolean
first:
type: object
properties:
page:
type: number
active:
type: boolean
last:
type: object
properties:
page:
type: number
active:
type: boolean
rel:
type: array
description: A collection of objects used to build the link tags pointing to adjacent pages, if any.
items:
type: object
properties:
rel:
type: string
enum: [prev, next]
href:
type: string
description: A query string that points to the previous or next page
pages:
type: array
items:
type: object
properties:
page:
type: number
description: The current page
active:
type: boolean
description: If the page noted in this array is the current page
qs:
type: string
description: A query string that points to the page noted in this array
currentPage:
type: number
pageCount:
type: number