这是indexloc提供的服务,不要输入任何密码
Skip to content

[Feat]: Add client-side protocol versioning in payloads #1189

@lkawka

Description

@lkawka

Is your feature request related to a problem? Please describe.

With the upcoming 1.0 spec release, we are expecting some breaking changes which will have an impact on SDKs and their users.

To ensure backwards compatibility, we can implement conversion layers within the SDKs. This approach requires the client to communicate its protocol version. The server would then be able to translate requests from older versions (e.g., 0.3) to the current version (e.g., 1.0), process them, and convert the responses back to the client's version, thus providing backwards compatibility.

Describe the solution you'd like

The proposal is to add protocol_version fields on relevant requests, so that the server may know which version the client is on and act accordingly.

Specifically for the 0.3 to 1.0 transition, absence of the value will indicate that the server is on the 0.3 version.

Describe alternatives you've considered

No spec changes

SDKs could try to infer protocol version from request content but that would be imprecise and ineffective for response-only changes.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions