Skip to content
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.

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

[Generator] Rendering string constants and anyOf with complex members #887

Merged
merged 1 commit into from
Oct 22, 2024

Conversation

nhtruong
Copy link
Collaborator

@nhtruong nhtruong commented Oct 22, 2024

This PR is to address the issues in #886.


1. Added ability to render string constants:

To add more info for each member of the ExpandWildcard enum, we have converted its schema into an oneOf object where each member is a string constant. This changes causes the generator to create:
type ExpandWildcard = 'string' | 'string' | 'string' | 'string' | 'string'
instead of
type ExpandWildcard = 'all' | 'closed' | 'hidden' | 'none' | 'open'
we're adding another guard to handle const for the renderer.


2. Added ability to render anyOf objects where members can be anonymous objects:

The InlineScript is now an anyOf object where a member is a string, and another is a complex anonymous object, previously the generator will do:

export type InlineScript = string | extends ScriptBase {
  lang?: ScriptLanguage;
  options?: Record<string, string>;
  source: string;
})

which is not a valid type definition. The changes in render_anyOf and render_allOf functions will render

export type InlineScript = string | (ScriptBase & {
  lang?: ScriptLanguage;
  options?: Record<string, string>;
  source: string;
})

3. All type definitions are now type instead of a mix of type and interface

Previously the generator would generate interface X whenever possible and would generate type X = when not. The reason? Precedence. So we ended up with a mix of type and interface declarations. These changes [1], [2], [3], simplifies the rendering logic to always render type, which is also a lot more flexible (which enables change No.2 above) and better mirror JSON Schema's allOf


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

- Added ability to render string constants
- Added ability to render anyOf objects where members can be anonymous compound objects (allOf)
- All type definitions are now `type` instead of a mix of `type` and `interface`

Signed-off-by: Theo Truong <[email protected]>
@dblock dblock merged commit 9288450 into opensearch-project:main Oct 22, 2024
56 of 59 checks passed
@nhtruong nhtruong deleted the api_gen/fix branch October 23, 2024 20:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants