Skip to content

CLOUDP-304965: IPA rule for descriptions #590

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 4 commits into from
Mar 21, 2025
Merged

CLOUDP-304965: IPA rule for descriptions #590

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e782110
CLOUDP-304965: IPA rule for descriptions
lovisaberggren Mar 21, 2025
ffd9406
CLOUDP-304965: Fix
lovisaberggren Mar 21, 2025
f743afb
CLOUDP-304965: Fix
lovisaberggren Mar 21, 2025
aa0d15e
CLOUDP-304965: Fix docs
lovisaberggren Mar 21, 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
391 changes: 391 additions & 0 deletions tools/spectral/ipa/__tests__/IPA117HasDescription.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,391 @@
import testRule from './__helpers__/testRule';
import { DiagnosticSeverity } from '@stoplight/types';

testRule('xgen-IPA-117-description', [
{
name: 'valid components',
document: {
info: {
description: 'description',
},
tags: [
{
name: 'Tag',
description: 'description',
},
],
paths: {
'/resource': {
get: {
description: 'description',
parameters: {
id: {
description: 'description',
},
},
},
// Ignores non-operations
'x-extension': {},
},
},
components: {
schemas: {
Schema: {
properties: {
id: {
description: 'description',
},
},
},
},
parameters: {
parameter: {
description: 'description',
},
},
},
},
errors: [],
},
{
name: 'invalid components',
document: {
info: {},
tags: [
{
name: 'Tag',
},
],
paths: {
'/resource': {
get: {
parameters: {
id: {},
},
},
},
},
components: {
schemas: {
Schema: {
properties: {
id: {},
},
},
},
parameters: {
parameter: {},
},
},
},
errors: [
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: ['info'],
severity: DiagnosticSeverity.Warning,
},
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: ['tags', '0'],
severity: DiagnosticSeverity.Warning,
},
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: ['paths', '/resource', 'get'],
severity: DiagnosticSeverity.Warning,
},
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: ['paths', '/resource', 'get', 'parameters', 'id'],
severity: DiagnosticSeverity.Warning,
},
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: ['components', 'schemas', 'Schema', 'properties', 'id'],
severity: DiagnosticSeverity.Warning,
},
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: ['components', 'parameters', 'parameter'],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'invalid array schema',
document: {
components: {
schemas: {
ArraySchema: {
type: 'array',
items: {
properties: {
id: {},
},
},
},
},
},
},
errors: [
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: ['components', 'schemas', 'ArraySchema', 'items', 'properties', 'id'],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'invalid nested schema',
document: {
components: {
schemas: {
NestedSchema: {
properties: {
name: {
properties: {
first: {},
last: {},
},
},
},
},
},
},
},
errors: [
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: ['components', 'schemas', 'NestedSchema', 'properties', 'name'],
severity: DiagnosticSeverity.Warning,
},
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: ['components', 'schemas', 'NestedSchema', 'properties', 'name', 'properties', 'first'],
severity: DiagnosticSeverity.Warning,
},
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: ['components', 'schemas', 'NestedSchema', 'properties', 'name', 'properties', 'last'],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'invalid paginated schema',
document: {
components: {
schemas: {
PaginatedSchema: {
properties: {
results: {
type: 'array',
items: {
properties: {
first: {},
last: {},
},
},
},
},
},
},
},
},
errors: [
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: ['components', 'schemas', 'PaginatedSchema', 'properties', 'results'],
severity: DiagnosticSeverity.Warning,
},
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: ['components', 'schemas', 'PaginatedSchema', 'properties', 'results', 'items', 'properties', 'first'],
severity: DiagnosticSeverity.Warning,
},
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: ['components', 'schemas', 'PaginatedSchema', 'properties', 'results', 'items', 'properties', 'last'],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'invalid inline schemas',
document: {
paths: {
'/resource': {
post: {
description: 'description',
responses: {
201: {
content: {
'application/vnd.atlas.2024-01-01+json': {
schema: {
properties: {
id: {},
},
},
},
},
},
},
requestBody: {
content: {
'application/vnd.atlas.2024-01-01+json': {
schema: {
properties: {
id: {},
},
},
},
'application/vnd.atlas.2025-01-01+json': {
schema: {
properties: {
id: {},
},
},
},
},
},
},
},
},
},
errors: [
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: [
'paths',
'/resource',
'post',
'responses',
'201',
'content',
'application/vnd.atlas.2024-01-01+json',
'schema',
'properties',
'id',
],
severity: DiagnosticSeverity.Warning,
},
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: [
'paths',
'/resource',
'post',
'requestBody',
'content',
'application/vnd.atlas.2024-01-01+json',
'schema',
'properties',
'id',
],
severity: DiagnosticSeverity.Warning,
},
{
code: 'xgen-IPA-117-description',
message:
'Description not found. API producers must provide descriptions for Properties, Operations and Parameters.',
path: [
'paths',
'/resource',
'post',
'requestBody',
'content',
'application/vnd.atlas.2025-01-01+json',
'schema',
'properties',
'id',
],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'invalid components with exceptions',
document: {
info: {
'x-xgen-IPA-exception': {
'xgen-IPA-117-description': 'reason',
},
},
tags: [
{
name: 'Tag',
'x-xgen-IPA-exception': {
'xgen-IPA-117-description': 'reason',
},
},
],
paths: {
'/resource': {
get: {
'x-xgen-IPA-exception': {
'xgen-IPA-117-description': 'reason',
},
parameters: {
id: {
'x-xgen-IPA-exception': {
'xgen-IPA-117-description': 'reason',
},
},
},
},
},
},
components: {
schemas: {
Schema: {
properties: {
id: {
'x-xgen-IPA-exception': {
'xgen-IPA-117-description': 'reason',
},
},
},
},
},
parameters: {
parameter: {
'x-xgen-IPA-exception': {
'xgen-IPA-117-description': 'reason',
},
},
},
},
},
errors: [],
},
]);
Loading
Loading