search

techninja / cncserver

A RESTful API server for driving serial based CNC devices
133 stars 39 forks source link

Add API versioning! #37

Closed techninja closed 11 years ago

techninja commented 11 years ago

This can either be part of the URI, or sent as a header option. URI is implicit and required... probably a better idea. Perhaps prefix as /v1/pen

oskay commented 11 years ago

Excellent idea!

techninja commented 11 years ago

Exactly when this happens is important. Before it becomes public, or used in a client is a good first step, BUT.. we have to lock it down and totally feature freeze it, then any new features/changes we want go into v2. And I'd imagine that should happen pretty quick.

The actual versioning work is pretty easy as the first step, just have to add the prefixes to the server endpoints and the API docs.

oskay commented 11 years ago

I'd suggest adding the requirement of including 'v1' now, while the total impact is minimized. The total number of calls in robopaint is countably small.

oskay commented 11 years ago

Close appears to mean "close issue" not close this text entry box.

techninja commented 11 years ago

Sure does. I'll add it at the next interval.