RE: [odata] [OASIS Issue Tracker] (ODATA-1622) Avoid "MAY ... only if"

An entity type is not an actor, so both old and new text are not clear.

Suggest:

A new key property MAY NOT be added to an entity type that already defines a key, (whether or not the entity type is marked as abstract).

Internal Use - Confidential

From: Handl, Ralf <ralf.handl@sap.com>
Sent: Tuesday, December 5, 2023 3:48 AM
To: Ericson, George <George.Ericson@dell.com>
Cc: odata@lists.oasis-open.org
Subject: Re: [odata] [OASIS Issue Tracker] (ODATA-1622) Avoid "MAY ... only if"

[EXTERNAL EMAIL]

The concrete case here is rephrasing an existing requirement on the API Designer:

An entity type (whether or not it is marked as abstract) MUST NOT define a key if it inherits one.

The old text was

An entity type (whether or not it is marked as abstract) MAY define a key only if it doesn't inherit one.

The new text is easier to understand (at least for Germans 😉).

Internal Use - Confidential

From: odata@lists.oasis-open.org <odata@lists.oasis-open.org> on behalf of Ericson, George <George.Ericson@dell.com>
Sent: Monday, December 4, 2023 18:01
To: OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>; odata@lists.oasis-open.org <odata@lists.oasis-open.org>
Subject: RE: [odata] [OASIS Issue Tracker] (ODATA-1622) Avoid "MAY ... only if"

Ouch double negatives....

The provision should be on the provider. Could we have an example that does not place a requirement on a client?

Internal Use - Confidential

-----Original Message-----

From: odata@lists.oasis-open.org <odata@lists.oasis-open.org> On Behalf Of OASIS Issues Tracker

Sent: Monday, December 4, 2023 9:26 AM

To: odata@lists.oasis-open.org

Subject: [odata] [OASIS Issue Tracker] (ODATA-1622) Avoid "MAY ... only if"

[EXTERNAL EMAIL]

Heiko Theissen created ODATA-1622:

-------------------------------------

Summary: Avoid "MAY ... only if"

Key: ODATA-1622

URL: https://urldefense.com/v3/__https://issues.oasis-open.org/browse/ODATA-1622__;!!LpKI!n_sINK3IMZD0C2AtBbsgzSoTFbEvpXr1lhikhs0CY8TlcxtNkbhB6Av88uOeJHLr18FVBrVlIA2u3ml22dr5oF-tiEee69R97PrsXA$ [issues[.]oasis-open[.]org]

Project: OASIS Open Data Protocol (OData) TC

Issue Type: Improvement

Components: CSDL JSON , CSDL XML

Reporter: Heiko Theissen

Combining the RFC2119 term "MAY" with a negation or restrictions runs counter to what MAY wants to express.

{quote}Clients MAY do A only if B

{quote}

sounds as if

* the client may choose not to do A if B (which is not always implied)

* there is no rule for the client if not B.

Instead, write

{quote}Clients MUST NOT do A if (not B)

{quote}

This message was sent by Atlassian Jira

(v8.3.3#803004)

---------------------------------------------------------------------

To unsubscribe from this mail list, you must leave the OASIS TC that generates this mail. Follow this link to all your TCs in OASIS at:

https://urldefense.com/v3/__https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php__;!!LpKI!n_sINK3IMZD0C2AtBbsgzSoTFbEvpXr1lhikhs0CY8TlcxtNkbhB6Av88uOeJHLr18FVBrVlIA2u3ml22dr5oF-tiEee69SNgDgf4A$ [oasis-open[.]org]

odata message