Skip to content

Commit aa8c49e

Browse files
Display pattern if available in OpenAPI params (#2461)
Co-authored-by: Samy Pessé <samypesse@gmail.com>
1 parent b32e40c commit aa8c49e

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

.changeset/poor-bats-cheer.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@gitbook/react-openapi': minor
3+
---
4+
5+
Display pattern if available in parmas in OpenAPI block

packages/gitbook/src/components/DocumentView/OpenAPI/style.css

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,8 @@
174174
@apply prose-sm;
175175
}
176176

177-
.openapi-schema-example {
177+
.openapi-schema-example,
178+
.openapi-schema-pattern {
178179
@apply prose-sm mt-2 text-dark/10 dark:text-light/10;
179180
}
180181

packages/react-openapi/src/OpenAPISchema.tsx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,11 @@ export function OpenAPISchemaProperty(
104104
Example: <code>{JSON.stringify(schema.example)}</code>
105105
</span>
106106
) : null}
107+
{schema.pattern ? (
108+
<div className="openapi-schema-pattern">
109+
Pattern: <code>{schema.pattern}</code>
110+
</div>
111+
) : null}
107112
</div>
108113
}
109114
>

0 commit comments

Comments
 (0)