Skip to content

Transforms use a target version for names to support uniform versioning. #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 2, 2015

Conversation

mrhwick
Copy link
Owner

@mrhwick mrhwick commented Oct 31, 2015

Purpose

Some API developers would like to support uniform versions across their API endpoints. Others would like to support per-endpoint versioning. Version transforms could not support uniform versioning when the naming scheme used incremental integer indexes. Instead, transforms will now be defined using indexes which declare the version which is being targeted by the transform.

This allows API developers to select which versioning scheme they would like to support in their project.

If uniform versioning across all endpoints is desired, then newly created transforms should declare the next uniform API version target. Multiple endpoints can 'opt in' to a new uniform version change at the same time by creating transforms for each that target that new uniform version.

We're still able to support per-endpoint versioning, if API developers want to continue incrementing their endpoints' transforms independently of one another.

What does this PR do?

  1. Transform loading was modified with the assumption that they are appended by their target version's index.
  2. Docs were given some additional explanation about this property of the library.

mrhwick added a commit that referenced this pull request Nov 2, 2015
Transforms use a target version for names to support uniform versioning.
@mrhwick mrhwick merged commit fa2c98a into dev Nov 2, 2015
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.

1 participant