Skip to content

fix(ipa): Support read-only standard and singleton resources #1057

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

Draft
yelizhenden-mdb wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

fix(ipa): Support read-only standard and singleton resources #1057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fab7334
fix(ipa): Support read-only standard and singleton resources
yelizhenden-mdb Dec 19, 2025
28c5664
prettier fix
yelizhenden-mdb Dec 19, 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
290 changes: 290 additions & 0 deletions tools/spectral/ipa/__tests__/IPA106ReadOnlyResourceShouldNotHaveCreateMethod.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,290 @@
import testRule from './__helpers__/testRule';
import { DiagnosticSeverity } from '@stoplight/types';

testRule('xgen-IPA-106-readonly-resource-should-not-have-create-method', [
{
name: 'valid: writable resource with create method',
document: {
openapi: '3.0.0',
paths: {
'/writableResource': {
get: {
responses: {
200: {
content: {
'application/vnd.atlas.2023-01-01+json': {
schema: {
type: 'object',
properties: {
id: { type: 'string', readOnly: true },
name: { type: 'string' }, // Not readOnly - writable resource
description: { type: 'string' },
},
},
},
},
},
},
},
post: {
requestBody: {
content: {
'application/vnd.atlas.2023-01-01+json': {
schema: {
type: 'object',
properties: {
name: { type: 'string' },
description: { type: 'string' },
},
},
},
},
},
responses: {
201: {
content: {
'application/vnd.atlas.2023-01-01+json': {
schema: {
type: 'object',
properties: {
id: { type: 'string' },
name: { type: 'string' },
},
},
},
},
},
},
},
},
'/writableResource/{id}': {
get: {
responses: {
200: {
content: {
'application/vnd.atlas.2023-01-01+json': {
schema: {
type: 'object',
properties: {
id: { type: 'string', readOnly: true },
name: { type: 'string' },
description: { type: 'string' },
},
},
},
},
},
},
},
},
},
},
errors: [],
},
{
name: 'invalid: read-only resource with POST method',
document: {
openapi: '3.0.0',
paths: {
'/readOnlyResource': {
get: {
responses: {
200: {
content: {
'application/vnd.atlas.2023-01-01+json': {
schema: {
type: 'object',
properties: {
id: { type: 'string', readOnly: true },
name: { type: 'string', readOnly: true },
createdAt: { type: 'string', readOnly: true },
},
},
},
},
},
},
},
post: {
requestBody: {
content: {
'application/vnd.atlas.2023-01-01+json': {
schema: {
type: 'object',
properties: {
name: { type: 'string' },
},
},
},
},
},
responses: {
201: {
content: {
'application/vnd.atlas.2023-01-01+json': {
schema: {
type: 'object',
properties: {
id: { type: 'string' },
name: { type: 'string' },
},
},
},
},
},
},
},
},
'/readOnlyResource/{id}': {
get: {
responses: {
200: {
content: {
'application/vnd.atlas.2023-01-01+json': {
schema: {
type: 'object',
properties: {
id: { type: 'string', readOnly: true },
name: { type: 'string', readOnly: true },
createdAt: { type: 'string', readOnly: true },
},
},
},
},
},
},
},
},
},
},
errors: [
{
code: 'xgen-IPA-106-readonly-resource-should-not-have-create-method',
message: 'Read-only resources must not define the Create method.',
path: ['paths', '/readOnlyResource', 'post'],
severity: DiagnosticSeverity.Error,
},
],
},
{
name: 'valid: read-only resource with create method and exception',
document: {
openapi: '3.0.0',
paths: {
'/readOnlyResource': {
get: {
responses: {
200: {
content: {
'application/vnd.atlas.2023-01-01+json': {
schema: {
type: 'object',
properties: {
id: { type: 'string', readOnly: true },
name: { type: 'string', readOnly: true },
createdAt: { type: 'string', readOnly: true },
},
},
},
},
},
},
},
post: {
'x-xgen-IPA-exception': {
'xgen-IPA-106-readonly-resource-should-not-have-create-method': 'Special case exception',
},
requestBody: {
content: {
'application/vnd.atlas.2023-01-01+json': {
schema: {
type: 'object',
properties: {
name: { type: 'string' },
},
},
},
},
},
responses: {
201: {
content: {
'application/vnd.atlas.2023-01-01+json': {
schema: {
type: 'object',
properties: {
id: { type: 'string' },
name: { type: 'string' },
},
},
},
},
},
},
},
},
'/readOnlyResource/{id}': {
get: {
responses: {
200: {
content: {
'application/vnd.atlas.2023-01-01+json': {
schema: {
type: 'object',
properties: {
id: { type: 'string', readOnly: true },
name: { type: 'string', readOnly: true },
createdAt: { type: 'string', readOnly: true },
},
},
},
},
},
},
},
},
},
},
errors: [],
},
{
name: 'valid: resource without GET method should not error',
document: {
openapi: '3.0.0',
paths: {
'/resource': {
post: {
requestBody: {
content: {
'application/vnd.atlas.2023-01-01+json': {
schema: {
type: 'object',
properties: {
name: { type: 'string' },
},
},
},
},
},
responses: {
201: {
content: {
'application/vnd.atlas.2023-01-01+json': {
schema: {
type: 'object',
properties: {
id: { type: 'string' },
name: { type: 'string' },
},
},
},
},
},
},
},
},
},
},
errors: [],
},
]);
Loading
Loading