OAS: domains

This commit is contained in:
realaravinth
2021-03-31 12:25:39 +05:30
parent a3a118927e
commit e0dab001aa
6 changed files with 1852 additions and 446 deletions

View File

@@ -0,0 +1,817 @@
{
"info": {
"_postman_id": "75a16c22-17aa-43ca-8906-0cc33844f77e",
"name": "mCaptcha/guard",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "api/v1",
"item": [
{
"name": "account",
"item": [
{
"name": "Delete user account",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Authorization",
"type": "string"
},
{
"key": "value",
"value": true,
"type": "boolean"
},
{
"key": "in",
"value": "header",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"password\": \"dolor aliquip laboris id\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/account/delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"account",
"delete"
]
}
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"password\": \"dolor aliquip laboris id\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/account/delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"account",
"delete"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "(cookie)authentication required or wrong password",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"password\": \"dolor aliquip laboris id\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/account/delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"account",
"delete"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"elit enim fugiat\"\n}"
},
{
"name": "username not found",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"password\": \"dolor aliquip laboris id\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/account/delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"account",
"delete"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"elit enim fugiat\"\n}"
},
{
"name": "Internal server error",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"password\": \"dolor aliquip laboris id\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/account/delete",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"account",
"delete"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"elit enim fugiat\"\n}"
}
]
},
{
"name": "Check if username exists",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"val\": \"eiusmod irure s\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/account/username/exists",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"account",
"username",
"exists"
]
}
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"val\": \"eiusmod irure s\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/account/username/exists",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"account",
"username",
"exists"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"val\": false\n}"
},
{
"name": "Internal server error",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"val\": \"eiusmod irure s\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/account/username/exists",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"account",
"username",
"exists"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"elit enim fugiat\"\n}"
}
]
},
{
"name": "Check if email exists",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"val\": \"eiusmod irure s\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/account/email/exists",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"account",
"email",
"exists"
]
}
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"val\": \"eiusmod irure s\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/account/email/exists",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"account",
"email",
"exists"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"val\": false\n}"
},
{
"name": "Internal server error",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"val\": \"eiusmod irure s\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/account/email/exists",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"account",
"email",
"exists"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"elit enim fugiat\"\n}"
}
]
}
]
},
{
"name": "Registration endpoint",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"adipisicing\",\n \"password\": \"quis ut ipsum culpa\",\n \"email\": \"fugiat dolor ullamco magna\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/signup",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"signup"
]
}
},
"response": [
{
"name": "Bad request: username contains profainity/blacklisted words or email not acceptable or password too long/short or duplicate username/password",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"adipisicing\",\n \"password\": \"quis ut ipsum culpa\",\n \"email\": \"fugiat dolor ullamco magna\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/signup",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"signup"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"elit enim fugiat\"\n}"
},
{
"name": "Successful registration",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"adipisicing\",\n \"password\": \"quis ut ipsum culpa\",\n \"email\": \"fugiat dolor ullamco magna\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/signup",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"signup"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Internal server error",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"adipisicing\",\n \"password\": \"quis ut ipsum culpa\",\n \"email\": \"fugiat dolor ullamco magna\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/signup",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"signup"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"elit enim fugiat\"\n}"
}
]
},
{
"name": "Login endpoint",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"voluptate proident nulla cupidatat do\",\n \"password\": \"sint ut commodo\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/signin",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"signin"
]
}
},
"response": [
{
"name": "Successful authentication",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"voluptate proident nulla cupidatat do\",\n \"password\": \"sint ut commodo\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/signin",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"signin"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Internal server error",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"voluptate proident nulla cupidatat do\",\n \"password\": \"sint ut commodo\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/signin",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"signin"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"elit enim fugiat\"\n}"
},
{
"name": "username not found",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"voluptate proident nulla cupidatat do\",\n \"password\": \"sint ut commodo\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/signin",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"signin"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"elit enim fugiat\"\n}"
},
{
"name": "authentication failed, wrong password",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"voluptate proident nulla cupidatat do\",\n \"password\": \"sint ut commodo\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/v1/signin",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"signin"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"elit enim fugiat\"\n}"
}
]
},
{
"name": "Signout endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Authorization",
"type": "string"
},
{
"key": "value",
"value": true,
"type": "boolean"
},
{
"key": "in",
"value": "header",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/signout",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"signout"
]
}
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/signout",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"signout"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
]
}
],
"variable": [
{
"key": "baseUrl",
"value": "http://localhost:3000",
"type": "string"
}
]
}