From: Joseph Reynolds <jrey@linux.ibm.com>
To: Ed Tanous <ed@tanous.net>, Gunnar Mills <gmills@linux.vnet.ibm.com>
Cc: OpenBMC Maillist <openbmc@lists.ozlabs.org>
Subject: Re: Redfish: Supporting deprecated properties
Date: Mon, 5 Oct 2020 19:52:26 -0500 [thread overview]
Message-ID: <f1e2d3a7-2d72-523e-4141-bf4c8d132046@linux.ibm.com> (raw)
In-Reply-To: <CACWQX80ZxZuvzLzCoEvENYPSHd0yFiR8O=eu0oovptw4zYgzxQ@mail.gmail.com>
On 10/5/20 4:35 PM, Ed Tanous wrote:
> On Mon, Oct 5, 2020 at 1:34 PM Gunnar Mills <gmills@linux.vnet.ibm.com> wrote:
>> Felt this needed some broader discussion. Although Redfish tries to
>> avoid, it does deprecate properties.
>>
>> In this specific case, what if we did this:
>> Now; Upstream backward compatible LocationIndicatorActive property to
>> bmcweb. Upstream changes to OCP schema to also deprecate
>> IndicatorLed. Time starts counting once both patches have been
>> accepted into their respective mainline branches.
>> N+1 release; Implement returning a deprecation warning to the user
>> attempting to use the IndicatorLED PATCH API.
>> N+2 release; Remove the IndicatorLED property from GET requests, but
>> continue to accept the property for PATCH requests (we've done this in
>> other cases).
>> N+3 release; Disallow PATCH to that property entirely, and continue
>> with new implementation. Ideally hold the deprecation warning, but
>> use judgement about technical debt.
>>
>> ?????
>>
>> Profit!
>>
>> Clients can use the schema version to determine which properties are
>> available. If needed companies in a fork could maintain backward
>> compatibility for longer.
> In practice, many clients don't check the schema at all. I really
> wish Redfish had a way for a client to say "I support X version of the
> schema, give me the things compatible with that", but I'm not aware of
> anything like that.
>
>> Thanks,
>> Gunnar
next prev parent reply other threads:[~2020-10-06 0:55 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-05 20:34 Redfish: Supporting deprecated properties Gunnar Mills
2020-10-05 21:35 ` Ed Tanous
2020-10-06 0:52 ` Joseph Reynolds
2020-10-06 0:52 ` Joseph Reynolds [this message]
2020-10-12 20:24 ` Gunnar Mills
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=f1e2d3a7-2d72-523e-4141-bf4c8d132046@linux.ibm.com \
--to=jrey@linux.ibm.com \
--cc=ed@tanous.net \
--cc=gmills@linux.vnet.ibm.com \
--cc=openbmc@lists.ozlabs.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).