Don't deprecate code error field

This commit is contained in:
Chocobozzz 2024-05-29 09:03:48 +02:00
parent b65d639695
commit da7ccbb44a
No known key found for this signature in database
GPG Key ID: 583A612D890159BE

View File

@ -53,7 +53,7 @@ info:
} }
``` ```
We provide error `type` values for [a growing number of cases](https://github.com/Chocobozzz/PeerTube/blob/develop/packages/models/src/server/core-error-code.enum.ts), We provide error `type` values for [a growing number of cases](https://github.com/Chocobozzz/PeerTube/blob/develop/packages/models/src/server/server-error-code.enum.ts),
but it is still optional. Types are used to disambiguate errors that bear the same status code but it is still optional. Types are used to disambiguate errors that bear the same status code
and are non-obvious: and are non-obvious:
@ -109,7 +109,6 @@ info:
Some fields could be included with previous versions. They are still included but their use is deprecated: Some fields could be included with previous versions. They are still included but their use is deprecated:
- `error`: superseded by `detail` - `error`: superseded by `detail`
- `code`: superseded by `type` (which is now an URI)
# Rate limits # Rate limits