EMS.ResourceAPI.TEMSVersionStatus

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

TEMSVersionStatus = (Experimental, Active, Default, Deprecated);

C++

enum class DECLSPEC_DENUM TEMSVersionStatus : unsigned char { Experimental, Active, Default, Deprecated };

Properties

Type Visibility Source Unit Parent
enum public
EMS.ResourceAPI.pas
EMS.ResourceAPI.hpp
EMS.ResourceAPI EMS.ResourceAPI

Description

The type enumerating API version statuses.

A version status affects a resource-based URL, extra response headers, and information in the Swagger API documentation.
The TEMSVersionStatus values are as follows:

  • Active: uses "ver/myapi/..." as base URL.
  • Default: uses "ver/myapi/..." and "myapi/..." as base URLs.
  • Deprecated: uses "ver/myapi/..." as base URL, adds "Deprecated" to the Swagger description and directive, and "X-Embarcadero-Api-Status: deprecated" to the response header.
  • Experimental: uses "ver/myapi/..." as base URL, adds "Experimental" to the Swagger description, and "X-Embarcadero-Api-Status: experimental" to the response header.

See Also