OAI / OAI/Arazzo-Specification

Determine if Aliases are required in the spec

Open
#48 1 comment 0 reactions 1 assignee View on GitHub

@kevin-postman is already working on this.

Since May 30, 2023.

enhancement
Dominant language
JavaScript
Stars
471
Forks
69
Avg merge
17h 58m
Merged PRs (30d)
19

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.