Merge pull request #30 from HiDeoo/hd-fix-implicit-object

HiDeoo · Apr 18, 2024 · 6117d9a · 6117d9a
2 parents 5b27ed4 + a73ec81
commit 6117d9a
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 0 deletions.
diff --git a/packages/starlight-openapi/libs/schemaObject.ts b/packages/starlight-openapi/libs/schemaObject.ts
@@ -13,6 +13,7 @@ export function isParameterWithSchemaObject(parameter: Parameter): parameter is
 export function isSchemaObjectObject(schemaObject: SchemaObject): schemaObject is SchemaObject {
   return (
     schemaObject.type === 'object' ||
+    'properties' in schemaObject ||
     ('oneOf' in schemaObject && (schemaObject.oneOf as SchemaObject[]).some(isSchemaObjectObject)) ||
     ('anyOf' in schemaObject && (schemaObject.anyOf as SchemaObject[]).some(isSchemaObjectObject)) ||
     ('allOf' in schemaObject && (schemaObject.allOf as SchemaObject[]).some(isSchemaObjectObject))

diff --git a/packages/starlight-openapi/tests/requestBody.test.ts b/packages/starlight-openapi/tests/requestBody.test.ts
@@ -48,6 +48,13 @@ test('displays the request body for a v3.0 schema', async ({ docPage }) => {
   expect(await requestBody.getByRole('combobox').inputValue()).toBe('application/json')
 })
 
+test('supports schema object for implicit objects', async ({ docPage }) => {
+  await docPage.goto('/v3/animals/operations/hamsters')
+
+  await expect(docPage.getRequestBodyParameter('id')).toBeVisible()
+  await expect(docPage.getRequestBodyParameter('name')).toBeVisible()
+})
+
 test('supports schema object `allOf` property for explicit objects', async ({ docPage }) => {
   await docPage.goto('/v2/animals/operations/addcat/')
 

diff --git a/schemas/v3.0/animals.yaml b/schemas/v3.0/animals.yaml
@@ -311,6 +311,31 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+  /hamsters:
+    post:
+      summary: Creates a new hamster
+      tags:
+        - animals
+      requestBody:
+        description: Hamster to add
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Hamster'
+      responses:
+        '200':
+          description: animal response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Animal'
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
 webhooks:
   newAnimal:
     post:
@@ -352,6 +377,16 @@ components:
           type: string
         tag:
           type: string
+    Hamster:
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
     Animals:
       type: array
       maxItems: 100