Skip to content

CLOUDP-271998: IPA-110: Pagination (Validate Paginated prefix and results array field) #601

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 5 commits into from
Mar 25, 2025
Merged

CLOUDP-271998: IPA-110: Pagination (Validate Paginated prefix and results array field) #601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f1d7988
CLOUDP-271998: IPA-110: Pagination: APIs returning collections should…
yelizhenden-mdb Mar 25, 2025
6266a94
docs change
yelizhenden-mdb Mar 25, 2025
52698c6
address the comments
yelizhenden-mdb Mar 25, 2025
79d6af4
split it into two guidelines
yelizhenden-mdb Mar 25, 2025
1e94bf0
error message fix
yelizhenden-mdb Mar 25, 2025
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
242 changes: 242 additions & 0 deletions tools/spectral/ipa/__tests__/IPA110CollectionsResponseDefineResultsArray.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,242 @@
import testRule from './__helpers__/testRule';
import { DiagnosticSeverity } from '@stoplight/types';

const componentSchemas = {
Resource: {
type: 'object',
},
PaginatedResourceList: {
type: 'object',
properties: {
totalCount: {
type: 'integer',
},
results: {
type: 'array',
items: {
$ref: '#/components/schemas/Resource',
},
},
},
},
ResourcePaginatedList: {
type: 'object',
properties: {
totalCount: {
type: 'integer',
},
results: {
type: 'array',
items: {
$ref: '#/components/schemas/Resource',
},
},
},
},
};

testRule('xgen-IPA-110-collections-response-define-results-array', [
{
name: 'valid schemas with Paginated prefix',
document: {
paths: {
'/resources': {
get: {
responses: {
200: {
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/PaginatedResourceList',
},
},
},
},
},
},
},
'/resources/{id}': {
get: {
responses: {
200: {
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/Resource',
},
},
},
},
},
},
},
},
components: {
schemas: componentSchemas,
},
},
errors: [],
},
{
name: 'valid schemas without Paginated prefix but with correct structure',
document: {
paths: {
'/resources': {
get: {
responses: {
200: {
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/ResourcePaginatedList',
},
},
},
},
},
},
},
'/resources/{id}': {
get: {},
},
},
components: {
schemas: componentSchemas,
},
},
errors: [],
},
{
name: 'invalid schema missing results',
document: {
paths: {
'/resources': {
get: {
responses: {
200: {
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/PaginatedMissingResults',
},
},
},
},
},
},
},
'/resources/{id}': {
get: {},
},
},
components: {
schemas: {
PaginatedMissingResults: {
type: 'object',
properties: {
totalCount: {
type: 'integer',
},
},
},
},
},
},
errors: [
{
code: 'xgen-IPA-110-collections-response-define-results-array',
message: 'The response for collections must define an array of results containing the paginated resource.',
path: ['paths', '/resources', 'get', 'responses', '200', 'content', 'application/json'],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'valid inline schema instead of reference',
document: {
paths: {
'/resources': {
get: {
responses: {
200: {
content: {
'application/json': {
schema: {
type: 'object',
properties: {
totalCount: {
type: 'integer',
},
results: {
type: 'array',
items: {
$ref: '#/components/schemas/Resource',
},
},
},
},
},
},
},
},
},
},
'/resources/{id}': {
get: {},
},
},
components: {
schemas: componentSchemas,
},
},
errors: [],
},
{
name: 'invalid schema missing results with exceptions',
document: {
paths: {
'/resources': {
get: {
responses: {
200: {
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/PaginatedMissingResults',
},
'x-xgen-IPA-exception': {
'xgen-IPA-110-collections-response-define-results-array': 'Reason',
},
},
},
},
},
},
},
'/resources/{id}': {
get: {},
},
},
components: {
schemas: {
PaginatedMissingResults: {
type: 'object',
properties: {
totalCount: {
type: 'integer',
},
},
},
},
},
},
errors: [
{
code: 'xgen-IPA-110-collections-response-define-results-array',
message: 'The response for collections must define an array of results containing the paginated resource.',
path: ['paths', '/resources', 'get', 'responses', '200', 'content', 'application/json'],
severity: DiagnosticSeverity.Warning,
},
],
},
]);
Loading
Loading