This is a standard ApplicationEditor method which allows you to create and modify objects by applying transactions. For documentation on these endpoints, see Conduit API: Using Edit Endpoints.
Conduit diffusion.commit.edit
diffusion.commit.edit
diffusion.commit.edit
API Method: diffusion.commit.edit
API Method: diffusion.commit.edit
Login Required: This method requires authentication. You must log in before you can make calls to it.
- Summary
- Apply transactions to edit an existing commit. This method can not create new commits.
- Returns
- map<string, wild>
- Errors
- ERR-CONDUIT-CORE: See error message for details.
- OAuth Scope
- OAuth clients may never call this method.
Method Description
Method Description
Transaction Summary
Transaction Summary
This endpoint supports these types of transactions. See below for detailed information about each transaction type.
| Key | Description |
|---|---|
| auditors.add | Change the auditors for this commit. |
| auditors.remove | Change the auditors for this commit. |
| auditors.set | Change the auditors for this commit. |
| accept | |
| concern | |
| verify | |
| resign | |
| projects.add | Add project tags. |
| projects.remove | Remove project tags. |
| projects.set | Set project tags, overwriting current value. |
| subscribers.add | Add subscribers. |
| subscribers.remove | Remove subscribers. |
| subscribers.set | Set subscribers, overwriting current value. |
| comment | Make comments. |
| mfa | Sign this transaction group with MFA. |
auditors.add
auditors.add
Change the auditors for this commit.
| Key | Type | Description |
|---|---|---|
| type | const | auditors.add |
| value | list<phid> | List of PHIDs to add. |
auditors.remove
auditors.remove
Change the auditors for this commit.
| Key | Type | Description |
|---|---|---|
| type | const | auditors.remove |
| value | list<phid> | List of PHIDs to remove. |
auditors.set
auditors.set
Change the auditors for this commit.
| Key | Type | Description |
|---|---|---|
| type | const | auditors.set |
| value | list<phid> | List of PHIDs to set. |
accept
accept
| Key | Type | Description |
|---|---|---|
| type | const | accept |
| value | bool |
concern
concern
| Key | Type | Description |
|---|---|---|
| type | const | concern |
| value | bool |
verify
verify
| Key | Type | Description |
|---|---|---|
| type | const | verify |
| value | bool |
resign
resign
| Key | Type | Description |
|---|---|---|
| type | const | resign |
| value | bool |
projects.add
projects.add
Add project tags.
| Key | Type | Description |
|---|---|---|
| type | const | projects.add |
| value | list<project> | List of PHIDs to add. |
projects.remove
projects.remove
Remove project tags.
| Key | Type | Description |
|---|---|---|
| type | const | projects.remove |
| value | list<project> | List of PHIDs to remove. |
projects.set
projects.set
Set project tags, overwriting current value.
| Key | Type | Description |
|---|---|---|
| type | const | projects.set |
| value | list<project> | List of PHIDs to set. |
subscribers.add
subscribers.add
Add subscribers.
| Key | Type | Description |
|---|---|---|
| type | const | subscribers.add |
| value | list<user> | List of PHIDs to add. |
subscribers.remove
subscribers.remove
Remove subscribers.
| Key | Type | Description |
|---|---|---|
| type | const | subscribers.remove |
| value | list<user> | List of PHIDs to remove. |
subscribers.set
subscribers.set
Set subscribers, overwriting current value.
| Key | Type | Description |
|---|---|---|
| type | const | subscribers.set |
| value | list<user> | List of PHIDs to set. |
comment
comment
Make comments.
| Key | Type | Description |
|---|---|---|
| type | const | comment |
| value | string | Comment to add, formatted as remarkup. |
mfa
mfa
Sign this transaction group with MFA.
| Key | Type | Description |
|---|---|---|
| type | const | mfa |
| value | bool | True to sign this transaction group with MFA. |
Call Method
Call Method
Examples
Examples
- Use the Conduit API Tokens panel in Settings to generate or manage API tokens.
- If you submit parameters, these examples will update to show exactly how to encode the parameters you submit.
$ echo <json-parameters> | arc call-conduit --conduit-uri https://phorge.mtrnord.blog/ --conduit-token <conduit-token> -- diffusion.commit.edit
$ curl https://phorge.mtrnord.blog/api/diffusion.commit.edit \
-d api.token=api-token \
-d param=value \
...
-d api.token=api-token \
-d param=value \
...
<?php
require_once 'path/to/arcanist/support/init/init-script.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('https://phorge.mtrnord.blog/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('diffusion.commit.edit', $api_parameters);
print_r($result);