OAI / OAI/OpenAPI-Specification
Link Object (and Arazzo?): require referencing operation with unambiguous path template
Open
Nobody has claimed this yet.
bug
re-use: ref/id resolution
- Dominant language
- Markdown
- Stars
- 31.2k
- Forks
- 9.2k
- Avg merge
- 6h 37m
- Merged PRs (30d)
- 27
Description
Assume paths /foo and /bar both have a Path Item Object that $ref the same external "complete" Path Item Object.
If a Link Object now operationRefs the get Operation Object within that external Path Item Object, which request should the client construct?
It could be both
GET /fooorGET /bar
Proposal:
- Add restriction to Link Object that
operationRefandoperationIdMUST NOT reference a reusable/multi-used Path Item Object - Possibly: require that the
operationRefvalue "goes through" a Paths Object
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the Link Object and Arazzo operationRef definitions, then compare them with Paths Object and reusable Path Item behavior described in the specification. Done means the specification clearly defines whether operationRef and operationId may target reused Path Item Objects and how an unambiguous request path is determined.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100