Task #1935
Story #2000: Edits for API docs and implementations for consistency
URL query parameter names a mix of camelCase and all lowercase in docs
100%
Description
for example:
'replicastatus' in GET /object[?starttime={startTime}&endtime={endTime}&formatid= {formatId}&replicastatus={replicaStatus}&start={start}&count={count}]
vs.
'nodeRef' in PUT /replicaNotifications/{pid}?session={session}&nodeRef={nodeRef}&status={status}
most query parameter names are all lowercase, in fact.
Probably want to fix these all at once - since it will require changes to MNs and CNs.
Associated revisions
CN and MN listObjects REST URL pattern had incorrect replicastatus instead of replicaStatus. Closes #1935
History
#1 Updated by Rob Nahf over 12 years ago
- Milestone changed from CCI-0.6.4 to CCI-1.0.0
- Category set to Documentation
- Assignee set to Dave Vieglais
- Subject changed from URL query parameter names not all camelCase in docs to URL query parameter names a mix of camelCase and all lowercase in docs
#2 Updated by Dave Vieglais over 12 years ago
- Status changed from New to In Progress
There was an agreement that parameter names should be case sensitive, however I don't believe there was consensus on a preference for all lower vs. camel case.
Requires a little discussion.
#3 Updated by Dave Vieglais over 12 years ago
- Parent task set to #2000
The general recommendation is that camelCase is the preferred format for munging words together, with lower case for the first word.
This applies to method parameters, REST url parameters, and parameter names in HTTP request payloads.
All method signatures need to be checked and adjusted as necessary.
#4 Updated by Dave Vieglais over 12 years ago
- Status changed from In Progress to Closed
CN listObjects and MN listObjects REST URL description updated. The parameter descriptions were correct, the URL pattern was not. svn r6169
