仕様書へのリンクは、なるべくパーマリンクを用いて欲しい。

kogai

いつもお世話になっております。

APIドキュメントの扱いについての要望です。

スマレジ Developers でAPIドキュメントの更新を告知する際に、仕様書へのリンクを添付するケースがあると思います。

こちらはAPIドキュメントのURLではなく、話題にしているAPIの具体的なパーマリンクを用いるようにできませんでしょうか？

NG -> https://www1.smaregi.dev/apidoc/

OK -> https://www1.smaregi.dev/apidoc/#operation/postCreateRole

告知されているAPIが正確には何なのか、誤解なく意思疎通するために、ご検討頂けると助かります。

例えば2023/06/7付の（スクリーンショットを添付しました）告知の場合、「取引セクションAPI」が、正確にはどのAPIについて話しているのか、明瞭ではありません。

「仕様書を見る」リンクが https://www1.smaregi.dev/apidoc/ を指しているため、APIドキュメントのどこを指しているのか、分からないためです。

例えば以下のようにパーマリンクを添付しておけば、誤解なく読解することが可能です。

• 【仕様書修正】支払方法分類登録API・支払方法分類更新APIについて、作成者(insUser)と更新者(updUser)はレスポンスに含まれないにも関わらず、Responsesに記載がありました。そのため、これらの記載を削除しました。 https://www1.smaregi.dev/apidoc/#operation/createPaymentMethodGroup

ご検討頂けますと幸甚です。

スマレジ 東本

https://community.smaregi.dev/discussion/480/%E5%8F%96%E5%BC%95%E3%82%BB%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%AEapi-%E3%81%A8%E3%81%AF%E4%BD%95%E3%81%8B

別途いただいたこちらにて回答しておりますが、パーマリンクにつきましても検討いたします。

ご意見ありがとうございました。