Standardise usage of 'property' and 'parameter' in doc/api/*
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Problem to solve
In many places in the API docs, the word parameter is used to refer to a field inside the JSON object returned by the API. parameter generally refers to an input, while property is possibly a better word to use when describing an object and its fields.
Further details
The first steps of this have been done in !59636 (merged) - for the Issues API.
Related discussions:
- Fields vs attributes, per the discussion in: !83684 (comment 891716959)
- Attributes vs parameters, per the discussion in !85704 (comment 933281232)
Proposal
This issue proposes changing the appropriate uses of parameter to property throughout the API docs so that the definition proposed above is true.
Also update relevant style guides.
Who can address the issue
This could be done by anyone who can understand when the docs are referring to API input (i.e. a parameter) and API output (i.e. a property)