Skip to content

IPA-112: Field names must use camelCase #589

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 21, 2025
Merged

IPA-112: Field names must use camelCase #589

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
9093492
CLOUDP-271999: Field names must use camelCase
yelizhenden-mdb Mar 20, 2025
4521d8e
Merge branch 'main' into CLOUDP-271999
yelizhenden-mdb Mar 21, 2025
754003a
prettier fix
yelizhenden-mdb Mar 21, 2025
a306ef9
address the comments
yelizhenden-mdb Mar 21, 2025
7dcc21d
fix AvoidProjectFieldNames
yelizhenden-mdb 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
208 changes: 110 additions & 98 deletions tools/spectral/ipa/__tests__/IPA112AvoidProjectFieldNames.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,41 @@ testRule('xgen-IPA-112-avoid-project-field-names', [
},
},
},
paths: {
'/users': {
post: {
requestBody: {
content: {
'application/vnd.atlas.2024-01-01+json': {
schema: {
type: 'object',
properties: {
group: { type: 'string' },
groupId: { type: 'string' },
gcpProjectId: { type: 'string' },
},
},
},
},
},
responses: {
201: {
content: {
'application/vnd.atlas.2024-01-01+json': {
schema: {
type: 'object',
properties: {
group: { type: 'string' },
gcpProjectId: { type: 'string' },
},
},
},
},
},
},
},
},
},
},
errors: [],
},
Expand All @@ -29,6 +64,41 @@ testRule('xgen-IPA-112-avoid-project-field-names', [
SchemaName: {
properties: {
project: { type: 'string' },
projects: { type: 'array' },
projectId: { type: 'string' },
myProjectDetails: { type: 'object' },
},
},
},
},
paths: {
'/users': {
post: {
requestBody: {
content: {
'application/vnd.atlas.2024-01-01+json': {
schema: {
type: 'object',
properties: {
projectId: { type: 'string' },
},
},
},
},
},
responses: {
201: {
content: {
'application/vnd.atlas.2024-01-01+json': {
schema: {
type: 'object',
properties: {
projectId: { type: 'string' },
},
},
},
},
},
},
},
},
Expand All @@ -41,105 +111,70 @@ testRule('xgen-IPA-112-avoid-project-field-names', [
path: ['components', 'schemas', 'SchemaName', 'properties', 'project'],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'invalid schema - with projects field name',
document: {
components: {
schemas: {
SchemaName: {
properties: {
projects: { type: 'array' },
},
},
},
},
},
errors: [
{
code: 'xgen-IPA-112-avoid-project-field-names',
message: 'Field name "projects" should be avoided. Consider using "groups" instead.',
path: ['components', 'schemas', 'SchemaName', 'properties', 'projects'],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'invalid schema - with projectId field name',
document: {
components: {
schemas: {
SchemaName: {
properties: {
projectId: { type: 'string' },
},
},
},
},
},
errors: [
{
code: 'xgen-IPA-112-avoid-project-field-names',
message: 'Field name "projectId" should be avoided. Consider using "group" instead.',
path: ['components', 'schemas', 'SchemaName', 'properties', 'projectId'],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'invalid schema with exception - project field name with exception',
document: {
components: {
schemas: {
SchemaName: {
properties: {
project: {
type: 'string',
'x-xgen-IPA-exception': {
'xgen-IPA-112-avoid-project-field-names': 'reason',
},
},
},
},
},
},
},
errors: [],
},
{
name: 'field name containing project substring',
document: {
components: {
schemas: {
SchemaName: {
properties: {
myProjectDetails: { type: 'object' },
},
},
},
},
},
errors: [
{
code: 'xgen-IPA-112-avoid-project-field-names',
message: 'Field name "myProjectDetails" should be avoided. Consider using "group" instead.',
path: ['components', 'schemas', 'SchemaName', 'properties', 'myProjectDetails'],
severity: DiagnosticSeverity.Warning,
},
{
code: 'xgen-IPA-112-avoid-project-field-names',
message: 'Field name "projectId" should be avoided. Consider using "group" instead.',
path: [
'paths',
'/users',
'post',
'requestBody',
'content',
'application/vnd.atlas.2024-01-01+json',
'schema',
'properties',
'projectId',
],
severity: DiagnosticSeverity.Warning,
},
{
code: 'xgen-IPA-112-avoid-project-field-names',
message: 'Field name "projectId" should be avoided. Consider using "group" instead.',
path: [
'paths',
'/users',
'post',
'responses',
'201',
'content',
'application/vnd.atlas.2024-01-01+json',
'schema',
'properties',
'projectId',
],
severity: DiagnosticSeverity.Warning,
},
],
},
{
name: 'exception - field with project substring',
name: 'invalid schema with exception - project field name with exception',
document: {
components: {
schemas: {
SchemaName: {
properties: {
myProjectDetails: {
type: 'object',
project: {
type: 'string',
'x-xgen-IPA-exception': {
'xgen-IPA-112-avoid-project-field-names': 'Reason',
'xgen-IPA-112-avoid-project-field-names': 'reason',
},
},
},
Expand Down Expand Up @@ -168,40 +203,17 @@ testRule('xgen-IPA-112-avoid-project-field-names', [
'xgen-IPA-112-avoid-project-field-names': 'Reason',
},
},
},
},
},
},
},
errors: [],
},
{
name: 'mixed valid, invalid, and exception fields',
document: {
components: {
schemas: {
SchemaName: {
properties: {
project: {
type: 'string',
myProjectDetails: {
type: 'object',
'x-xgen-IPA-exception': {
'xgen-IPA-112-avoid-project-field-names': 'Reason',
},
},
projectId: { type: 'string' },
group: { type: 'string' },
},
},
},
},
},
errors: [
{
code: 'xgen-IPA-112-avoid-project-field-names',
message: 'Field name "projectId" should be avoided. Consider using "group" instead.',
path: ['components', 'schemas', 'SchemaName', 'properties', 'projectId'],
severity: DiagnosticSeverity.Warning,
},
],
errors: [],
},
]);
Loading
Loading