paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 30 Packages Projects Releases Wiki Activity

Merge pull request #31490 from rferreira98/fix-propertyNaming-ignored-on-hyphen-usage

Browse Source 
feat: preserve hyphenated property names in OpenAPI generators when u…
This commit is contained in:
Ben Lambert
2025-11-25 11:03:10 +01:00
committed by GitHub
parent 538c91064c 78827da225
commit 29200353e5
9 changed files with 27 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/loose-pets-slide.md
+10
View File
@@ -0,0 +1,10 @@
---
'@backstage/repo-tools': patch
---
Updates OpenAPI generator templates to preserve original property names (like 'group-name', 'user-id') from OpenAPI specs when propertyNaming=original is specified. Previously, these were always converted to camelCase regardless of the propertyNaming setting.
- Updates modelGeneric.mustache templates in both client and server generators
- Updates modelTaggedUnion.mustache templates in both client and server generators
- Uses {{baseName}} when available, falls back to {{name}} for backward compatibility
- Maintains backward compatibility - no changes when propertyNaming=original is not used
packages/repo-tools/src/commands/package/schema/openapi/generate/client.ts
+5 -5
View File
@@ -14,21 +14,21 @@
* limitations under the License.
*/
import { resolvePackagePath } from '@backstage/backend-plugin-api';
import chalk from 'chalk';
import fs from 'fs-extra';
import { resolve } from 'path';
import { exec } from '../../../../../lib/exec';
import {
OPENAPI_IGNORE_FILES,
OUTPUT_PATH,
} from '../../../../../lib/openapi/constants';
import { paths as cliPaths } from '../../../../../lib/paths';
import fs from 'fs-extra';
import { exec } from '../../../../../lib/exec';
import { resolvePackagePath } from '@backstage/backend-plugin-api';
import { deduplicateImports } from '../../../../../lib/openapi/dedupe-imports';
import {
getPathToCurrentOpenApiSpec,
toGeneratorAdditionalProperties,
} from '../../../../../lib/openapi/helpers';
import { deduplicateImports } from '../../../../../lib/openapi/dedupe-imports';
import { paths as cliPaths } from '../../../../../lib/paths';
async function generate(
outputDirectory: string,
packages/repo-tools/src/commands/repo/schema/openapi/lint.ts
+2
View File
@@ -68,6 +68,8 @@ async function lint(directoryPath: string, config?: { strict: boolean }) {
'operation-tags': 'off',
'hosts-https-only-oas3': 'off',
'no-unknown-error-format': 'off',
// Disabled as it currently gives false positives when 'example' is used as a property name.
'oas3-valid-media-example': 'off',
},
},
],
packages/repo-tools/templates/typescript-backstage-client/modelGeneric.mustache
+1 -1
View File
@@ -18,7 +18,7 @@ export {{#isNullable}}type{{/isNullable}}{{^isNullable}}interface{{/isNullable}}
* {{{.}}}
*/
{{/description}}
'{{name}}'{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}} | null{{/isNullable}};
'{{#baseName}}{{baseName}}{{/baseName}}{{^baseName}}{{name}}{{/baseName}}'{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}} | null{{/isNullable}};
{{/vars}}
}{{#isNullable}} | null{{/isNullable}}
packages/repo-tools/templates/typescript-backstage-client/modelTaggedUnion.mustache
+1 -1
View File
@@ -12,7 +12,7 @@ export interface {{classname}} { {{>modelGenericAdditionalProperties}}
* {{{.}}}
*/
{{/description}}
{{name}}{{^required}}?{{/required}}: {{#discriminatorValue}}'{{.}}'{{/discriminatorValue}}{{^discriminatorValue}}{{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{/discriminatorValue}}{{#isNullable}} | null{{/isNullable}};
'{{#baseName}}{{baseName}}{{/baseName}}{{^baseName}}{{name}}{{/baseName}}'{{^required}}?{{/required}}: {{#discriminatorValue}}'{{.}}'{{/discriminatorValue}}{{^discriminatorValue}}{{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{/discriminatorValue}}{{#isNullable}} | null{{/isNullable}};
{{/allVars}}
}
{{>modelGenericEnums}}
packages/repo-tools/templates/typescript-backstage-server/modelGeneric.mustache
+1 -1
View File
@@ -18,7 +18,7 @@ export {{#isNullable}}type{{/isNullable}}{{^isNullable}}interface{{/isNullable}}
* {{{.}}}
*/
{{/description}}
'{{name}}'{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}} | null{{/isNullable}};
'{{#baseName}}{{baseName}}{{/baseName}}{{^baseName}}{{name}}{{/baseName}}'{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}} | null{{/isNullable}};
{{/vars}}
}{{#isNullable}} | null{{/isNullable}}
packages/repo-tools/templates/typescript-backstage-server/modelTaggedUnion.mustache
+1 -1
View File
@@ -12,7 +12,7 @@ export interface {{classname}} { {{>modelGenericAdditionalProperties}}
* {{{.}}}
*/
{{/description}}
{{name}}{{^required}}?{{/required}}: {{#discriminatorValue}}'{{.}}'{{/discriminatorValue}}{{^discriminatorValue}}{{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{/discriminatorValue}}{{#isNullable}} | null{{/isNullable}};
'{{#baseName}}{{baseName}}{{/baseName}}{{^baseName}}{{name}}{{/baseName}}'{{^required}}?{{/required}}: {{#discriminatorValue}}'{{.}}'{{/discriminatorValue}}{{^discriminatorValue}}{{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{/discriminatorValue}}{{#isNullable}} | null{{/isNullable}};
{{/allVars}}
}
{{>modelGenericEnums}}
plugins/scaffolder-backend/src/schema/openapi.yaml
+3 -3
View File
@@ -113,7 +113,7 @@ components:
type: string
description:
type: string
"'examples'":
examples:
type: array
items:
$ref: '#/components/schemas/ActionExample'
@@ -417,7 +417,7 @@ components:
$ref: '#/components/schemas/JsonObject'
output:
$ref: '#/components/schemas/JsonObject'
"'examples'":
examples:
type: array
items:
$ref: '#/components/schemas/ScaffolderUsageExample'
@@ -449,7 +449,7 @@ components:
$ref: '#/components/schemas/JsonObject'
output:
$ref: '#/components/schemas/JsonObject'
"'examples'":
examples:
type: array
items:
$ref: '#/components/schemas/ScaffolderUsageExample'
plugins/scaffolder-backend/src/schema/openapi/generated/router.ts
+3 -3
View File
@@ -173,7 +173,7 @@ export const spec = {
description: {
type: 'string',
},
"'examples'": {
examples: {
type: 'array',
items: {
$ref: '#/components/schemas/ActionExample',
@@ -588,7 +588,7 @@ export const spec = {
},
},
},
"'examples'": {
examples: {
type: 'array',
items: {
$ref: '#/components/schemas/ScaffolderUsageExample',
@@ -636,7 +636,7 @@ export const spec = {
},
},
},
"'examples'": {
examples: {
type: 'array',
items: {
$ref: '#/components/schemas/ScaffolderUsageExample',