forked from LiveCarta/PayPal-PHP-Server-SDK
33 lines
1.3 KiB
Markdown
33 lines
1.3 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 <a href="https://tools.ietf.org/html/rfc6901">JSON Pointer</a> 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 <code>remove</code>, <code>copy</code>, and <code>move</code> operations do not require a value. Since <a href="https://www.rfc-editor.org/rfc/rfc69021">JSON Patch</a> allows any type for <code>value</code>, the <code>type</code> property is not specified. | getValue(): | setValue( value): void |
|
|
| `from` | `?string` | Optional | The <a href="https://tools.ietf.org/html/rfc6901">JSON Pointer</a> to the target document location from which to move the value. Required for the <code>move</code> operation. | getFrom(): ?string | setFrom(?string from): void |
|
|
|
|
## Example (as JSON)
|
|
|
|
```json
|
|
{
|
|
"op": "add",
|
|
"path": "path6",
|
|
"value": {
|
|
"key1": "val1",
|
|
"key2": "val2"
|
|
},
|
|
"from": "from0"
|
|
}
|
|
```
|
|
|