Merge pull request #356 from pace/generate-links-struct

Generate json api "links" struct when specified in spec
pace · Oct 4, 2023 · 15d75b6 · 15d75b6
2 parents 59f1d9a + 6b1f7a6
commit 15d75b6
Show file tree

Hide file tree

Showing 3 changed files with 178 additions and 3 deletions.
diff --git a/http/jsonapi/generator/generate_types.go b/http/jsonapi/generator/generate_types.go
@@ -246,6 +246,17 @@ func (g *Generator) structJSONAPI(prefix string, stmt *jen.Statement, schema *op
 		fields = append(fields, attrFields...)
 	}
 
+	// add links attribute
+	links := schema.Properties["links"]
+	if links != nil {
+		linksAttr := jen.Id("Links")
+		err := g.buildTypeStruct(prefix+"Links", linksAttr, links.Value, true)
+		if err != nil {
+			return err
+		}
+		fields = append(fields, linksAttr)
+	}
+
 	// att meta attribute
 	meta := schema.Properties["meta"]
 	if meta != nil {

diff --git a/http/jsonapi/generator/internal/articles/open-api.json b/http/jsonapi/generator/internal/articles/open-api.json
@@ -52,6 +52,42 @@
                         "description": "Not found"
                     }
                 }
+            },
+            "get": {
+                "tags": [
+                    "Article"
+                ],
+                "operationId": "getArticleComments",
+                "summary": "Gets the Article's Comments",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "uuid",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        },
+                        "description": "Article ID"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Comments",
+                        "content": {
+                            "application/vnd.api+json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/Comments"
+                                }
+                            }
+                        }
+                    },
+                    "204": {
+                        "description": "No content"
+                    },
+                    "404": {
+                        "description": "Not found"
+                    }
+                }
             }
         },
         "/api/articles/{uuid}/relationships/inline": {
@@ -179,6 +215,16 @@
                         "type": "string",
                         "format": "uuid"
                     },
+                    "links": {
+                        "type": "object",
+                        "properties": {
+                            "href": {
+                                "type": "string",
+                                "example": "https://example.com",
+                                "description": "Link to comment"
+                            }
+                        }
+                    },
                     "attributes": {
                         "type": "object",
                         "properties": {

diff --git a/http/jsonapi/generator/internal/articles/open-api_test.go b/http/jsonapi/generator/internal/articles/open-api_test.go