Skip to content

CLOUDP-306580: base types oneof #573

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 3 commits into from
Mar 20, 2025
Merged

CLOUDP-306580: base types oneof #573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
61030b8
CLOUDP-306581: base types oneof
wtrocki Mar 19, 2025
e6ff859
fix: renerated documentation
wtrocki Mar 20, 2025
c5528ac
fix: refactor to support exceptions and standard ipa functions
wtrocki Mar 20, 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
166 changes: 89 additions & 77 deletions tools/spectral/ipa/__tests__/IPA125OneOfMustHaveDiscriminator.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,32 @@ import testRule from './__helpers__/testRule';
import { DiagnosticSeverity } from '@stoplight/types';

const componentSchemas = {
schemas: {
Dog: {
type: 'object',
properties: {
breed: { type: 'string' },
age: { type: 'integer' },
},
Dog: {
type: 'object',
properties: {
breed: { type: 'string' },
age: { type: 'integer' },
},
Cat: {
type: 'object',
properties: {
color: { type: 'string' },
livesLeft: { type: 'integer' },
},
},
Cat: {
type: 'object',
properties: {
color: { type: 'string' },
livesLeft: { type: 'integer' },
},
Bird: {
type: 'object',
properties: {
species: { type: 'string' },
wingspan: { type: 'number' },
},
},
Bird: {
type: 'object',
properties: {
species: { type: 'string' },
wingspan: { type: 'number' },
},
Fish: {
type: 'object',
properties: {
species: { type: 'string' },
waterType: { type: 'string' },
},
},
Fish: {
type: 'object',
properties: {
species: { type: 'string' },
waterType: { type: 'string' },
},
},
};
Expand All @@ -38,15 +36,17 @@ testRule('xgen-IPA-125-oneOf-must-have-discriminator', [
{
name: 'valid oneOf with discriminator and matching mapping',
document: {
components: componentSchemas,
schemas: {
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
discriminator: {
propertyName: 'type',
mapping: {
dog: '#/components/schemas/Dog',
cat: '#/components/schemas/Cat',
components: {
schemas: {
...componentSchemas,
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
discriminator: {
propertyName: 'type',
mapping: {
dog: '#/components/schemas/Dog',
cat: '#/components/schemas/Cat',
},
},
},
},
Expand All @@ -57,15 +57,17 @@ testRule('xgen-IPA-125-oneOf-must-have-discriminator', [
{
name: 'invalid oneOf with discriminator but mismatched mapping',
document: {
components: componentSchemas,
schemas: {
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
discriminator: {
propertyName: 'type',
mapping: {
dog: '#/components/schemas/Dog',
bird: '#/components/schemas/Bird',
components: {
schemas: {
...componentSchemas,
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
discriminator: {
propertyName: 'type',
mapping: {
dog: '#/components/schemas/Dog',
bird: '#/components/schemas/Bird',
},
},
},
},
Expand All @@ -76,61 +78,67 @@ testRule('xgen-IPA-125-oneOf-must-have-discriminator', [
code: 'xgen-IPA-125-oneOf-must-have-discriminator',
message:
'The discriminator mapping must match the oneOf references. Unmatched Discriminator mappings with oneOf references: #/components/schemas/Bird',
path: ['schemas', 'Animal'],
path: ['components', 'schemas', 'Animal'],
severity: DiagnosticSeverity.Error,
},
],
},
{
name: 'invalid oneOf without discriminator',
document: {
components: componentSchemas,
schemas: {
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
components: {
schemas: {
...componentSchemas,
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
},
},
},
},
errors: [
{
code: 'xgen-IPA-125-oneOf-must-have-discriminator',
message: 'The schema has oneOf but no discriminator property.',
path: ['schemas', 'Animal'],
path: ['components', 'schemas', 'Animal'],
severity: DiagnosticSeverity.Error,
},
],
},
{
name: 'invalid oneOf with non-object discriminator',
document: {
components: componentSchemas,
schemas: {
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
discriminator: "I'm a string, not an object!",
components: {
schemas: {
...componentSchemas,
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
discriminator: "I'm a string, not an object!",
},
},
},
},
errors: [
{
code: 'xgen-IPA-125-oneOf-must-have-discriminator',
message: 'Discriminator property is not an object.',
path: ['schemas', 'Animal'],
path: ['components', 'schemas', 'Animal'],
severity: DiagnosticSeverity.Error,
},
],
},
{
name: 'invalid oneOf with discriminator but no propertyName',
document: {
components: componentSchemas,
schemas: {
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
discriminator: {
mapping: {
dog: '#/components/schemas/Dog',
cat: '#/components/schemas/Cat',
components: {
schemas: {
...componentSchemas,
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
discriminator: {
mapping: {
dog: '#/components/schemas/Dog',
cat: '#/components/schemas/Cat',
},
},
},
},
Expand All @@ -140,20 +148,22 @@ testRule('xgen-IPA-125-oneOf-must-have-discriminator', [
{
code: 'xgen-IPA-125-oneOf-must-have-discriminator',
message: 'Discriminator has no propertyName defined.',
path: ['schemas', 'Animal'],
path: ['components', 'schemas', 'Animal'],
severity: DiagnosticSeverity.Error,
},
],
},
{
name: 'invalid oneOf with discriminator but no mapping',
document: {
components: componentSchemas,
schemas: {
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
discriminator: {
propertyName: 'type',
components: {
schemas: {
...componentSchemas,
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
discriminator: {
propertyName: 'type',
},
},
},
},
Expand All @@ -162,20 +172,22 @@ testRule('xgen-IPA-125-oneOf-must-have-discriminator', [
{
code: 'xgen-IPA-125-oneOf-must-have-discriminator',
message: 'Discriminator must have a mapping object.',
path: ['schemas', 'Animal'],
path: ['components', 'schemas', 'Animal'],
severity: DiagnosticSeverity.Error,
},
],
},
{
name: 'oneOf with discriminator exemption',
document: {
components: componentSchemas,
schemas: {
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
'x-xgen-IPA-exception': {
'xgen-IPA-125-oneOf-must-have-discriminator': 'reason for exemption',
components: {
schemas: {
...componentSchemas,
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
'x-xgen-IPA-exception': {
'xgen-IPA-125-oneOf-must-have-discriminator': 'reason for exemption',
},
},
},
},
Expand Down
117 changes: 117 additions & 0 deletions tools/spectral/ipa/__tests__/IPA125OneOfNoBaseTypes.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
import testRule from './__helpers__/testRule';
import { DiagnosticSeverity } from '@stoplight/types';

const componentSchemas = {
Dog: {
type: 'object',
properties: {
breed: { type: 'string' },
age: { type: 'integer' },
},
},
Cat: {
type: 'object',
properties: {
color: { type: 'string' },
livesLeft: { type: 'integer' },
},
},
};

testRule('xgen-IPA-125-oneOf-no-base-types', [
{
name: 'valid oneOf with references only',
document: {
components: {
schemas: {
...componentSchemas,
Animal: {
oneOf: [{ $ref: '#/components/schemas/Dog' }, { $ref: '#/components/schemas/Cat' }],
},
},
},
},
errors: [],
},
{
name: 'valid oneOf with object schema',
document: {
components: {
schemas: {
...componentSchemas,
MixedObject: {
oneOf: [
{
type: 'object',
properties: {
name: { type: 'string' },
},
},
{ $ref: '#/components/schemas/Dog' },
],
},
},
},
},
errors: [],
},
{
name: 'invalid oneOf with string type',
document: {
components: {
schemas: {
...componentSchemas,
MixedType: {
oneOf: [{ type: 'string' }, { $ref: '#/components/schemas/Dog' }],
},
},
},
},
errors: [
{
code: 'xgen-IPA-125-oneOf-no-base-types',
message: 'oneOf should not contain base types like integer, number, string, or boolean.',
path: ['components', 'schemas', 'MixedType'],
severity: DiagnosticSeverity.Error,
},
],
},
{
name: 'invalid oneOf with multiple base types',
document: {
components: {
schemas: {
...componentSchemas,
BaseTypes: {
oneOf: [{ type: 'string' }, { type: 'integer' }, { type: 'boolean' }],
},
},
},
},
errors: [
{
code: 'xgen-IPA-125-oneOf-no-base-types',
message: 'oneOf should not contain base types like integer, number, string, or boolean.',
path: ['components', 'schemas', 'BaseTypes'],
severity: DiagnosticSeverity.Error,
},
],
},
{
name: 'oneOf with exception',
document: {
components: {
schemas: {
...componentSchemas,
MixedType: {
oneOf: [{ type: 'string' }, { type: 'integer' }],
'x-xgen-IPA-exception': {
'xgen-IPA-125-oneOf-no-base-types': 'reason for exemption',
},
},
},
},
},
errors: [],
},
]);
1 change: 1 addition & 0 deletions tools/spectral/ipa/ipa-spectral.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ extends:
- ./rulesets/IPA-112.yaml
- ./rulesets/IPA-113.yaml
- ./rulesets/IPA-123.yaml
- ./rulesets/IPA-125.yaml

overrides:
- files:
Expand Down
Loading
Loading