docs: add additional data description in generated references (#10944)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-01-13 20:47:37 +02:00
1 parent 1b86c17b72
commit 2a2b387bc3
917 files changed
+15807 -15158

No files matched your search

File diff suppressed because it is too large. Load diff
@@ -538,6 +538,23 @@ class WorkflowsPlugin {
}
}
if (parameter.type.reflection instanceof DeclarationReflection) {
const additionalDataChild = parameter.type.reflection.children?.find(
(child) => child.name === "additional_data"
)
if (additionalDataChild) {
additionalDataChild.comment =
additionalDataChild.comment || new Comment()
additionalDataChild.comment.summary = [
{
kind: "text",
text: "Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).",
},
]
}
}
signatureReflection.parameters = []
signatureReflection.parameters.push(parameter)