[9.1] [OpenAPI generator] add transformSchemaName config options (#250857)#252471
Closed
janmonschke wants to merge 1 commit intoelastic:9.1from
Closed
[9.1] [OpenAPI generator] add transformSchemaName config options (#250857)#252471janmonschke wants to merge 1 commit intoelastic:9.1from
transformSchemaName config options (#250857)#252471janmonschke wants to merge 1 commit intoelastic:9.1from
Conversation
…#250857) ## Summary If a yaml definition defines the type names in lowercase, like in the cases codebase, the generator would generate lowercase type/schema names. This is against our eslint rules. ```yaml in: query name: assignees description: > Filters the returned cases by assignees. Valid values are `none` or unique identifiers for the user profiles. These identifiers can be found by using the suggest user profile API. ``` would generate: ```ts export type assignees = z.infer<typeof assignees>; // <-- ESLint error export const assignees = z.array(...) ``` This PR adds a transformSchemaName option that allows to transform the schema names to `PascalCase`. That allows us to generate the correct schema names without having to touch the API documentation yaml files. This is the code that is generated with `transformSchemaName` set to `pascalCase`. ```ts export type Assignees = z.infer<typeof Assignees>; export const Assignees = z.array(...) ``` For now `transformSchemaName` only supports `pascalCase` but it can be extended in the future. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Michael Olorunnisola <michael.olorunnisola@elastic.co> (cherry picked from commit cb8b556) # Conflicts: # src/platform/packages/shared/kbn-openapi-generator/src/parser/get_generation_context.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/attack_discovery/common_attributes.gen.ts # x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/api/model/exception_list_common.gen.ts # x-pack/solutions/security/plugins/security_solution/common/api/endpoint/actions/file_download/file_download.gen.ts # x-pack/solutions/security/plugins/security_solution/common/api/endpoint/actions/file_info/file_info.gen.ts # x-pack/solutions/security/plugins/security_solution/common/api/endpoint/actions/response_actions/run_script/run_script.gen.ts # x-pack/solutions/security/plugins/security_solution/common/api/endpoint/model/schema/common.gen.ts # x-pack/solutions/security/plugins/security_solution/common/api/entity_analytics/monitoring/monitoring_entity_source/monitoring_entity_source.gen.ts
Contributor
|
CI was triggered for this PR, but this PR targets 9.1 which should not receive a future release. CI is not supported for these branches. Please consult the release schedule, or contact The following branches are currently considered to be open:
|
1 similar comment
Contributor
|
CI was triggered for this PR, but this PR targets 9.1 which should not receive a future release. CI is not supported for these branches. Please consult the release schedule, or contact The following branches are currently considered to be open:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
mainto9.1:transformSchemaNameconfig options (#250857)Questions ?
Please refer to the Backport tool documentation