Terms and defintions¶
API Terms¶
- LIST
- Operation defined in REST standards and various schemas, like Swagger. It is just a HTTP GET on endpoint. See GET on /endpoint/ for more information.
- READ
- Operation defined in REST standards and various schemas, like Swagger. It is just a HTTP GET on /endpoint/<pk_id>. See GET on /endpoint/<pk>/ for more information.
Object Terms¶
- Changeable
- This field property means that you can or can’t change it over API with PUT on /endpoint/<pk>/ or PATCH on /endpoint/<pk>/ operation. See Changeable for more information.
- POSTable
- This field property means that you can or can’t set this field during object creation with POST on /endpoint/ operation. See POSTable for more information.
- Required
- This property of a field means that you are required or not required to set this field in POST on /endpoint/ and PUT on /endpoint/<pk>/ operations. See Required for more information.
Term Combinations¶
There is a various combinations of Required | POSTable | Changeable for POST on /endpoint/ | PUT on /endpoint/<pk>/ | PATCH on /endpoint/<pk>/ methods
Table bellow clarify the meanings of them.
| Required | POSTable | Changeable | Description |
| False | False | False | The field is not expected and will be ignored by POST but will be checked to be left unchanged by PUT. |
| True | True | False | A required field, required in the POST and PUT methods, an attempt to change the value of the field in the PUT and PATCH methods will result in an error, see Changeable for more information. |
| False | True | True | The field is optional, if it is not passed in the POST method, then the default value will be applied, the same field is not required in the PUT and PATCH methods. |
| True | True | True | Required field, required in POST and PUT methods, but not required in PATCH methods, see PATCH on /endpoint/<pk>/ for more information. |
| False | True | False | The field is optional, it can be filled using the POST method, otherwise the default value will be applied, further changing the value using the PUT, PATCH methods is prohibited. |
| False | False | True | The field cannot be filled using the POST method, when creating an object, the default value is applied, but changing the value using the PUT, PATCH methods is possible. |
| True | False | True | Combination is not allowed |
| True | False | False | Combination is not allowed |
Note
All fields not described for objects are ignored for all methods.