Skip to content

IPA-110: Pagination (itemsPerPage and pageNum query params) #617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 26, 2025
Merged

IPA-110: Pagination (itemsPerPage and pageNum query params) #617

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
253 changes: 253 additions & 0 deletions tools/spectral/ipa/__tests__/IPA110CollectionsRequestHasItemsPerPageQueryParam.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,253 @@
import testRule from './__helpers__/testRule';
import { DiagnosticSeverity } from '@stoplight/types';

const parameters = {
parameters: {
pageNum: {
name: 'pageNum',
in: 'query',
schema: {
type: 'integer',
default: 1,
},
},
itemsPerPage: {
name: 'itemsPerPage',
in: 'query',
schema: {
type: 'integer',
default: 100,
},
},
},
};

testRule('xgen-IPA-110-collections-request-has-itemsPerPage-query-param', [
{
name: 'valid examples',
document: {
paths: {
'/resources': {
get: {
parameters: [
{
name: 'itemsPerPage',
in: 'query',
schema: {
type: 'integer',
default: 100,
},
},
],
},
},
'resources/{resourceId}': {
get: {},
},
'/resourcesTwo': {
get: {
parameters: [
{
$ref: '#/components/parameters/itemsPerPage',
},
],
},
},
'resourcesTwo/{resourceId}': {
get: {},
},
},
components: parameters,
},
errors: [],
},
{
name: 'invalid - missing parameters',
document: {
paths: {
'/resources': {
get: {},
},
},
},
errors: [
{
code: 'xgen-IPA-110-collections-request-has-itemsPerPage-query-param',
message: 'List method is missing query parameters.',
path: ['paths', '/resources', 'get'],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'invalid - missing itemsPerPage parameter',
document: {
paths: {
'/resources': {
get: {
parameters: [
{
name: 'pageNum',
in: 'query',
schema: {
type: 'integer',
default: 1,
},
},
],
},
},
'resources/{resourceId}': {
get: {},
},
'/resourcesTwo': {
get: {
parameters: [
{
$ref: '#/components/parameters/pageNum',
},
],
},
},
'resourcesTwo/{resourceId}': {
get: {},
},
},
components: parameters,
},
errors: [
{
code: 'xgen-IPA-110-collections-request-has-itemsPerPage-query-param',
message: 'List method is missing a itemsPerPage query parameter.',
path: ['paths', '/resources', 'get'],
severity: DiagnosticSeverity.Warning,
},
{
code: 'xgen-IPA-110-collections-request-has-itemsPerPage-query-param',
message: 'List method is missing a itemsPerPage query parameter.',
path: ['paths', '/resourcesTwo', 'get'],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'invalid - itemsPerPage parameter is required',
document: {
paths: {
'/resources': {
get: {
parameters: [
{
name: 'itemsPerPage',
in: 'query',
required: true,
schema: {
type: 'integer',
default: 100,
},
},
],
},
},
'resources/{resourceId}': {
get: {},
},
},
},
errors: [
{
code: 'xgen-IPA-110-collections-request-has-itemsPerPage-query-param',
message: 'itemsPerPage query parameter of List method must not be required.',
path: ['paths', '/resources', 'get'],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'invalid - itemsPerPage parameter without default value',
document: {
paths: {
'/resources': {
get: {
parameters: [
{
name: 'itemsPerPage',
in: 'query',
schema: {
type: 'integer',
},
},
],
},
},
'resources/{resourceId}': {
get: {},
},
},
},
errors: [
{
code: 'xgen-IPA-110-collections-request-has-itemsPerPage-query-param',
message: 'itemsPerPage query parameter of List method must have a default value defined.',
path: ['paths', '/resources', 'get'],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'invalid - wrong default value',
document: {
paths: {
'/resources': {
get: {
parameters: [
{
name: 'itemsPerPage',
in: 'query',
schema: {
type: 'integer',
default: 0,
},
},
],
},
},
'resources/{resourceId}': {
get: {},
},
},
},
errors: [
{
code: 'xgen-IPA-110-collections-request-has-itemsPerPage-query-param',
message: 'itemsPerPage query parameter of List method must have a default value of 100.',
path: ['paths', '/resources', 'get'],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'exception',
document: {
paths: {
'/resourcesTwo': {
get: {
parameters: [
{
$ref: '#/components/parameters/pageNum',
},
],
'x-xgen-IPA-exception': {
'xgen-IPA-110-collections-request-has-itemsPerPage-query-param': 'Reason',
},
},
},
'resourcesTwo/{resourceId}': {
get: {},
},
},
components: parameters,
},
errors: [],
},
]);
Loading
Loading