Skip to content

Ensure descriptions appear correctly. #2096

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

Merged
bgravenorst merged 2 commits into from
Jun 18, 2025
Merged

Ensure descriptions appear correctly. #2096

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc35880
Ensure descriptions appear correctly.
bgravenorst Jun 18, 2025
bd7f988
Merge branch 'main' into DOC-2089
bgravenorst Jun 18, 2025
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
13 changes: 9 additions & 4 deletions src/components/ParserOpenRPC/DetailsBox/RenderParams.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,18 @@ const getRefSchemaFromComponents = (initRef, components) => {
const renderSchema = (schemaItem, schemas, name) => {
if (!schemaItem) return <div>Invalid schema</div>

const resolveRef = ref => {
const resolveRef = (ref, originalItem) => {
const newSchema = getRefSchemaFromComponents(ref, schemas)
return renderSchema(newSchema, schemas, name)
// Preserve the original parameter's description when resolving references
const resolvedSchema = {
...newSchema,
description: originalItem?.description || newSchema.description || newSchema.title || '',
}
return renderSchema(resolvedSchema, schemas, name)
}

if (schemaItem?.schema?.$ref) return resolveRef(schemaItem.schema.$ref)
if (schemaItem?.$ref) return resolveRef(schemaItem.$ref)
if (schemaItem?.schema?.$ref) return resolveRef(schemaItem.schema.$ref, schemaItem)
if (schemaItem?.$ref) return resolveRef(schemaItem.$ref, schemaItem)

const renderObject = (item, itemName) => {
const requiredFields = Array.isArray(item.required) ? item.required : []
Expand Down
Loading