Skip to content

OpenAPI規約: null, undefinedの記載はWebAPI規約に寄せる #231

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 29, 2025
Merged

OpenAPI規約: null, undefinedの記載はWebAPI規約に寄せる #231

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions documents/forOpenAPISpecification/OpenAPI_Specification_3.0.3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1108,12 +1108,6 @@ OpenOpenTelemetry で用いるられる[traceparent](https://www.w3.org/TR/trace
- OpenTelemetry が定めるヘッダ類は、API 横断的に設定されるべきものであり、ミドルウェアやフレームワーク側などでの一律の制御を推奨するため
- 記載することにより、OpenOpenTelemetry に対応していることを明記し開発者に周知できるメリットより、各アプリ開発者が生成されたコードで悩んだり、誤解されることを回避したいため

# 値が存在しないという状態の表現

原則 `null` を用いず、パラメータのキー自体を含めないこと（`undefined`）による表現を行う。

詳細は[フューチャー技術ブログ記事](https://future-architect.github.io/articles/20211028b/)を参照されたい

# バリデーション

パラメータのバリデーションをどこまで厳密に定義すべきかという議論はしばしば行われる。
Expand Down