Repository navigation
link object: operationId / operationRef descriptions #1267
Description
In the following:
| Field Name | Type | Description |
|---|---|---|
| operationRef | string |
A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. |
| operationId | string |
The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field. Relative operationRef values MAY be used to locate an existing Operation Object in the OAS. |
Should the final sentence be moved / removed / merged in with the description for operationRef, or is it correct to have it against operationdId ?
Activity
darrelmiller commentedon Jul 13, 2017
I think the "relative" sentence should be moved into the operationRef paragraph and the "mutually exclusive" sentence should be duplicated in operationRef but for the opposite case. I'd do the PR but I don't have time today.
DavidBiesack commentedon Jul 13, 2017
I made a PR for this, #1268 . Note that the "mutually exclusive" sentence was already in
operationRef. I also changed "in the OAS" (which was wrong) to "in the OpenAPI definition" (but that language may change if another term is adopted in #1247)Merge pull request #1268 from DavidBiesack/OperationId-Ref