All processors in Api Open Studio are self documenting.
This is available in the GUI, on the create a resource page on the RHS panel.
Here you can see:
This requires a valid login token.
Method: GET
URL: <domain>/apiopenstudio/core/processors/all
Headers:
Accept: application/json
Authorization: Bearer <token>
Sample response:
[
{
"name": "Accept an invite",
"machineName": "invite_accept",
"description": "Accept an invite to ApiOpenStudio.",
"menu": "Admin",
"input": {
"token": {
"description": "The invite token.",
"cardinality": [
1,
1
],
"literalAllowed": true,
"limitProcessors": [],
"limitTypes": [
"text"
],
"limitValues": [],
"default": ""
}
}
},
{
"name": "Account create",
"machineName": "account_create",
"description": "Create an account.",
"menu": "Admin",
"input": {
"name": {
"description": "The name of the account. This must contain alphanumeric characters only.",
"cardinality": [
1,
1
],
"literalAllowed": true,
"limitProcessors": [],
"limitTypes": [
"text"
],
"limitValues": [],
"default": ""
}
}
},
...
]
You can also request the definition for a single processor, using the machine name:
Method: GET
URL: <domain>/apiopenstudio/core/processors/account_create
Headers:
Accept: application/json
Authorization: Bearer <token>
You can also inspect the code for the processor. These resise in:
The definitions are in the protected attribute:
$details