Dressca の OpenAPI 仕様書にMaia / Maris 間で不要な差異がある

[kenjiyoshid-a]

概要

Dressca の OpenAPI 仕様書にMaia / Maris 間で不要な差異がある。
それによりadminとconsumerの下記ファイルにて、Maia / Maris 間で不要な差分が生じてしまっている。

• src\generated\api-client\api\assets-api.ts

※追加で修正が必要なファイルがあれば追記

詳細 / 機能詳細（オプション）

該当ファイルにおいて例えば、MaiaとMarisで以下のような差分がある。

• Maia 側のコード

get(assetCode: string, options?: RawAxiosRequestConfig): AxiosPromise<File> {

• Maris 側のコード

get(assetCode: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {

該当箇所はOpenAPI Generatorを用いた自動生成されたプログラムであり、バックエンド側のAPI仕様書を読み込ませて生成させているため、フロントエンド側とバックエンド側の修正が必要である。
上記に例示した差分の直接の原因としては、Maia側はContent-Typeにimage/* を入れてbinaryを返す定義になっているが、Maris側は特に指定していないためである。APIの動作としては、Maia側のプログラムの方が期待に即しているため、Maris側をMaia側に合うように修正する。
他に修正が必要なファイルが見つかった場合にはMaia側とMaris側のどちらに合わせるかは適宜判断する。

完了条件

• 差分の原因となるバックエンド側のAPI定義を修正している
• Maia / Maris間でOpenAPI Generatorで生成されたコードに不要な差分がないことを確認する

[KentaHizume]

既知の事象として、下記の件が知られています。

• openapi-generatorで生成したResponseの入れ子部分の型名がMaiaとMarisで異なる #1379