Skip to content

Commit

Permalink
Improve deprecation doc (#642)
Browse files Browse the repository at this point in the history
  • Loading branch information
reuvenharrison committed Jan 27, 2025
1 parent 28aecb1 commit 2719009
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/DEPRECATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,12 @@ If you are using [API stability levels](STABILITY.md) you can define different s
- Stable APIs: with the `--deprecation-days-stable`
- Beta APIs: with the `--deprecation-days-beta`

Notes:
### Deprecating Parameters and Schemas
OpenAPI 3 supports the `deprecation` field for three objects: Operation, Parameter and Schema.
Oasdiff currently supports deprecation for `Operations` only.
Supporting the other objects is planned too.

### Notes:
1. Deprecation days can be set to non-negative integers
2. Setting deprecation days to a zero value disables enforcement and reverts to the [Deprecation with a sunset date](#deprecation-with-a-sunset-date) behavior
2. After an `x-sunset` extension is specified, it can only be changed to a future date which respects the sunset grace period relative to date of the change.

0 comments on commit 2719009

Please sign in to comment.