[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

Re: Upcoming changes to REST API in version 1.5

+++ Clayton Coleman [04/06/13 10:39 -0400]:
Clients that don't specify a version get a float instead of a string - any *existing* client that assumes version is a string will then break.  So API versioning doesn't protect us because it's on the unversioned content.  The only way we would be protected there would be if we served 1.4 to clients that don't request API versions as the default.  But there's no guarantee that they'd respect it.

So either way this change can break clients that are not defensively written.

Agreed.  We'll likely wait on this API change and the fix for BZ965804
until later in the OSE 1.x lifecycle.

----- Original Message -----
+++ Brenton Leanhardt [04/06/13 09:28 -0400]:
>+++ Luke Meyer [04/06/13 09:26 -0400]:
>>Nevermind, it merged :) So I guess it's a question of whether we need/want
>>it and how well tested it is...
>Well, I'm thinking I'll back it out based on Clayton's feedback.  It's
>easy enough just to cherry-pick what we need.

This change won't ship with today's OSE 1.2 build.  Looking at the
code it does appear to be mostly backwards compatible as Lili stated.
Meaning clients that _explicitly_ request an API version will see the
old behavior.

The only change I see in the latest pull request is related to DELETEs
returning a 200 instead of a 204.  I'm wondering if the API version
float change is planning to ship later.

So others are aware, without the change for DELETE OpenShift
Enterprise 1.2 won't initially have the fix for client messages from
the Node not being returned to the client on app destroy:

I've copied that to OSE so we don't lose track of it.

>>----- Original Message -----
>>From: "Luke Meyer" <lmeyer redhat com>
>>To: "Lili Nader" <lnader redhat com>
>>Cc: "libra-qe" <libra-qe redhat com>, "libra-devel"
>><libra-devel redhat com>, "dev" <dev lists openshift redhat com>
>>Sent: Tuesday, June 4, 2013 9:24:38 AM
>>Subject: Re: Upcoming changes to REST API in version 1.5
>>Any guesses on when this might land?
>>Seems like something that might be good to slip into Enterprise 1.2 ... but
>>I'm guessing it won't be ready soon enough.
>>----- Original Message -----
>>From: "Lili Nader" <lnader redhat com>
>>To: "dev" <dev lists openshift redhat com>
>>Cc: "libra-qe" <libra-qe redhat com>, "libra-devel"
>><libra-devel redhat com>
>>Sent: Monday, June 3, 2013 7:30:24 PM
>>Subject: Upcoming changes to REST API in version 1.5
>>The API version returned in the http response will be a float versus a
>>string.  This was bug and it has been fixed.  Clients specifically
>>requesting for versions 1.4 or earlier will not be impacted by this
>>For example:
>>curl -k https://localhost/broker/rest/api -H "Accept:
>>   "supported_api_versions": [1.0, 1.1, 1.2,1.3,1.4,1.5],
>>   "version": "1.4"
>>****** if no version specified the latest version (1.5) is returned
>>curl -k https://localhost/broker/rest/api -H "Accept: application/json"
>>   "supported_api_versions": [1.0, 1.1, 1.2,1.3,1.4,1.5],
>>   "version": 1.5
>>Other major change in API behavior is the response from DELETE methods.  In
>>1.4 or earlier the http status code was 204 (no content) and no content
>>was returned to the client.  However, there are use cases where messages
>>need to be relayed back to the client as in the case mentioned in this bug
>>(https://bugzilla.redhat.com/show_bug.cgi?id=965804).  As of version 1.5
>>the http status code returned will be 200 and the result returned from
>>node will be encapsulated in the body of the response.  Again, clients
>>requesting version 1.4 or earlier will not be impacted.
>>Please let me know if you have any questions.
>>dev mailing list
>>dev lists openshift redhat com
>dev mailing list
>dev lists openshift redhat com

dev mailing list
dev lists openshift redhat com

[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]