acacode / acacode/swagger-typescript-api

Invalid doc block on --responses --extract-response-error

オープン
#665 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る
主要言語
TypeScript
スター
4.1k
フォーク
436
PR マージ指標
30日以内にマージされた PR はありません

説明

I found a little bug today. When generating a client with `--responses --extract-response-error`, I get a doc block that does not look as I expect.

I would like it to use my error object instead of an anonymous definition.

Full generate command:

```
swagger-typescript-api -p ./swagger-api.json -o ./src/MyApi -n myApi.ts --axios --sort-types --sort-routes --extract-enums --add-readonly --route-types --extract-request-params --extract-request-body --extract-response-body --extract-response-error --responses --modular --unwrap-response-data
```

Here are the changes I would like to see in the generated output.
```diff
/**
* A good description
*
* @tags Brand
* @name PostUpdateLogoInvoke
* @request POST:/brands/{brandId}/logo
* @response `200` `PostUpdateLogoInvokeData` Returns a brand
+ * @response `400` `PostUpdateLogoInvokeError` Bad request
- * @response `400` `{
- errors?: ({
- \** An application-specific error code *\
- code?: string,
- \** A human-readable explanation specific to this occurrence of the problem *\
- detail?: string,
- source?: {
- message?: string,
- parameter?: string,
-},
- \** The HTTP status code applicable to this problem *\
- status?: string,
- \** A short, human-readable summary of the problem *\
- title?: string,
-
-})[],
-
-}` Bad request
*/
postUpdateLogoInvoke = ({ brandId, ...query }: PostUpdateLogoInvokeParams, data: any, params: RequestParams = {}) =>
this.request({
path: `/brands/${brandId}/logo`,
method: 'POST',
query: query,
body: data,
type: ContentType.FormData,
...params,
});
```

The `PostUpdateLogoInvokeError` is generated correctly.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。