Merge pull request #500 from tdakkota/feat/ref-pathitem

feat(openapi): support Path Item references

_testdata/negative/cyclic/example.json

@@ -0,0 +1,39 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "title",
+    "version": "v0.1.0"
+  },
+  "paths": {
+    "/foo": {
+      "get": {
+        "parameters": [
+          {
+            "name": "param",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "examples": {
+              "ParameterExample": {
+                "$ref": "#/components/examples/Example"
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "User info"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "examples": {
+      "Example": {
+        "$ref": "#/components/examples/Example"
+      }
+    }
+  }
+}

_testdata/negative/cyclic/pathItem.json

@@ -0,0 +1,19 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "title",
+    "version": "v0.1.0"
+  },
+  "paths": {
+    "/foo": {
+      "$ref": "#/components/pathItems/PathItem"
+    }
+  },
+  "components": {
+    "pathItems": {
+      "PathItem": {
+        "$ref": "#/components/pathItems/PathItem"
+      }
+    }
+  }
+}

_testdata/negative/null/components_pathItem.json

@@ -0,0 +1,17 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "title",
+    "version": "v0.1.0"
+  },
+  "paths": {
+    "/foo": {
+      "$ref": "#/components/pathItems/PathItem"
+    }
+  },
+  "components": {
+    "pathItems": {
+      "PathItem": null
+    }
+  }
+}

_testdata/positive/referenced_pathItem.json

@@ -0,0 +1,32 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "title",
+    "version": "v0.1.0"
+  },
+  "paths": {
+    "/foo": {
+      "$ref": "#/components/pathItems/Foo"
+    }
+  },
+  "components": {
+    "pathItems": {
+      "Foo": {
+        "get": {
+          "responses": {
+            "200": {
+              "description": "Response",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

internal/generate.go

@@ -17,4 +17,6 @@ package internal
 //go:generate go run ../cmd/ogen -v --clean --target test_http_requests   ../_testdata/positive/http_requests.json
 //go:generate go run ../cmd/ogen -v --clean --target test_form            ../_testdata/positive/form.json
 //
+//go:generate go run ../cmd/ogen -v --clean --target referenced_path_item ../_testdata/positive/referenced_pathItem.json
+//
 //go:generate go run ../cmd/ogen -v --clean --generate-tests --target test_allof ../_testdata/positive/allof.yml

internal/jsonpointer/jsonpointer.go

@@ -13,6 +13,9 @@ import (
 // Resolve takes given pointer and returns byte slice of requested value if any.
 // If value not found, returns NotFoundError.
 func Resolve(ptr string, node *yaml.Node) (*yaml.Node, error) {
+	if node == nil {
+		return nil, errors.New("root is nil")
+	}
 	if node.Kind == yaml.DocumentNode && len(node.Content) > 0 {
 		node = node.Content[0]
 	}

internal/jsonpointer/jsonpointer_test.go

@@ -105,6 +105,15 @@ func TestSpecification(t *testing.T) {
 	}
 }
 
+func TestResolveNilNode(t *testing.T) {
+	a := require.New(t)
+	var err error
+	a.NotPanics(func() {
+		_, err = Resolve("", nil)
+	})
+	a.EqualError(err, "root is nil")
+}
+
 func BenchmarkResolve(b *testing.B) {
 	var specExample = getNode(b, []byte(`{
   "openapi": "3.0.3",