pvary commented on code in PR #23865:
URL: https://github.com/apache/flink/pull/23865#discussion_r1415756044
##########
docs/content/docs/ops/upgrading.md:
##########
@@ -60,6 +60,32 @@ Code written against a `PublicEvolving` API in 1.15.2 will
continue to run in 1.
That same code would have to be recompiled when upgrading to 1.16.0 though.
{{< /hint >}}
+### Deprecated API Migration Period
+When an API is deprecated, it is marked with the `@Deprecated` annotation and
a deprecation message is added to the Javadoc.
+According to
[FLIP-321](https://cwiki.apache.org/confluence/display/FLINK/FLIP-321%3A+Introduce+an+API+deprecation+process),
+starting from release 1.18, each deprecated API will have a guaranteed
migration period depending on the API stability level:
+
+| Annotation | Guaranteed Migration Period |
Review Comment:
Maybe one more column, like:
```
| Annotation | Guaranteed Migration Period
| Could be removed after the migration period|
|:----------------:|:---------------------------------------------:|:--------------------------------------------:|
| `Public` | 2 minor releases
|Next major version
|
| `PublicEvolving` | 1 minor release
|Next minor version |
| `Experimental` | 1 patch release for the affected minor release |Next
patch version |
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscr...@flink.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
