docs: fix bookstore example

The bookstore example serves as a helpful reference,
so it should be working.

Author: toumorokoshi

examples/resource-definitions/bookstore.yaml

@@ -5,11 +5,11 @@ contact:
   name: "API support"
   email: "aepsupport@aep.dev"
 resources:
-  # example of a simple resource
-  - &publisher
-    kind: "publisher"
+  publisher: &publisher
+    singular: "publisher"
     plural: "publishers"
     schema:
+      type: object
       properties:
         description:
           type: string
@@ -23,40 +23,40 @@ resources:
         supports_filter: true
         supports_skip: true
       apply: {}
-  # example of a child resource
-  - &book
-    kind: "book"
+  book: &book
+    singular: "book"
     plural: "books"
-    # the parents should specify the parents of the resource. It takes in the
-    # kind.
     parents:
       - *publisher
-    properties:
+    schema:
+      type: object
       required: ["author", "edition", "isbn", "price", "published"]
-      isbn:
-        type: array
-        items:
-          type: string
-        x-aep-field-number: 1
-      price:
-        type: number
-        x-aep-field-number: 2
-      published:
-        type: boolean
-        x-aep-field-number: 3
-      edition:
-        type: integer
-        x-aep-field-number: 4
-      author:
-        type: array
-        items:
-          properties:
-            firstName:
-              type: string
-              x-aep-field-number: 1
-            lastName:
-              type: string
-              x-aep-field-number: 2
+      properties:
+        isbn:
+          type: array
+          items:
+            type: string
+          x-aep-field-number: 1
+        price:
+          type: number
+          x-aep-field-number: 2
+        published:
+          type: boolean
+          x-aep-field-number: 3
+        edition:
+          type: integer
+          x-aep-field-number: 4
+        author:
+          type: array
+          items:
+            type: object
+            properties:
+              firstName:
+                type: string
+                x-aep-field-number: 1
+              lastName:
+                type: string
+                x-aep-field-number: 2
     methods:
       create: {}
       read: {}
@@ -67,7 +67,7 @@ resources:
       apply: {}
     custom_methods:
       - name: "archive"
-        method_type: POST
+        method: "POST"
         request:
           type: object
           properties: {}
@@ -76,34 +76,30 @@ resources:
           properties:
             success:
               type: boolean
-  # other example resources that might be interesting to add:
-  # authors, which could be a reference for book
-  # authors could have a reference to publishers too
-  # example of a child resource, with a redudant type name.
-  # aepc will remove the redundant component in the path pattern
-  - &book-edition
-    kind: "book-edition"
+  book-edition:
+    singular: "book-edition"
     plural: "book-editions"
-    # the parents should specify the parents of the resource. It takes in the
-    # kind.
     parents:
       - *book
-    properties:
+    schema:
+      type: object
       required: ["displayname"]
-      displayname:
-        type: string
-        x-aep-field-number: 1
+      properties:
+        displayname:
+          type: string
+          x-aep-field-number: 1
     methods:
       create: {}
       read: {}
       list: {}
       delete: {}
-  - kind: "isbn"
+  isbn:
+    singular: "isbn"
     plural: "isbns"
+    schema:
+      type: object
     properties: {}
     methods:
       read: {}
       list: {}
       create: {}
-      # blocked on https://github.com/aep-dev/api-linter/issues/97
-      # non_client_settable_id: true

pkg/api/api_test.go

@@ -1,10 +1,15 @@
 package api
 
 import (
+	"encoding/json"
+	"os"
+	"path/filepath"
 	"testing"
 
 	"github.com/aep-dev/aep-lib-go/pkg/openapi"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"gopkg.in/yaml.v3"
 )
 
 var basicOpenAPI = &openapi.OpenAPI{
@@ -568,3 +573,68 @@ func TestGetAPI(t *testing.T) {
 		})
 	}
 }
