Skip to content

feat: display format for oneOf primitive arms #1230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: display format for oneOf primitive arms #1230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 31 additions & 25 deletions packages/docusaurus-theme-openapi-docs/src/theme/Schema/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,55 +129,61 @@ interface SchemaProps {

const AnyOneOf: React.FC<SchemaProps> = ({ schema, schemaType }) => {
const key = schema.oneOf ? "oneOf" : "anyOf";
const type = schema.oneOf
const groupLabel = schema.oneOf
? translate({ id: OPENAPI_SCHEMA_ITEM.ONE_OF, message: "oneOf" })
: translate({ id: OPENAPI_SCHEMA_ITEM.ANY_OF, message: "anyOf" });

return (
<>
<span className="badge badge--info" style={{ marginBottom: "1rem" }}>
{type}
{groupLabel}
</span>
<SchemaTabs>
{schema[key]?.map((anyOneSchema: any, index: number) => {
const label = anyOneSchema.title || anyOneSchema.type;
// Prefer explicit title, then inferred name, then raw type, finally fallback MOD{n}
const computedSchemaName = getSchemaName(anyOneSchema);
const label =
anyOneSchema.title ||
computedSchemaName ||
anyOneSchema.type ||
`MOD${index + 1}`;
const isPrimitiveArm =
isPrimitive(anyOneSchema) || anyOneSchema.const;
const emptyObjectPrimitive =
anyOneSchema.type === "object" &&
!anyOneSchema.properties &&
!anyOneSchema.allOf &&
!anyOneSchema.oneOf &&
!anyOneSchema.anyOf;
return (
// @ts-ignore
<TabItem
key={index}
label={label}
value={`${index}-item-properties`}
>
{/* Handle primitive types directly */}
{(isPrimitive(anyOneSchema) || anyOneSchema.const) && (
{isPrimitiveArm && (
<SchemaItem
collapsible={false}
name={undefined}
schemaName={anyOneSchema.type}
schemaName={computedSchemaName}
qualifierMessage={getQualifierMessage(anyOneSchema)}
schema={anyOneSchema}
discriminator={false}
children={null}
/>
)}
{emptyObjectPrimitive && (
<SchemaItem
collapsible={false}
name={undefined}
schemaName={computedSchemaName}
qualifierMessage={getQualifierMessage(anyOneSchema)}
schema={anyOneSchema}
discriminator={false}
children={null}
/>
)}

{/* Handle empty object as a primitive type */}
{anyOneSchema.type === "object" &&
!anyOneSchema.properties &&
!anyOneSchema.allOf &&
!anyOneSchema.oneOf &&
!anyOneSchema.anyOf && (
<SchemaItem
collapsible={false}
name={undefined}
schemaName={anyOneSchema.type}
qualifierMessage={getQualifierMessage(anyOneSchema)}
schema={anyOneSchema}
discriminator={false}
children={null}
/>
)}

{/* Handle actual object types with properties or nested schemas */}
{anyOneSchema.type === "object" && anyOneSchema.properties && (
<Properties schema={anyOneSchema} schemaType={schemaType} />
)}
Expand Down
Loading