[OASIS Issue Tracker] (COEL-108) MMI - poor use of keywords

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

    [ https://issues.oasis-open.org/browse/COEL-108?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=67111#comment-67111 ] 

Paul Bruton commented on COEL-108:
----------------------------------

We have taken this on board along with other comments and decided to use the approach in the TOSCA YAML standard (https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=tosca)

> MMI - poor use of keywords
> --------------------------
>
>                 Key: COEL-108
>                 URL: https://issues.oasis-open.org/browse/COEL-108
>             Project: OASIS Classification of Everyday Living (COEL) TC
>          Issue Type: Bug
>         Environment: Normative
>            Reporter: Chet Ensign
>              Labels: TAB_CD02_OBSERVATION, conformance
>
> When writing normative text, it isn't necessary and can be confusing to use RFC2119 control language. 
> Compare: 
> 2.5. Service Provider: Suspend Operator
> "Suspend the given Operator’s ability to create new Consumers and assign devices."
> Exactly what you want, it's just a fact. 
> Whereas:
> "If successful, an HTTP status code of 200 OK MUST be returned."
> ???
> Why not: 
> 2.5.2 Responses to Suspend Operator
> 2.5.2.1 HTTP status code of 200 OK
> An HTTP status code of 200 OK indicates the operation was successful
> 2.5.2.2 HTTP error code or JSON object with explanation
> An HTTP error code or a JSON object with explanation of failure indicates the operation failed.
> By defining it this way (and moving MUST/SHOULD, etc. to the conformance clause) we note the failure operation IS INCOMPLETE.
> What is the status with no response? That is the suspend operator was sent but there was no 200 OK and there was no HTTP error code or JSON object? What then? 



--
This message was sent by Atlassian JIRA
(v6.2.2#6258)