Suport arbitrary JSON pointer references

References in API specs can contain characters which require escaping as
described in [RFC 6901](https://tools.ietf.org/html/rfc6901). Forward
slashes are particularly common in API specs since they are used as path
item key. For example, [PagerDuty's
spec](https://raw.githubusercontent.com/PagerDuty/api-schema/master/reference/REST/openapiv3.json)
makes heavy use of them and can't be currently be imported. With this
change, import works.

Signed-off-by: Matthieu Monsch <[email protected]>

Author: mtth

packages/openapi-to-graphql/package-lock.json

@@ -71,6 +71,7 @@
     "form-urlencoded": "^4.1.1",
     "graphql-subscriptions": "^1.1.0",
     "graphql-type-json": "^0.2.1",
+    "json-ptr": "^1.2.0",
     "jsonpath-plus": "^3.0.0",
     "oas-validator": "^3.1.0",
     "pluralize": "^8.0.0",

packages/openapi-to-graphql/package.json

@@ -40,6 +40,7 @@ import * as Swagger2OpenAPI from 'swagger2openapi'
 import * as OASValidator from 'oas-validator'
 import debug from 'debug'
 import { handleWarning } from './utils'
+import * as jsonptr from 'json-ptr'
 import * as pluralize from 'pluralize'
 
 // Type definitions & exports:
@@ -231,37 +232,7 @@ export function countOperationsWithPayload(oas: Oas3): number {
  * Resolves the given reference in the given object.
  */
 export function resolveRef(ref: string, oas: Oas3): any {
-  // Break path into individual tokens
-  const parts = ref.split('/')
-  const resolvedObject = resolveRefHelper(oas, parts)
-
-  if (resolvedObject !== null) {
-    return resolvedObject
-  } else {
-    throw new Error(
-      `Could not resolve reference '${ref}' in OAS '${oas.info.title}'`
-    )
-  }
-}
-
-/**
- * Helper for resolveRef
- *
- * @param parts The path to be resolved, but broken into tokens
- */
-function resolveRefHelper(obj: object, parts?: string[]): any {
-  if (parts.length === 0) {
-    return obj
-  }
-
-  const firstElement = parts.splice(0, 1)[0]
-  if (firstElement in obj) {
-    return resolveRefHelper(obj[firstElement], parts)
-  } else if (firstElement === '#') {
-    return resolveRefHelper(obj, parts)
-  } else {
-    return null
-  }
+  return jsonptr.get(oas, ref)
 }
 
 /**

packages/openapi-to-graphql/src/oas_3_tools.ts

@@ -14,6 +14,7 @@ const {
   graphql
 } = require('graphql')
 import * as Oas3Tools from '../lib/oas_3_tools'
+import { PathItemObject } from '../lib/types/oas3'
 
 test('Applying sanitize multiple times does not change outcome', () => {
   const str = 'this Super*annoying-string()'
@@ -180,3 +181,38 @@ test('Properly treat null values during sanitization', () => {
     })
   })
 })
+
+test('Handle encoded JSON pointer references', () => {
+  const oas = {
+    openapi: '3.0.0',
+    info: {
+      title: 'test',
+      version: '0.0.1'
+    },
+    paths: {
+      '/users': getPathItemObject('all'),
+      '/users/{id}': getPathItemObject('one')
+    }
+  }
+
+  expect(Oas3Tools.resolveRef('/openapi', oas)).toBe('3.0.0')
+  expect(Oas3Tools.resolveRef('/paths/~1users/description', oas)).toBe('all')
+  expect(Oas3Tools.resolveRef('#/paths/~1users/description', oas)).toBe('all')
+  expect(
+    Oas3Tools.resolveRef('#/paths/~1users~1%7bid%7d/description', oas)
+  ).toBe('one')
+
+  function getPathItemObject(description): PathItemObject {
+    return {
+      description,
+      get: {},
+      put: {},
+      post: {},
+      delete: {},
+      options: {},
+      head: {},
+      patch: {},
+      trace: {}
+    }
+  }
+})