Deprecating a Version

The creator of a service has the ability to soft deprecate a version, as well as disabling it entirely. When a version is soft deprecated, a warning will be printed when that version is invoked, with instructions on how the user can update to a more recent version. When a version is disabled, it will be unable to be run, and all calls to it will return an error. This should only be used if absolutely necessary, since it will break code that depends on this version.

Soft Deprecating

When a version is deprecated, a message similar to the one will be shown to anyone that tries to call it.

service v1.0.1 is deprecated! Run api update service to use the latest version

Any calls will still be made, and the results shown as normal. At the top of service page on readme.build, users of that version will see a warning that they are using a deprecated version.

To deprecate a version, visit the versions page in the sidebar of your service. There you will be able to deprecate any version that you have deployed.

Disabling

If you need to stop all calls to a version, after a version is deprecated you will be able to disable it entirely. This should only be done if absolutely necessary, for example if there is a security issue in that version. This will break any code that depends on this version, so it should not be done lightly.

After a version is disabled, any calls to it will return an error message similar to the one below.

Version 1.4.1 of service is disabled.

Any calls made to this version will never run the deployed code.

To disable a version, visit the versions page for the service. After a service is deprecated, you will be able to disable it.