[mapguide-internals] RE: API Operation Version Confusion

[Trevor Wekel]

I think using the MGOS version for any changed or new operation makes it clear as to which version of MGOS the operation is compatible with.

In some cases, like DescribeSchema, it looks as though we have been a bit lazy with the convention.  Even if the signature is backward compatible, we should probably revision it so developers (and the community) know where the API is applicable.

Thanks Bruce and Dave for pointing out the inconsistencies and helping to explain why it makes sense to revision the operations.

As Jason mentioned, I do not think we can change any of the broken APIs since they have already been released.  However, we should stick to the chosen convention for future releases.

I would vote for HTTP API version = version of MGOS where API was introduced or changed.

Thanks,
Trevor

-----Original Message-----
From: mapguide-internals-bounces at lists.osgeo.org [mailto:mapguide-internals-bounces at lists.osgeo.org] On Behalf Of Jason Birch
Sent: August 17, 2009 2:06 PM
To: MapGuide Internals Mail List
Subject: [mapguide-internals] RE: API Operation Version Confusion

That makes sense to me too.  Using the web api version rather than a function-specific revision adds a lot of value.

I guess my question though is, how do we move to consolidate on this system without causing backwards compatibility issues?  Is it too late to standardise on this system and gain value from it?

Jason

-----Original Message-----
From: Dave Wilson
Sent: Monday, August 17, 2009 1:01 PM
To: MapGuide Internals Mail List
Subject: [mapguide-internals] RE: API Operation Version Confusion

I'm not sure what the standard for this in open source, but logically the version reflects the version the API was introduced in or updated in. If it hasn't been updated the version wouldn't change. This would act like a label so that you can find all the 1.0.0 APIs, the 1.2.1 APIs (or revisions) and so on. That would seem like useful information to me. If an API doesn't have a 1.0.0 version you know it was introduced later.

-----Original Message-----
From: Bruce Dechant
Sent: Monday, August 17, 2009 1:51 PM
To: MapGuide Internals Mail List
Subject: [mapguide-internals] API Operation Version Confusion

I would like to discuss the confusion on the API version information.

Currently, all of the APIs have an associated operation "VERSION". This "VERSION" hasn't been clearly defined and after looking at the latest code base we are using it inconsistently throughout the project.

As you can see we have not been following a well defined operation "VERSION" scheme and this is something we need to correct as it is confusing.

_______________________________________________
mapguide-internals mailing list
mapguide-internals at lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/mapguide-internals