From 9c8fec5fd63191c3022d550d223209faec429003 Mon Sep 17 00:00:00 2001 From: Braydon Date: Thu, 1 Jun 2023 01:23:12 -0400 Subject: [PATCH] Include responses in API reference --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 9725c47..43e22e3 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,27 @@ POST /check | `product` | `string` | **Required**. The product the license is for | | `hwid` | `string` | **Required**. The hardware id of the requester | +#### Response + +##### Error + +```json +{ + "error": "Error message" +} +``` + +##### Success + +```json +{ + "description": "Testing", + "ownerSnowflake": 504147739131641857, + "ownerName": "Braydon#2712", + "duration": -1 +} +``` + ## Deployment ### Docker