diff --git a/openapi.yaml b/openapi.yaml index 40e79b94..4a50dcbb 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -247,16 +247,21 @@ paths: content: application/json: schema: - type: object - properties: - message: - type: string + oneOf: + - $ref: '#/components/schemas/HelpListResponse' + - $ref: '#/components/schemas/HelpCommandResponse' "400": - description: Failed to get help. The given AsyncAPI command is not valid. + description: Bad request content: application/json: schema: - $ref: "#/components/schemas/Problem" + $ref: '#/components/schemas/Problem' + "404": + description: Command not found + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' default: description: Unexpected problem. content: @@ -453,6 +458,25 @@ components: type: [object, string] description: The diff between the two AsyncAPI documents. + HelpListResponse: + type: object + properties: + commands: + type: array + items: + type: string + description: A list of all available commands. + HelpCommandResponse: + type: object + description: Detailed help information for a specific command. + properties: + command: + type: string + description: The name of the command. + description: + type: string + description: Detailed description of the command. + Problem: type: object properties: