Skip to content

Conversation

@tulshi
Copy link
Contributor

@tulshi tulshi commented Sep 27, 2023

… the Versioning Proposal previously adopted by the WG as a tracked document

… the Versioning Proposal previously adopted by the WG as a tracked document
3. **Breaking Change**: The new version makes changes to the Latest Spec. Implementations need to be updated in order to be able to work with any implementation of this new version.

**Note** that the change is always compared against the Latest Spec, and not against previous working group drafts.
Versioning Proposal
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a heading? It needs markdown I think


version

> OPTIONAL. A string representation of a decimal number including a decimal point and at least one number after the decimal point even if it is 0. This indicates the version of the specification the Transmitter adheres to. The version number is determined according to the Versioning ({{VERSIONING}}) specification. The version number of the current specification is "1.0". If the `version` field is missing in the Transmitter Configuration Metadata, then the version number is assumed to be "0.1".
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • A transmitter may want to support both 0.1 and 1.0 versions.
  • A receiver may want to consume APIs with specific version

Should the receiver indicate which version it can consume by the headers to the API calls?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think since the API is incompatible between 0.1 and 1.0, a Transmitter wishing to support both will have to provide two different endpoints, so each metadata can still refer to just one version.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the version be part of the API endpoints? Should the API version part of the API URLs or headers? Without that transmitter would not be able to distinguish receivers.

I feel, there also should be a notion of which version of the spec the receiver supports to allow version negotiation.

@tulshi tulshi closed this Oct 3, 2023
@tulshi
Copy link
Contributor Author

tulshi commented Oct 3, 2023

Based on WG discussions and discussions with Mike Jones and Mark Haine, this PR is no longer required.

@tulshi tulshi linked an issue Dec 14, 2023 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Spec / Protocol versioning

4 participants