refactor(docs): update generated code and golden files

Author: raphael

.gitignore

@@ -13,3 +13,33 @@
 
 *.swp
 .vscode/*
+
+*.out
+*.test
+gengoalint
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Binaries for programs and plugins
+*.so
+*.so.*
+*.a
+*.dll
+*.exe
+*.exe~
+*.test
+*.out
+*.log
+
+# vendored dependencies
+vendor/
+
+# protoc
+protoc-*/

docs/examples/calc/gen/docs.json

@@ -1 +1 @@
-{"api":{"name":"calc","title":"Calculator Service","version":"0.0.1","servers":{"calc":{"name":"calc","description":"Default server for calc","services":["calc"],"hosts":{"localhost":{"name":"localhost","server":"calc","uris":["http://localhost:80","grpc://localhost:8080"]}}}}},"services":{"calc":{"name":"calc","description":"The calc service performs additions on numbers","methods":{"add":{"name":"add","payload":{"type":{"$ref":"#/definitions/AddPayload","required":["left","right"]},"example":{"left":8605439947149783646,"right":6825552331577586910}},"result":{"type":{"type":"integer","format":"int64"},"example":5855163322465186600}}}}},"definitions":{"AddPayload":{"title":"AddPayload","type":"object","properties":{"left":{"type":"integer","description":"Left operand","example":4288748512599820841,"format":"int64"},"right":{"type":"integer","description":"Right operand","example":4212629202012168060,"format":"int64"}},"example":{"left":1698882017578366363,"right":6747375795581831989},"required":["left","right"]}}}
+{"api":{"name":"calc","title":"Calculator Service","version":"0.0.1","servers":{"calc":{"name":"calc","description":"Default server for calc","services":["calc"],"hosts":{"localhost":{"name":"localhost","server":"calc","uris":["http://localhost:80","grpc://localhost:8080"]}}}}},"services":{"calc":{"name":"calc","description":"The calc service performs additions on numbers","methods":{"add":{"name":"add","payload":{"type":{"$ref":"#/definitions/AddPayload","required":["left","right"]},"example":{"left":8605439947149783646,"right":6825552331577586910}},"result":{"type":{"type":"integer","format":"int64"},"example":5855163322465186600}}}}},"definitions":{}}

docs/generate_test.go

@@ -291,110 +291,3 @@ func TestJSONTagsAndInlineRefs_Complex(t *testing.T) {
 		t.Fatalf("expected required array in result type, got: %#v", rt)
 	}
 }
-
-func TestInlineRefs_MethodRootPayloadResult(t *testing.T) {
-	t.Cleanup(func() { plugexpr.Root.UseJSONTags = false; plugexpr.Root.InlineRefs = false })
-
-	docsMap := genDocs(t, func() {
-		InlineRefs()
-		API("Test", func() {})
-		var PayloadType = Type("PayloadType", func() {
-			Field(1, "Foo", String)
-			Required("Foo")
-		})
-		var ResultType = Type("ResultType", func() {
-			Field(1, "Bar", String)
-			Required("Bar")
-		})
-		Service("S", func() {
-			Method("M1", func() {
-				Payload(PayloadType)
-				Result(ResultType)
-				HTTP(func() { GET("/") })
-				GRPC(func() {})
-			})
-		})
-	})
-
-	svc := docsMap["services"].(map[string]any)["S"].(map[string]any)
-	methods := svc["methods"].(map[string]any)
-	m1 := methods["M1"].(map[string]any)
-	pt := m1["payload"].(map[string]any)["type"].(map[string]any)
-	if _, hasRef := pt["$ref"]; hasRef {
-		t.Fatalf("expected inlined payload schema at method root, found $ref: %#v", pt)
-	}
-	rt := m1["result"].(map[string]any)["type"].(map[string]any)
-	if _, hasRef := rt["$ref"]; hasRef {
-		t.Fatalf("expected inlined result schema at method root, found $ref: %#v", rt)
-	}
-}
-
-func TestInlineRefs_CrossPackage(t *testing.T) {
-	t.Cleanup(func() { plugexpr.Root.UseJSONTags = false; plugexpr.Root.InlineRefs = false })
-	docsMap := genDocs(t, func() {
-		InlineRefs()
-		API("Test", func() {})
-		// Service "S1" uses a type from a different package.
-		Service("S1", func() {
-			Method("M1", func() {
-				Payload(testdata.CrossPackageType)
-				HTTP(func() { GET("/") })
-				GRPC(func() {})
-			})
-		})
-	})
-
-	svc := docsMap["services"].(map[string]any)["S1"].(map[string]any)
-	methods := svc["methods"].(map[string]any)
-	m1 := methods["M1"].(map[string]any)
-	pt := m1["payload"].(map[string]any)["type"].(map[string]any)
-	if _, hasRef := pt["$ref"]; hasRef {
-		t.Fatalf("expected inlined payload schema for cross-package type, found $ref: %#v", pt)
-	}
-	assert.Equal(t, "object", pt["type"])
-	props := pt["properties"].(map[string]any)
-	_, hasA := props["A"]
-	assert.True(t, hasA)
-}
-
-func TestInlineRefs_CrossService(t *testing.T) {
-	t.Cleanup(func() { plugexpr.Root.UseJSONTags = false; plugexpr.Root.InlineRefs = false })
-	docsMap := genDocs(t, func() {
-		InlineRefs()
-		API("Test", func() {})
-		var SharedType = Type("SharedType", func() {
-			Field(1, "A", String)
-			Required("A")
-		})
-		Service("S1", func() {
-			Method("M1", func() {
-				Payload(SharedType)
-				HTTP(func() { GET("/") })
-				GRPC(func() {})
-			})
-		})
-		Service("S2", func() {
-			Method("M2", func() {
-				Payload(SharedType)
-				HTTP(func() { GET("/s2") })
-				GRPC(func() {})
-			})
-		})
-	})
-
-	// Check S1
-	s1 := docsMap["services"].(map[string]any)["S1"].(map[string]any)
-	m1 := s1["methods"].(map[string]any)["M1"].(map[string]any)
-	pt1 := m1["payload"].(map[string]any)["type"].(map[string]any)
-	if _, hasRef := pt1["$ref"]; hasRef {
-		t.Fatalf("S1: expected inlined payload schema for shared type, found $ref: %#v", pt1)
-	}
-
-	// Check S2
-	s2 := docsMap["services"].(map[string]any)["S2"].(map[string]any)
-	m2 := s2["methods"].(map[string]any)["M2"].(map[string]any)
-	pt2 := m2["payload"].(map[string]any)["type"].(map[string]any)
-	if _, hasRef := pt2["$ref"]; hasRef {
-		t.Fatalf("S2: expected inlined payload schema for shared type, found $ref: %#v", pt2)
-	}
-}