SwaggerEditor@next: unescaped autocompletion of references

[char0n]

Q&A (please complete the following information)

• OS: Linux Mint
• Browser: Chrome
• Version: 107.0.5304.87 (Official Build) (64-bit)
• Method of installation: https://swagger-editor-next.surge.sh/
• Swagger-Editor version:
  

Content & configuration

Example Swagger/OpenAPI definition:

openapi: 3.1.0
info:
  title: deref
  version: 1.0.0
servers:
  - description: local
    url: http://localhost:8082/
paths:
  /path/segment1/segment2:
    get:
      operationId: aget
    post:
      operationId: apost
components:
  pathItems: 
    pathItem1:
      $ref: '#/paths//path/segment1/segment2'

Describe the bug you're encountering

When autocompletion of components.pathItems.pathItem1.$ref is performed, the '#/paths//path/segment1/segment2' will be suggested and inserted. That's incorrect, because the text should be inserted in JSON Pointer encoded form: '#/~1paths~1path~1segment1~1segment2'.

NOTE: also notice that there are two un-escaped backslashes instead of one: '#/paths//path/segment1/segment2'

To reproduce...

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior

Suggestion shows unescaped form of the future inserted text, but the insertion will insert properly JSON Pointer encoded text.

Screenshots

Additional context

Note that apidom-json-pointer package contains all the tooling needed to implement this fix: https://github.com/swagger-api/apidom/blob/main/packages/apidom-json-pointer/README.md#escaping

[ponelat]

Ran into this as well for $ref inside of a Webhook.

Both the suggestion and the completion have an unescaped / which also resolves (i.e., works even though it should not).
Expected: #/paths/~1foo/ got #/paths//foo.

Update: If I manually type out the $ref it does not resolve!

[frantuma]

fixed in swagger-api/apidom#2975