diff options
author | Bryan Newbold <bnewbold@robocracy.org> | 2019-01-09 16:18:42 -0800 |
---|---|---|
committer | Bryan Newbold <bnewbold@robocracy.org> | 2019-01-09 16:18:42 -0800 |
commit | 30618aaaf858b671544be984f5aa47681777e23e (patch) | |
tree | e46af59deed2515bf5dce9948d5773e7abba566b /fatcat-openapi2.yml | |
parent | d13f2d6a6d452970c019147cd95e4d27e79799fa (diff) | |
download | fatcat-30618aaaf858b671544be984f5aa47681777e23e.tar.gz fatcat-30618aaaf858b671544be984f5aa47681777e23e.zip |
towards better success/error response types
Diffstat (limited to 'fatcat-openapi2.yml')
-rw-r--r-- | fatcat-openapi2.yml | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/fatcat-openapi2.yml b/fatcat-openapi2.yml index 4babc475..da582ade 100644 --- a/fatcat-openapi2.yml +++ b/fatcat-openapi2.yml @@ -101,16 +101,25 @@ definitions: error_response: type: object required: + - success + - error - message properties: + success: + type: boolean + error: + type: string message: type: string example: "A really confusing, totally unexpected thing happened" success: type: object required: + - success - message properties: + success: + type: boolean message: type: string example: "The computers did the thing successfully!" |