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

Determine if Aliases are required in the spec #48

Open
frankkilcommins opened this issue Apr 14, 2023 · 1 comment
Open

Determine if Aliases are required in the spec #48

frankkilcommins opened this issue Apr 14, 2023 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@frankkilcommins
Copy link
Collaborator

As a working group we've discussed the potential need for having aliases to facilitate codegen use-cases.

Currently, when referencing an operationId within a source specification document, you MUST prefix it with the source name if more than one source exists to avoid collisions. This is stated as follows in the spec:

If more than one source document is defined within a Workflows document, then the operationId specified MUST be prefixed with the source name to avoid ambiguity or potential clashes.

While the above approach ensures clarity within the Workflows Specification, it does not necessarily help codegen tools form figuring out how to name source1.opName and source2.opName to two different meaningful class or function names.

Should we add the ability to support aliases within the core spec, or perhaps we should auto an official codegen extension for the specification.

@kevin-postman
Copy link

@frankkilcommins I am thinking the "if more than one source exists" part should not be an option.. e.g. we should always prefix a reference with the source even if only one exists. I'll play around with this along with aliases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants