From 8bf01f3ef304b63135710fca50ed917de62ae192 Mon Sep 17 00:00:00 2001 From: Reuven Harrison Date: Mon, 27 Jan 2025 17:23:03 +0200 Subject: [PATCH] correct doc --- docs/DEPRECATION.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/DEPRECATION.md b/docs/DEPRECATION.md index 7eb6d325..789d04f8 100644 --- a/docs/DEPRECATION.md +++ b/docs/DEPRECATION.md @@ -45,12 +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: +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. + ### 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. \ No newline at end of file