Marking API Methods as Deprecated in OpenAPI Definition

Remoting SDK
, ,
1

Hi,

I’d like to mark some of my HTTP API methods as deprecated. From what I’ve read, this is supported by the OpenAPI Specification:

Is there a way to specify this attribute so that it’s included in the API definition returned by the remoting SDK service (e.g., when a user accesses /api/ or the base endpoint)?

If not, are there any plans to support this in the future?

For context, I’m using Service Builder.

Thanks!

2

Hi,

We support swagger v1.0 format only.
This feature was added in v3.0.

However you can try to modify generated json in TROHttpApiDispatcher.OnSchemaComplete event.

3

Thank you for the clarification.
I’ll look into handling it via the OnSchemaComplete event as suggested.

Much appreciated!