Revert changes to 1.0.0.md to match main #312
Merged
Conversation
This file contains 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
ndenny
approved these changes
Jan 8, 2025
kevinduffey
reviewed
Jan 9, 2025
| @@ -71,7 +71,7 @@ In order to preserve the ability to round-trip between YAML and JSON formats, YA | |||
|
|
|||
| It is RECOMMENDED that the entry Arazzo document be named: `arazzo.json` or `arazzo.yaml`. | |||
|
|
|||
| An Arazzo Description MAY be made up of a single document or be divided into multiple, connected parts at the discretion of the author. If workflows from other documents are being referenced, they MUST be included as a [Source Description Object](#source-description-object). In a multi-document description, the document containing the [Arazzo Specification Object](#arazzo-specification-object) is known as the **entry Arazzo document**. | |||
| An Arazzo Description MAY be made up of a single document or be divided into multiple, connected parts at the discretion of the author. If workflows from other documents are being referenced, they must by included as a [Source Description Object](#source-description-object). In a multi-document description, the document containing the [Arazzo Specification Object](#arazzo-specification-object) is known as the **entry Arazzo document**. | |||
There was a problem hiding this comment.
"must by" should be "must be"
| <a name="parameterIn"></a> in | `string` | The location of the parameter. Possible values are `"path"`, `"query"`, `"header"`, or `"cookie"`. When the step in context specifies a `workflowId`, then all parameters map to workflow inputs. In all other scenarios (e.g., a step specifies an `operationId`), the `in` field MUST be specified. | ||
| <a name="parameterValue"></a> value | Any \| {expression} | **REQUIRED**. The value to pass in the parameter. The value can be a constant or a [Runtime Expression](#runtime-expressions) to be evaluated and passed to the referenced operation or workflow. | ||
| <a name="parameterIn"></a> in | `string` | The name location of the parameter. Possible values are `"path"`, `"query"`, `"header"`, `"cookie"`, or `"body"`. When the step in context specifies a `workflowId`, then all parameters map to workflow inputs. In all other scenarios (e.g., a step specifies an `operationId`), the `in` field MUST be specified. | ||
| <a name="parameterValue"></a> value | Any \| {expression} | **REQUIRED**. The value to pass in the parameter. The value can be a constant or an [Runtime Expression](#runtime-expressions) to be evaluated and passed to the referenced operation or workflow. |
There was a problem hiding this comment.
is it 'an' or 'a'? I see it was 'a'. Not sure why this is now 'an'? Not a big deal but just pointing out.. 'an' should be before a vowel and [Runtime..] is not a vowel. Not bothered either way just noticed this. Also.. in a few other places you have 'a [Runtime...] so probably best to be consistent. (line 424, 457, etc)
| @@ -820,12 +820,12 @@ This object MAY be extended with [Specification Extensions](#specification-exten | |||
|
|
|||
|
|
|||
| ### Runtime Expressions | |||
| A runtime expression allows values to be defined based on information that will be available within the HTTP message in an actual API call, or within objects serialized from the Arazzo document such as [workflows](#workflow-object) or [steps](#step-object). | |||
| A runtime expression allows values to be defined based on information that will be available within an HTTP message, an event message, and within objects serialized from the Arazzo document such as [workflows](#workflow-object) or [steps](#step-object). | |||
There was a problem hiding this comment.
'an' or 'a'? Why change it from 'the'? Oddly.. "an" reads better next to HTTP "an HTTP" vs "a HTTP" but grammatically not sure it is correct. OK.. just for clarity I looked it up and apparently (and this is either new to me or I literally forgot my grammar from grade school!) because H is silent and it sounds like a vowel sound at the beginning.. you use 'an'. Learn something new every day.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Interim changes happened to 1.0.0.md as part of the v1.0.0-dev branch prior to adopting the new branching/contribution process.
These were not reverted. Rather than rewriting history and because we move changes from
1.0.0.mdtoarazzo.mdas part of adopting consistent strategy, this revert will be committed to history for clarity.