Call for consensus on renaming "statusCodes" to "possibleStatus" and "StatusCodeDescription" to "Status" (ISSUE-27)

Currently, we have an hydra:statusCodes property on ApiDocumentation and
Operation that points to a StatusCodeDescription. That StatusCodeDescription
then in turn has a hydra:statusCode property which expresses the HTTP status
code. This is very confusing. Thus, the proposal is to rename "statusCodes"
to "possibleStatus" and "StatusCodeDescription" to "Status". We will then
describe in the spec that these are enumerations of possible statuses that
might be returned at runtime and to tell the developer (in prose in
hydra:description) how to recover from errors etc.

This serves as a call for consensus. Before I proceed with marking the issue
[1] as resolved and implementing the changes in the spec, I would like to
ask if anyone has any concerns or objections against this proposal.

Please submit your comments by Wednesday, July 23rd.


Thanks,
Markus

[1] https://github.com/HydraCG/Specifications/issues/27


--
Markus Lanthaler
@markuslanthaler

Received on Wednesday, 16 July 2014 17:10:24 UTC