fix: render property titles (#83)

Author: HiDeoo

.changeset/chatty-bottles-allow.md

@@ -0,0 +1,5 @@
+---
+'starlight-openapi': patch
+---
+
+Ensures property titles are rendered when provided in a schema.

packages/starlight-openapi/components/schema/SchemaObject.astro

@@ -39,6 +39,7 @@ const hasMany = schemaObjects !== undefined
     <Astro.self negated schemaObject={schemaObject.not} />
   ) : (
     <>
+      {schemaObject.title && <em>{schemaObject.title}</em>}
       <Md text={schemaObject.description} />
       <ExternalDocs docs={schemaObject.externalDocs} />
       {isSchemaObjectObject(schemaObject) ? (

packages/starlight-openapi/tests/requestBody.test.ts

@@ -211,3 +211,12 @@ test('overrides the global `consumes` property for a v2.0 schema', async ({ docP
   await requestBody.getByRole('combobox').selectOption('application/json')
   await requestBody.getByRole('combobox').selectOption('application/xml')
 })
+
+test('displays property titles when provided', async ({ docPage }) => {
+  await docPage.goto('/v3/animals/operations/addanimal/')
+
+  const requestBody = docPage.getRequestBody()
+
+  await expect(requestBody.getByText('Name of the animal')).toBeVisible()
+  await expect(requestBody.getByText('A friendly name for the animal.')).toBeVisible()
+})

schemas/v3.0/animals.yaml

@@ -490,6 +490,8 @@ components:
           format: int64
         name:
           type: string
+          title: Name of the animal
+          description: A friendly name for the animal.
         tag:
           type: string
       example: