Page MenuHomeSoftware Heritage
Conduit diffusion.commit.edit

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.
Returns
map<string, wild>
Errors
  • ERR-CONDUIT-CORE: See error message for details.
OAuth Scope
OAuth clients may never call this method.
Description

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.

Transaction Types

This endpoint supports these types of transactions. See below for detailed information about each transaction type.

KeyDescription
auditors.addChange the auditors for this commit.
auditors.removeChange the auditors for this commit.
auditors.setChange the auditors for this commit.
accept
concern
verify
resign
projects.addAdd project tags.
projects.removeRemove project tags.
projects.setSet project tags, overwriting current value.
subscribers.addAdd subscribers.
subscribers.removeRemove subscribers.
subscribers.setSet subscribers, overwriting current value.
commentMake comments.
mfaSign this transaction group with MFA.

Transaction Type: auditors.add

Change the auditors for this commit.

KeyTypeDescription
typeconstauditors.add
valuelist<phid>List of PHIDs to add.

Transaction Type: auditors.remove

Change the auditors for this commit.

KeyTypeDescription
typeconstauditors.remove
valuelist<phid>List of PHIDs to remove.

Transaction Type: auditors.set

Change the auditors for this commit.

KeyTypeDescription
typeconstauditors.set
valuelist<phid>List of PHIDs to set.

Transaction Type: accept

KeyTypeDescription
typeconstaccept
valuebool

Transaction Type: concern

KeyTypeDescription
typeconstconcern
valuebool

Transaction Type: verify

KeyTypeDescription
typeconstverify
valuebool

Transaction Type: resign

KeyTypeDescription
typeconstresign
valuebool

Transaction Type: projects.add

Add project tags.

KeyTypeDescription
typeconstprojects.add
valuelist<project>List of PHIDs to add.

Transaction Type: projects.remove

Remove project tags.

KeyTypeDescription
typeconstprojects.remove
valuelist<project>List of PHIDs to remove.

Transaction Type: projects.set

Set project tags, overwriting current value.

KeyTypeDescription
typeconstprojects.set
valuelist<project>List of PHIDs to set.

Transaction Type: subscribers.add

Add subscribers.

KeyTypeDescription
typeconstsubscribers.add
valuelist<user>List of PHIDs to add.

Transaction Type: subscribers.remove

Remove subscribers.

KeyTypeDescription
typeconstsubscribers.remove
valuelist<user>List of PHIDs to remove.

Transaction Type: subscribers.set

Set subscribers, overwriting current value.

KeyTypeDescription
typeconstsubscribers.set
valuelist<user>List of PHIDs to set.

Transaction Type: comment

Make comments.

KeyTypeDescription
typeconstcomment
valuestringComment to add, formatted as remarkup.

Transaction Type: mfa

Sign this transaction group with MFA.

KeyTypeDescription
typeconstmfa
valuebool

Call Method

Enter parameters using JSON. For instance, to enter a list, type: ["apple", "banana", "cherry"]

list<map<string, wild>>
optional id|phid|string

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://forge.softwareheritage.org/ --conduit-token <conduit-token> -- diffusion.commit.edit
About · Developer information · Legal