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

Typo in Step Object operationPath fixed field description #282

Closed
leidenheit opened this issue Nov 20, 2024 · 0 comments · Fixed by #318
Closed

Typo in Step Object operationPath fixed field description #282

leidenheit opened this issue Nov 20, 2024 · 0 comments · Fixed by #318
Labels
documentation Improvements or additions to documentation

Comments

@leidenheit
Copy link

The Arazzo Specification 1.0.0 references to a Source Description Object in the description of operationPath in a Step Object. However, this is an ambiguous phrasing and should be streamlined.

Current State
The description states as follows:

A reference to a Source combined with a JSON Pointer to reference an operation. [...]

Problem
Ambiguity in Phrasing: For clarity, readers should be presented with streamlined phrasing across the entire specification.

Proposed Solution
Streamline the phrasing:

A reference to a Source Description Object combined with a JSON Pointer to reference an operation. [...]

Benefits

  • Enhances the clarity of the specification.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
2 participants