Skip to content

Commit 89a1e48

Browse files
authored
Fix addDescription step (#627)
1 parent cc9b166 commit 89a1e48

File tree

2 files changed

+1008
-7
lines changed

2 files changed

+1008
-7
lines changed

compiler/steps/add-description.ts

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import { JsonSpec } from '../model/json-spec'
2929
export default async function addDescription (model: model.Model, jsonSpec: Map<string, JsonSpec>): Promise<model.Model> {
3030
for (const endpoint of model.endpoints) {
3131
if (endpoint.request == null) continue
32-
const requestDefinition = getDefinition(endpoint.request.name)
32+
const requestDefinition = getDefinition(endpoint.request)
3333
const spec = jsonSpec.get(endpoint.name)
3434
assert(spec, `Can't find the json spec for ${endpoint.name}`)
3535

@@ -40,21 +40,32 @@ export default async function addDescription (model: model.Model, jsonSpec: Map<
4040
})
4141
if (definition?.parts != null) {
4242
const { description } = definition.parts[property.name]
43-
property.description = description
43+
if (typeof description === 'string') {
44+
property.description = property.description ?? description
45+
}
46+
}
47+
}
48+
49+
if (spec.params != null) {
50+
for (const property of requestDefinition.query) {
51+
const param = spec.params[property.name]
52+
if (param != null && typeof param.description === 'string') {
53+
property.description = property.description ?? param.description
54+
}
4455
}
4556
}
4657
}
4758

4859
return model
4960

50-
function getDefinition (name: string): model.Request {
61+
function getDefinition (request: model.TypeName): model.Request {
5162
for (const type of model.types) {
5263
if (type.kind === 'request') {
53-
if (type.name.name === name) {
64+
if (type.name.name === request.name && type.name.namespace === request.namespace) {
5465
return type
5566
}
5667
}
5768
}
58-
throw new Error(`Can't find the request definiton for ${name}`)
69+
throw new Error(`Can't find the request definiton for ${request.namespace}.${request.name}`)
5970
}
6071
}

0 commit comments

Comments
 (0)