Miroslav Suchý wrote:
Jesus Rodriguez wrote:
Why 10.0? Seems really arbitrary. If that was the intent, I can live
with it.

If we make is 5.2, people can expected that Satellite 5.3 will have API 5.3, whereas it will meantime bump up to 6.5 or something like that. I take it as explicitly notice - api version has now no releation to spacewalk/satellite version. And I did not bump it up to 100 as Dennis suggested as that is imho too much.

5) if you are relying on the value of api.get_system_version() please
switch the appropriate api.get_version() method.
Please now whenever you add new API call modify minor version web.apiversion in web/conf/rhn_web.conf. And every Spacewalk release bump up major version.
If you have better idea how to handle api versioning share the idea.

How would this work under a normal development cycle? For example, in
sw 0.4, if brad adds 4 new apis and I add 5 more, do we bump up the
minor release by 9 i.e. 10.9?

Because if brad will think "oh, zeus will be adding some api tommorow, he will bump it up for me" and you will think "brad alredy added api, so he for sure bumped it up". It is no problem if we skip some number due this process. E.g. if space04 will have API 10.5 and space05 will have API 11.4.
But it is problem if we forget to bump up the version.

Additionaly it will be nice if we start putting in javadoc comments (and in help generated from this) that this api call is available since api version 10.1.

Hi Mirek,

Thanks for initiating this discussion and introducing the API versioning.

I like the idea of including in the API docs something that reflects the API release/version that a specific API was introduced. We will want to use similar information when we define APIs (or portions of an API such as element of a return value) as deprecated, so that it becomes clearer when the deprecated item will be removed entirely. (Note: how deprecation is handled w/in the docs is something that needs to be looked in to further, aside from this thread :))

I am, however, a little unclear on the proposed bumping of the API version. Is it necessary to bump it for each API that added during the course of a development cycle? Or is it sufficient just to bump it once for each Spacewalk release? If we bump it for new APIs, do we also have to bump it for every API modification? The reason that I ask is that we don't bump the Spacewalk version for every change that is submitted to it. I also suspect that over time many folks will forget to bump the API version as they submit changes to the APIs, so the might become less reliable/useful.

thanks,
Brad

_______________________________________________
Spacewalk-devel mailing list
[email protected]
https://www.redhat.com/mailman/listinfo/spacewalk-devel

Reply via email to