Skip to content

Commit ddeb80a

Browse files
committed
fix: 修正 request param 和 request data 的注释
1 parent f6235df commit ddeb80a

File tree

2 files changed

+27
-4
lines changed

2 files changed

+27
-4
lines changed

src/printer/Arg.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,8 @@ export class Arg {
117117
returns: parameter.description || schema.description || false,
118118
}
119119
: {
120-
[`param ${requiredKeyStringify(name, required)}`]: parameter.description || schema.description || 'request param',
120+
[`param ${requiredKeyStringify(name, required)}`]:
121+
parameter.description || schema.description || `request ${this.kind === 'data' ? 'data' : 'param'}`,
121122
},
122123
};
123124
}

test/printer/upload.test.ts

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,18 @@ test('upload single', () => {
7171
summary: 'upload',
7272
description: 'upload',
7373
operationId: 'upload',
74+
parameters: [
75+
{
76+
name: 'category',
77+
in: 'query',
78+
description: 'request param',
79+
required: true,
80+
schema: {
81+
type: 'string',
82+
enum: ['a', 'b'],
83+
},
84+
},
85+
],
7486
requestBody: {
7587
content: {
7688
'multipart/form-data': {
@@ -83,6 +95,10 @@ test('upload single', () => {
8395
description: 'A file',
8496
required: true,
8597
},
98+
name: {
99+
type: 'string',
100+
description: 'A name',
101+
},
86102
},
87103
},
88104
},
@@ -106,19 +122,25 @@ test('upload single', () => {
106122
"/**
107123
* @description upload
108124
* @summary upload
109-
* @param data request param
125+
* @param category request param
126+
* @param data request data
110127
* @param [config] request config
111128
*/
112-
export async function upload(data:{
129+
export async function upload(category:("a"|"b"),data:{
113130
/**
114131
* @description A file
115132
* @format binary
116133
*/
117134
"file":Blob;
135+
/**
136+
* @description A name
137+
*/
138+
"name"?:string;
118139
},config?:AxiosRequestConfig): AxiosPromise<unknown> {
119140
return axios({
120141
method: "post",
121-
url: \`/upload\`,
142+
params: {category: category},
143+
url: \`/upload\`,
122144
data: data,
123145
...config
124146
});

0 commit comments

Comments
 (0)