fix: match _id for path params

path params missed an _id suffix, which causes 
invalid OAS documentation.

Author: toumorokoshi

pkg/api/openapi.go

@@ -492,9 +492,6 @@ func generateParentPatternsWithParams(r *Resource) (string, *[]PathWithParams) {
 			pElem := r.patternElems[i+1]
 			// Extract the parameter name without the _id suffix
 			paramName := pElem[1 : len(pElem)-1]
-			if strings.HasSuffix(paramName, "_id") {
-				paramName = paramName[:len(paramName)-3]
-			}
 			params = append(params, openapi.Parameter{
 				In:       "path",
 				Name:     paramName,
@@ -518,11 +515,11 @@ func generateParentPatternsWithParams(r *Resource) (string, *[]PathWithParams) {
 	for _, parent := range r.ParentResources() {
 		singular := parent.Singular
 		// Convert kebab-case singular to snake_case for path variables
-		singularSnake := cases.KebabToSnakeCase(singular)
-		basePattern := fmt.Sprintf("/%s/{%s_id}", CollectionName(parent), singularSnake)
+		singularSnakeParam := cases.KebabToSnakeCase(singular) + "_id"
+		basePattern := fmt.Sprintf("/%s/{%s}", CollectionName(parent), singularSnakeParam)
 		baseParam := openapi.Parameter{
 			In:       "path",
-			Name:     singularSnake,
+			Name:     singularSnakeParam,
 			Required: true,
 			Schema: &openapi.Schema{
 				Type: "string",

pkg/api/openapi_test.go

@@ -316,7 +316,7 @@ func TestGenerateParentPatternsWithParams(t *testing.T) {
 					Params: []openapi.Parameter{
 						{
 							In:       "path",
-							Name:     "database",
+							Name:     "database_id",
 							Required: true,
 							Schema: &openapi.Schema{
 								Type: "string",
@@ -363,7 +363,7 @@ func TestGenerateParentPatternsWithParams(t *testing.T) {
 					Params: []openapi.Parameter{
 						{
 							In:       "path",
-							Name:     "database",
+							Name:     "database_id",
 							Required: true,
 							Schema: &openapi.Schema{
 								Type: "string",
@@ -401,7 +401,7 @@ func TestGenerateParentPatternsWithParams(t *testing.T) {
 					Params: []openapi.Parameter{
 						{
 							In:       "path",
-							Name:     "account",
+							Name:     "account_id",
 							Required: true,
 							Schema: &openapi.Schema{
 								Type: "string",
@@ -412,7 +412,7 @@ func TestGenerateParentPatternsWithParams(t *testing.T) {
 						},
 						{
 							In:       "path",
-							Name:     "database",
+							Name:     "database_id",
 							Required: true,
 							Schema: &openapi.Schema{
 								Type: "string",

pkg/api/resource.go

@@ -9,6 +9,14 @@ import (
 )
 
 type Resource struct {
+	// the resource singular name is the name of the resource
+	// in the API. It is used to generate the pattern for the resource.
+	// e.g: book-edition -> book-editions
+	//
+	// The singular name is also used to generate the schema name.
+	// e.g: book-edition -> BookEdition
+	//
+	// the resource singular **must** be in kebab-case.
 	Singular        string      `json:"singular"`
 	Plural          string      `json:"plural"`
 	Parents         []string    `json:"parents,omitempty"`