forked from LiveCarta/PayPal-PHP-Server-SDK
504c367386
Beta Release 0.7.0 including: - Bug fixes - Updated model/function names - Updated models to reflect changes in APIs
33 lines
1.1 KiB
Markdown
33 lines
1.1 KiB
Markdown
|
|
# Patch
|
|
|
|
The JSON patch object to apply partial updates to resources.
|
|
|
|
## Structure
|
|
|
|
`Patch`
|
|
|
|
## Fields
|
|
|
|
| Name | Type | Tags | Description | Getter | Setter |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| `op` | [`string(PatchOp)`](../../doc/models/patch-op.md) | Required | The operation. | getOp(): string | setOp(string op): void |
|
|
| `path` | `?string` | Optional | The JSON Pointer to the target document location at which to complete the operation. | getPath(): ?string | setPath(?string path): void |
|
|
| `value` | `mixed` | Optional | The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified. | getValue(): | setValue( value): void |
|
|
| `from` | `?string` | Optional | The JSON Pointer to the target document location from which to move the value. Required for the move operation. | getFrom(): ?string | setFrom(?string from): void |
|
|
|
|
## Example (as JSON)
|
|
|
|
```json
|
|
{
|
|
"op": "add",
|
|
"path": "path6",
|
|
"value": {
|
|
"key1": "val1",
|
|
"key2": "val2"
|
|
},
|
|
"from": "from0"
|
|
}
|
|
```
|
|
|