xrpl-dev-portal icon indicating copy to clipboard operation
xrpl-dev-portal copied to clipboard

API change documentation notifications

Open mikemilano opened this issue 7 years ago • 3 comments

Is there any way to learn when the API changes? i.e. when methods are added/deprecated, or parameters are changed.

As I go through the API documentation and find a mix of deprecated arguments, methods, or badges indicating the version a particular method became available, I am seeing the need for an organization relying on the API directly, or a developer maintaining wrapper libraries, to know when changes are made.

If there's something in place, I'd recommend adding documentation about it, perhaps in the API Conventions doc.

An email list where devs can be notified when changes occur would be extremely helpful as well. I think it's especially important to address due to the nature of the API in that it manages both value and trust.

mikemilano avatar Jun 03 '18 10:06 mikemilano

The official way to stay updated is the ripple-server mailing list (maybe to be renamed in the future?)

It's on our to-do list to make this information more prominent in the relevant places of the docs.

mDuo13 avatar Jun 05 '18 06:06 mDuo13

To be notified of updates to the client libraries (SDKs), subscribe to the xrpl-announce mailing list.

intelliot avatar Oct 16 '22 06:10 intelliot

This information should be added to release notes and also landing pages for API documentation.

amarantha-k avatar Nov 28 '22 21:11 amarantha-k