+
+func TestParseBookstoreYAMLDirectly(t *testing.T) {
+	// Construct the path relative to the test file's location
+	yamlPath := filepath.Join("..", "..", "examples", "resource-definitions", "bookstore.yaml")
+
+	// Read the YAML file
+	yamlData, err := os.ReadFile(yamlPath)
+	require.NoError(t, err, "Failed to read bookstore.yaml")
+	require.NotEmpty(t, yamlData, "bookstore.yaml is empty")
+
+	// Unmarshal YAML into a generic interface{}
+	var genericYamlData interface{}
+	err = yaml.Unmarshal(yamlData, &genericYamlData)
+	require.NoError(t, err, "Failed to unmarshal YAML into generic interface")
+
+	// Marshal the generic interface{} to JSON
+	jsonData, err := json.Marshal(genericYamlData)
+	require.NoError(t, err, "Failed to marshal generic interface to JSON")
+	require.NotEmpty(t, jsonData, "Resulting JSON data is empty")
+
+	// Attempt to unmarshal the JSON directly into api.API
+	var apiResult API
+	err = json.Unmarshal(jsonData, &apiResult)
+	require.NoError(t, err, "Failed to unmarshal JSON into api.API struct")
+
+	// Assert basic fields that might match (like Name, ServerURL, Contact)
+	assert.Equal(t, "bookstore.example.com", apiResult.Name, "API Name should be populated if field names match")
+	assert.Equal(t, "http://localhost:8081", apiResult.ServerURL, "API ServerURL should be populated based on json tag")
+	if assert.NotNil(t, apiResult.Contact, "Contact might be populated if fields match") {
+		assert.Equal(t, "API support", apiResult.Contact.Name)
+		assert.Equal(t, "aepsupport@aep.dev", apiResult.Contact.Email)
+	}
+
+	// Assert that Resources map IS populated correctly
+	assert.NotEmpty(t, apiResult.Resources, "Resources map should be populated")
+	assert.Contains(t, apiResult.Resources, "publisher", "Resources map should contain 'publisher'")
+	assert.Contains(t, apiResult.Resources, "book", "Resources map should contain 'book'")
+	assert.Contains(t, apiResult.Resources, "book-edition", "Resources map should contain 'book-edition'")
+	assert.Contains(t, apiResult.Resources, "isbn", "Resources map should contain 'isbn'")
+
+	// Check some details of a resource
+	publisherResource := apiResult.Resources["publisher"]
+	assert.NotNil(t, publisherResource, "'publisher' resource should not be nil")
+	assert.Equal(t, "publisher", publisherResource.Singular)
+	assert.Equal(t, "publishers", publisherResource.Plural)
+	assert.NotNil(t, publisherResource.Schema, "'publisher' resource schema should not be nil")
+	assert.Equal(t, "object", publisherResource.Schema.Type)
+	assert.Contains(t, publisherResource.Schema.Properties, "description")
+	assert.Equal(t, "string", publisherResource.Schema.Properties["description"].Type)
+	assert.NotNil(t, publisherResource.Methods.List, "'publisher' should have List method")
+	assert.True(t, publisherResource.Methods.List.SupportsFilter)
+
+	// Check book resource details, including custom method
+	bookResource := apiResult.Resources["book"]
+	assert.NotNil(t, bookResource, "'book' resource should not be nil")
+	assert.Equal(t, "book", bookResource.Singular)
+	assert.Equal(t, "books", bookResource.Plural)
+	assert.NotNil(t, bookResource.Schema, "'book' resource schema should not be nil")
+	assert.Contains(t, bookResource.Schema.Properties, "isbn")
+	assert.Equal(t, "array", bookResource.Schema.Properties["isbn"].Type)
+	assert.NotNil(t, bookResource.Methods.List, "'book' should have List method")
+	assert.True(t, bookResource.Methods.List.HasUnreachableResources)
+	assert.Len(t, bookResource.CustomMethods, 1, "'book' should have 1 custom method")
+	assert.Equal(t, "archive", bookResource.CustomMethods[0].Name)
+}