fix: Add resource description (#65)

* Add resource.description * Update test snapshots * Add description to the fixture resource foo * ci: Format code * fix: Correctly determine resource property format (#66) * Add format to PropertySchema to correctly determine resource property format * Update test snapshots --------- Co-authored-by: Seam Bot <[email protected]>
seamapi · Aug 26, 2024 · 0e3e9eb · 0e3e9eb
1 parent ec65c43
commit 0e3e9eb
Show file tree

Hide file tree

Showing 6 changed files with 5 additions and 0 deletions.
diff --git a/src/lib/blueprint.ts b/src/lib/blueprint.ts
@@ -31,6 +31,7 @@ export interface Route {
 export interface Resource {
   resourceType: string
   properties: Property[]
+  description: string
 }
 
 export interface Namespace {
@@ -393,6 +394,7 @@ const createResources = (
           [schemaName]: {
             resourceType: schemaName,
             properties: createProperties(schema.properties),
+            description: schema.description ?? '',
           },
         }
       }

diff --git a/test/fixtures/types/openapi.ts b/test/fixtures/types/openapi.ts
@@ -7,6 +7,7 @@ export default {
     schemas: {
       foo: {
         type: 'object',
+        description: 'A foo resource.',
         properties: {
           foo_id: {
             description: 'Foo id',

diff --git a/test/snapshots/blueprint.test.ts.md b/test/snapshots/blueprint.test.ts.md
@@ -11,6 +11,7 @@ Generated by [AVA](https://avajs.dev).
     {
       resources: {
         foo: {
+          description: 'A foo resource.',
           properties: [
             {
               deprecationMessage: '',

diff --git a/test/snapshots/blueprint.test.ts.snap b/test/snapshots/blueprint.test.ts.snap
diff --git a/test/snapshots/seam-blueprint.test.ts.md b/test/snapshots/seam-blueprint.test.ts.md
@@ -11,6 +11,7 @@ Generated by [AVA](https://avajs.dev).
     {
       resources: {
         acs_system: {
+          description: 'Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
           properties: [
             {
               deprecationMessage: '',

diff --git a/test/snapshots/seam-blueprint.test.ts.snap b/test/snapshots/seam-blueprint.test.ts.snap