Returns the help text for a given service action
643 matches
Other/OSDB REST API v1
Action help
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
{
"type": "object",
"properties": {
"actionId": {
"type": "string"
},
"serviceId": {
"type": "string"
}
},
"required": [
"actionId",
"serviceId"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
{
"type": "object",
"required": [
"api",
"method",
"response",
"status"
],
"properties": {
"api": {
"type": "string",
"description": "The path of the REST API method"
},
"method": {
"type": "string",
"description": "The name of the REST API method"
},
"response": {
"type": "object",
"required": [
"action_id",
"help_text",
"service_id"
],
"properties": {
"action_id": {
"type": "string",
"description": "A unique one word identifier for the action."
},
"help_text": {
"type": "string",
"description": "The help text for the action."
},
"service_id": {
"type": "string",
"description": "A unique one word identifier for the service."
}
}
},
"status": {
"type": "string",
"enum": [
"success"
]
}
}
}