interagent / interagent/committee

$ref with JSON pointer containing `~1` (encoded `/`) not supported

Open
#336 0 comments 5 reactions 1 assignee View on GitHub

@ota42y is already working on this.

Since Nov 25, 2021.

bug ready
Dominant language
Ruby
Stars
955
Forks
145
Avg merge
5d 4h
Merged PRs (30d)
6

Description

I have document with a $ref for an operation of the form

openapi: 3.0.1
# ...
paths:
  /resource/test:
    $ref: `file.yaml#/paths/~1resource~1test`

and file.yaml contains

paths:
  /resource/test:
    summary: ... 
    description: ...
    # ...

Committee gives an error that the $ref is not an URI, while it is a valid URI with a fragment containing a JSON pointer.

If I make the $ref into something like file.yaml#/paths/resource, and replace the path in file.yaml with resource, it does work and Committee gives no errors.

JSON pointer spec: https://datatracker.ietf.org/doc/html/rfc6901

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.