Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

jsonフィールドのcaseを揃えたほうが良いのではないか #460

Closed
qwerty2501 opened this issue Aug 31, 2022 · 4 comments
Closed
Labels
優先度:低 (運用中止) 機能向上 要議論 実行する前に議論が必要そうなもの

Comments

@qwerty2501
Copy link
Contributor

内容

現状APIで使われているjsonのフィールド名がcamelCaseとsnake_caseとで別れている
これはフィールド名に一貫性がないためcamelCaseかsnake_caseに揃えたほうが良いのではないか

Pros 良くなる点

フィールド名に一貫性が持てる

Cons 悪くなる点

破壊的変更になるため既存ユーザーに影響が出る

実現方法

voicevox_engine/model.pyに定義されている型のフィールド名をsnake_case、ないしはcamelCaseに統一する

関連 issue

VOICEVOX/voicevox_core#261

@Hiroshiba Hiroshiba added the 優先度:低 (運用中止) label Aug 31, 2022
@Hiroshiba
Copy link
Member

Hiroshiba commented Aug 31, 2022

issue作成ありがとうございます!!

なんとなくですが、返り値はjsonなので、jsっぽくcamelCaseで統一できればと思っています!

また、変更の影響を受けるのは、ほぼVOICEVOXエディタだけなのかなと思っています。
サードパーティアプリは殆どの場合、AudioQueryで得たjsonをそのままエンジンに投げていると思われるためです。
もしかしたらキャッシュしているアプリがあるかもしれず、その場合はエラーになるかもしれません。
もしcamelCaseに変わった場合は、いろいろなVOICEVOX利用アプリの方にご連絡してみようと思います。

コード内・ドキュメント内を全部変更したらこのissueは完了だと思います。
その際に新しくエディタ側に対応を入れるissueを建てましょう!

  • このissue完了時にエディタ側にissueを建てる

@qwerty2501
Copy link
Contributor Author

VOICEVOX/voicevox_core#261 で metas.jsonはすでにsnake_caseなのでそれにあわせるのであればsnake_caseのほうが良いのでは?となりました。coreの内容と合わせるのであればこっちもsnake_caseにするべき?

@tarepan tarepan added the 要議論 実行する前に議論が必要そうなもの label Mar 4, 2024
@tarepan
Copy link
Contributor

tarepan commented Mar 4, 2024

@Hiroshiba
2024年現在の視点(ポスト・マルチエンジン)で見ると、本 issue の提案は VOICEVOX API の破壊的変更です。
マルチエンジンの意義を考えると、v1.0 でさえ実装するか悩ましいレベルに見えます。
本 issue 提案は Go/NoGo どちらの方向性でしょうか?

@Hiroshiba
Copy link
Member

やるやらはさておき、こちらのissueを短期間でクリアするのは難しいと思います。
↓のissueに集約されたということにして、このissueはcloseで良いかなと!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
優先度:低 (運用中止) 機能向上 要議論 実行する前に議論が必要そうなもの
Projects
None yet
Development

No branches or pull requests

3 participants