From 8aa05a3cd08c3e69d89a1ea308aa12312c90451d Mon Sep 17 00:00:00 2001 From: Sidney Seo Date: Thu, 25 Aug 2022 16:24:13 +0000 Subject: [PATCH] GitBook: [#165] No subject --- .gitbook/assets/erase (1).json | 1037 -------------------------------- .gitbook/assets/erase.json | 863 -------------------------- .gitbook/assets/erase.yaml | 505 ++++++++++++++++ .gitbook/assets/openapi.json | 822 ------------------------- developers/api-references.md | 504 ++++++++++++++++ 5 files changed, 1009 insertions(+), 2722 deletions(-) delete mode 100644 .gitbook/assets/erase (1).json delete mode 100644 .gitbook/assets/erase.json create mode 100644 .gitbook/assets/erase.yaml delete mode 100644 .gitbook/assets/openapi.json diff --git a/.gitbook/assets/erase (1).json b/.gitbook/assets/erase (1).json deleted file mode 100644 index 23c77fb..0000000 --- a/.gitbook/assets/erase (1).json +++ /dev/null @@ -1,1037 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "version": "1.0.6", - "title": "Swagger Petstore", - "termsOfService": "http://swagger.io/terms/", - "contact": { - "email": "apiteam@swagger.io" - }, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath": "/v2", - "tags": [ - { - "name": "pet", - "description": "Everything about your Pets", - "externalDocs": { - "description": "Find out more", - "url": "http://swagger.io" - } - }, - { - "name": "store", - "description": "Access to Petstore orders" - }, - { - "name": "user", - "description": "Operations about user", - "externalDocs": { - "description": "Find out more about our store", - "url": "http://swagger.io" - } - } - ], - "paths": { - "/pet/{petId}/uploadImage": { - "post": { - "tags": [ - "pet" - ], - "summary": "uploads an image", - "description": "", - "operationId": "uploadFile", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet to update", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "additionalMetadata", - "in": "formData", - "description": "Additional data to pass to server", - "required": false, - "type": "string" - }, - { - "name": "file", - "in": "formData", - "description": "file to upload", - "required": false, - "type": "file" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/ApiResponse" - } - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/pet": { - "post": { - "tags": [ - "pet" - ], - "summary": "Add a new pet to the store", - "description": "", - "operationId": "addPet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Pet object that needs to be added to the store", - "required": true, - "schema": { - "$ref": "#/definitions/Pet" - } - } - ], - "responses": { - "405": { - "description": "Invalid input" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - }, - "put": { - "tags": [ - "pet" - ], - "summary": "Update an existing pet", - "description": "", - "operationId": "updatePet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Pet object that needs to be added to the store", - "required": true, - "schema": { - "$ref": "#/definitions/Pet" - } - } - ], - "responses": { - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - }, - "405": { - "description": "Validation exception" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/pet/findByStatus": { - "get": { - "tags": [ - "pet" - ], - "summary": "Finds Pets by status", - "description": "Multiple status values can be provided with comma separated strings", - "operationId": "findPetsByStatus", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "status", - "in": "query", - "description": "Status values that need to be considered for filter", - "required": true, - "type": "array", - "items": { - "type": "string", - "enum": [ - "available", - "pending", - "sold" - ], - "default": "available" - }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Pet" - } - } - }, - "400": { - "description": "Invalid status value" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/pet/findByTags": { - "get": { - "tags": [ - "pet" - ], - "summary": "Finds Pets by tags", - "description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", - "operationId": "findPetsByTags", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "tags", - "in": "query", - "description": "Tags to filter by", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Pet" - } - } - }, - "400": { - "description": "Invalid tag value" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ], - "deprecated": true - } - }, - "/pet/{petId}": { - "get": { - "tags": [ - "pet" - ], - "summary": "Find pet by ID", - "description": "Returns a single pet", - "operationId": "getPetById", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet to return", - "required": true, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Pet" - } - }, - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - } - }, - "security": [ - { - "api_key": [ - - ] - } - ] - }, - "post": { - "tags": [ - "pet" - ], - "summary": "Updates a pet in the store with form data", - "description": "", - "operationId": "updatePetWithForm", - "consumes": [ - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet that needs to be updated", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "name", - "in": "formData", - "description": "Updated name of the pet", - "required": false, - "type": "string" - }, - { - "name": "status", - "in": "formData", - "description": "Updated status of the pet", - "required": false, - "type": "string" - } - ], - "responses": { - "405": { - "description": "Invalid input" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - }, - "delete": { - "tags": [ - "pet" - ], - "summary": "Deletes a pet", - "description": "", - "operationId": "deletePet", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "api_key", - "in": "header", - "required": false, - "type": "string" - }, - { - "name": "petId", - "in": "path", - "description": "Pet id to delete", - "required": true, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/store/order": { - "post": { - "tags": [ - "store" - ], - "summary": "Place an order for a pet", - "description": "", - "operationId": "placeOrder", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "order placed for purchasing the pet", - "required": true, - "schema": { - "$ref": "#/definitions/Order" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Order" - } - }, - "400": { - "description": "Invalid Order" - } - } - } - }, - "/store/order/{orderId}": { - "get": { - "tags": [ - "store" - ], - "summary": "Find purchase order by ID", - "description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions", - "operationId": "getOrderById", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "ID of pet that needs to be fetched", - "required": true, - "type": "integer", - "maximum": 10, - "minimum": 1, - "format": "int64" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Order" - } - }, - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Order not found" - } - } - }, - "delete": { - "tags": [ - "store" - ], - "summary": "Delete purchase order by ID", - "description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", - "operationId": "deleteOrder", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "ID of the order that needs to be deleted", - "required": true, - "type": "integer", - "minimum": 1, - "format": "int64" - } - ], - "responses": { - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Order not found" - } - } - } - }, - "/store/inventory": { - "get": { - "tags": [ - "store" - ], - "summary": "Returns pet inventories by status", - "description": "Returns a map of status codes to quantities", - "operationId": "getInventory", - "produces": [ - "application/json" - ], - "parameters": [ - - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - } - } - } - }, - "security": [ - { - "api_key": [ - - ] - } - ] - } - }, - "/user/createWithArray": { - "post": { - "tags": [ - "user" - ], - "summary": "Creates list of users with given input array", - "description": "", - "operationId": "createUsersWithArrayInput", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "List of user object", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/User" - } - } - } - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user/createWithList": { - "post": { - "tags": [ - "user" - ], - "summary": "Creates list of users with given input array", - "description": "", - "operationId": "createUsersWithListInput", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "List of user object", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/User" - } - } - } - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user/{username}": { - "get": { - "tags": [ - "user" - ], - "summary": "Get user by user name", - "description": "", - "operationId": "getUserByName", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "username", - "in": "path", - "description": "The name that needs to be fetched. Use user1 for testing. ", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/User" - } - }, - "400": { - "description": "Invalid username supplied" - }, - "404": { - "description": "User not found" - } - } - }, - "put": { - "tags": [ - "user" - ], - "summary": "Updated user", - "description": "This can only be done by the logged in user.", - "operationId": "updateUser", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "username", - "in": "path", - "description": "name that need to be updated", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "description": "Updated user object", - "required": true, - "schema": { - "$ref": "#/definitions/User" - } - } - ], - "responses": { - "400": { - "description": "Invalid user supplied" - }, - "404": { - "description": "User not found" - } - } - }, - "delete": { - "tags": [ - "user" - ], - "summary": "Delete user", - "description": "This can only be done by the logged in user.", - "operationId": "deleteUser", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "username", - "in": "path", - "description": "The name that needs to be deleted", - "required": true, - "type": "string" - } - ], - "responses": { - "400": { - "description": "Invalid username supplied" - }, - "404": { - "description": "User not found" - } - } - } - }, - "/user/login": { - "get": { - "tags": [ - "user" - ], - "summary": "Logs user into the system", - "description": "", - "operationId": "loginUser", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "username", - "in": "query", - "description": "The user name for login", - "required": true, - "type": "string" - }, - { - "name": "password", - "in": "query", - "description": "The password for login in clear text", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "headers": { - "X-Expires-After": { - "type": "string", - "format": "date-time", - "description": "date in UTC when token expires" - }, - "X-Rate-Limit": { - "type": "integer", - "format": "int32", - "description": "calls per hour allowed by the user" - } - }, - "schema": { - "type": "string" - } - }, - "400": { - "description": "Invalid username/password supplied" - } - } - } - }, - "/user/logout": { - "get": { - "tags": [ - "user" - ], - "summary": "Logs out current logged in user session", - "description": "", - "operationId": "logoutUser", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user": { - "post": { - "tags": [ - "user" - ], - "summary": "Create user", - "description": "This can only be done by the logged in user.", - "operationId": "createUser", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Created user object", - "required": true, - "schema": { - "$ref": "#/definitions/User" - } - } - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - } - }, - "definitions": { - "ApiResponse": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "type": { - "type": "string" - }, - "message": { - "type": "string" - } - } - }, - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - }, - "xml": { - "name": "Category" - } - }, - "Pet": { - "type": "object", - "required": [ - "name", - "photoUrls" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "category": { - "$ref": "#/definitions/Category" - }, - "name": { - "type": "string", - "example": "doggie" - }, - "photoUrls": { - "type": "array", - "xml": { - "wrapped": true - }, - "items": { - "type": "string", - "xml": { - "name": "photoUrl" - } - } - }, - "tags": { - "type": "array", - "xml": { - "wrapped": true - }, - "items": { - "xml": { - "name": "tag" - }, - "$ref": "#/definitions/Tag" - } - }, - "status": { - "type": "string", - "description": "pet status in the store", - "enum": [ - "available", - "pending", - "sold" - ] - } - }, - "xml": { - "name": "Pet" - } - }, - "Tag": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - }, - "xml": { - "name": "Tag" - } - }, - "Order": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "petId": { - "type": "integer", - "format": "int64" - }, - "quantity": { - "type": "integer", - "format": "int32" - }, - "shipDate": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "description": "Order Status", - "enum": [ - "placed", - "approved", - "delivered" - ] - }, - "complete": { - "type": "boolean" - } - }, - "xml": { - "name": "Order" - } - }, - "User": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "username": { - "type": "string" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "email": { - "type": "string" - }, - "password": { - "type": "string" - }, - "phone": { - "type": "string" - }, - "userStatus": { - "type": "integer", - "format": "int32", - "description": "User Status" - } - }, - "xml": { - "name": "User" - } - } - } - } \ No newline at end of file diff --git a/.gitbook/assets/erase.json b/.gitbook/assets/erase.json deleted file mode 100644 index 7ea34ec..0000000 --- a/.gitbook/assets/erase.json +++ /dev/null @@ -1,863 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "version": "1.0.6", - "title": "Swagger Petstore", - "termsOfService": "http://swagger.io/terms/", - "contact": { - "email": "apiteam@swagger.io" - }, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath": "/v2", - "tags": [ - { - "name": "pet", - "description": "Everything about your Pets", - "externalDocs": { - "description": "Find out more", - "url": "http://swagger.io" - } - }, - { - "name": "store", - "description": "Access to Petstore orders" - }, - { - "name": "user", - "description": "Operations about user", - "externalDocs": { - "description": "Find out more about our store", - "url": "http://swagger.io" - } - } - ], - "paths": { - "/pet/{petId}/uploadImage": { - "post": { - "tags": [ - "pet" - ], - "summary": "uploads an image", - "description": "", - "operationId": "uploadFile", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet to update", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "additionalMetadata", - "in": "formData", - "description": "Additional data to pass to server", - "required": false, - "type": "string" - }, - { - "name": "file", - "in": "formData", - "description": "file to upload", - "required": false, - "type": "file" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/ApiResponse" - } - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/pet": { - "post": { - "tags": [ - "pet" - ], - "summary": "Add a new pet to the store", - "description": "", - "operationId": "addPet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Pet object that needs to be added to the store", - "required": true, - "schema": { - "$ref": "#/definitions/Pet" - } - } - ], - "responses": { - "405": { - "description": "Invalid input" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - }, - "put": { - "tags": [ - "pet" - ], - "summary": "Update an existing pet", - "description": "", - "operationId": "updatePet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Pet object that needs to be added to the store", - "required": true, - "schema": { - "$ref": "#/definitions/Pet" - } - } - ], - "responses": { - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - }, - "405": { - "description": "Validation exception" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/pet/findByStatus": { - "get": { - "tags": [ - "pet" - ], - "summary": "Finds Pets by status", - "description": "Multiple status values can be provided with comma separated strings", - "operationId": "findPetsByStatus", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "status", - "in": "query", - "description": "Status values that need to be considered for filter", - "required": true, - "type": "array", - "items": { - "type": "string", - "enum": [ - "available", - "pending", - "sold" - ], - "default": "available" - }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Pet" - } - } - }, - "400": { - "description": "Invalid status value" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/pet/findByTags": { - "get": { - "tags": [ - "pet" - ], - "summary": "Finds Pets by tags", - "description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", - "operationId": "findPetsByTags", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "tags", - "in": "query", - "description": "Tags to filter by", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Pet" - } - } - }, - "400": { - "description": "Invalid tag value" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ], - "deprecated": true - } - }, - "/pet/{petId}": { - "get": { - "tags": [ - "pet" - ], - "summary": "Find pet by ID", - "description": "Returns a single pet", - "operationId": "getPetById", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet to return", - "required": true, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Pet" - } - }, - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - } - }, - "security": [ - { - "api_key": [ - - ] - } - ] - }, - "post": { - "tags": [ - "pet" - ], - "summary": "Updates a pet in the store with form data", - "description": "", - "operationId": "updatePetWithForm", - "consumes": [ - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet that needs to be updated", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "name", - "in": "formData", - "description": "Updated name of the pet", - "required": false, - "type": "string" - }, - { - "name": "status", - "in": "formData", - "description": "Updated status of the pet", - "required": false, - "type": "string" - } - ], - "responses": { - "405": { - "description": "Invalid input" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - }, - "delete": { - "tags": [ - "pet" - ], - "summary": "Deletes a pet", - "description": "", - "operationId": "deletePet", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "api_key", - "in": "header", - "required": false, - "type": "string" - }, - { - "name": "petId", - "in": "path", - "description": "Pet id to delete", - "required": true, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/store/order": { - "post": { - "tags": [ - "store" - ], - "summary": "Place an order for a pet", - "description": "", - "operationId": "placeOrder", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "order placed for purchasing the pet", - "required": true, - "schema": { - "$ref": "#/definitions/Order" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Order" - } - }, - "400": { - "description": "Invalid Order" - } - } - } - }, - "/store/order/{orderId}": { - "get": { - "tags": [ - "store" - ], - "summary": "Find purchase order by ID", - "description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions", - "operationId": "getOrderById", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "ID of pet that needs to be fetched", - "required": true, - "type": "integer", - "maximum": 10, - "minimum": 1, - "format": "int64" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Order" - } - }, - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Order not found" - } - } - }, - "delete": { - "tags": [ - "store" - ], - "summary": "Delete purchase order by ID", - "description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", - "operationId": "deleteOrder", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "ID of the order that needs to be deleted", - "required": true, - "type": "integer", - "minimum": 1, - "format": "int64" - } - ], - "responses": { - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Order not found" - } - } - } - }, - "/store/inventory": { - "get": { - "tags": [ - "store" - ], - "summary": "Returns pet inventories by status", - "description": "Returns a map of status codes to quantities", - "operationId": "getInventory", - "produces": [ - "application/json" - ], - "parameters": [ - - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - } - } - } - }, - "security": [ - { - "api_key": [ - - ] - } - ] - } - }, - "/user/createWithArray": { - "post": { - "tags": [ - "user" - ], - "summary": "Creates list of users with given input array", - "description": "", - "operationId": "createUsersWithArrayInput", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "List of user object", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/User" - } - } - } - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user/createWithList": { - "post": { - "tags": [ - "user" - ], - "summary": "Creates list of users with given input array", - "description": "", - "operationId": "createUsersWithListInput", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "List of user object", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/User" - } - } - } - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user/{username}": { - "get": { - "tags": [ - "user" - ], - "summary": "Get user by user name", - "description": "", - "operationId": "getUserByName", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "username", - "in": "path", - "description": "The name that needs to be fetched. Use user1 for testing. ", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/User" - } - }, - "400": { - "description": "Invalid username supplied" - }, - "404": { - "description": "User not found" - } - } - }, - "put": { - "tags": [ - "user" - ], - "summary": "Updated user", - "description": "This can only be done by the logged in user.", - "operationId": "updateUser", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "username", - "in": "path", - "description": "name that need to be updated", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "description": "Updated user object", - "required": true, - "schema": { - "$ref": "#/definitions/User" - } - } - ], - "responses": { - "400": { - "description": "Invalid user supplied" - }, - "404": { - "description": "User not found" - } - } - }, - "delete": { - "tags": [ - "user" - ], - "summary": "Delete user", - "description": "This can only be done by the logged in user.", - "operationId": "deleteUser", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "username", - "in": "path", - "description": "The name that needs to be deleted", - "required": true, - "type": "string" - } - ], - "responses": { - "400": { - "description": "Invalid username supplied" - }, - "404": { - "description": "User not found" - } - } - } - }, - "/user/login": { - "get": { - "tags": [ - "user" - ], - "summary": "Logs user into the system", - "description": "", - "operationId": "loginUser", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "username", - "in": "query", - "description": "The user name for login", - "required": true, - "type": "string" - }, - { - "name": "password", - "in": "query", - "description": "The password for login in clear text", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "headers": { - "X-Expires-After": { - "type": "string", - "format": "date-time", - "description": "date in UTC when token expires" - }, - "X-Rate-Limit": { - "type": "integer", - "format": "int32", - "description": "calls per hour allowed by the user" - } - }, - "schema": { - "type": "string" - } - }, - "400": { - "description": "Invalid username/password supplied" - } - } - } - }, - "/user/logout": { - "get": { - "tags": [ - "user" - ], - "summary": "Logs out current logged in user session", - "description": "", - "operationId": "logoutUser", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user": { - "post": { - "tags": [ - "user" - ], - "summary": "Create user", - "description": "This can only be done by the logged in user.", - "operationId": "createUser", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Created user object", - "required": true, - "schema": { - "$ref": "#/definitions/User" - } - } - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - } - } - } \ No newline at end of file diff --git a/.gitbook/assets/erase.yaml b/.gitbook/assets/erase.yaml new file mode 100644 index 0000000..d180274 --- /dev/null +++ b/.gitbook/assets/erase.yaml @@ -0,0 +1,505 @@ +--- +openapi: 3.0.0 +paths: + "/v1/allswaps": + get: + operationId: PoolController_getAllSwaps + summary: Returns all existing swaps with status + parameters: [] + responses: + '200': + description: Succesfully returning all existing swaps + '403': + description: Forbidden + '404': + description: Not found + tags: + - pool + "/v1/pool_stats/{pool_token}": + get: + operationId: PoolController_getPriceHistory + summary: Returns pool stats + parameters: + - name: pool_token + required: true + in: path + description: pool token of swap pool eg. fwp-alex-wslm + schema: + oneOf: + - type: string + - type: integer + - name: offset + required: false + in: query + description: Specifies the offset of data to be returned, default value is + 0 + schema: {} + - name: limit + required: true + in: query + description: Specifies number of data to be returned, default value is 10 + schema: {} + responses: + '200': + description: Succesfully returning pool stats + '403': + description: Forbidden + '404': + description: Not found + tags: + - pool + "/v1/pool_volume/{pool_token}": + get: + operationId: PoolController_getPoolVolumeHistory + summary: Returns all 24 hour pool volumes in time series + parameters: + - name: pool_token + required: true + in: path + description: pool token of swap pool eg. fwp-alex-wslm + schema: + oneOf: + - type: string + - type: integer + - name: offset + required: false + in: query + description: Specifies the offset of data to be returned, default value is + 0 + schema: {} + - name: limit + required: true + in: query + description: Specifies number of data to be returned, default value is 10 + schema: {} + responses: + '200': + description: Succesfully returning volumes + '403': + description: Forbidden + '404': + description: Not found + tags: + - pool + "/v1/volume_24h/{token}": + get: + operationId: PoolController_getVolume24HRHistory + summary: Returns daily volumes of token in time series + parameters: + - name: token + required: true + in: path + description: name of token eg. age000-governance-token + schema: + oneOf: + - type: string + - type: integer + - name: offset + required: false + in: query + description: Specifies the offset of data to be returned, default value is + 0 + schema: {} + - name: limit + required: true + in: query + description: Specifies number of data to be returned, default value is 10 + schema: {} + responses: + '200': + description: Succesfully returning volumes + '403': + description: Forbidden + '404': + description: Not found + tags: + - pool + "/v1/volume_7d/{token}": + get: + operationId: PoolController_getVolume7DHistory + summary: Returns weekly volumes of token in time series + parameters: + - name: token + required: true + in: path + description: name of token eg. age000-governance-token + schema: + oneOf: + - type: string + - type: integer + - name: offset + required: false + in: query + description: Specifies the offset of data to be returned, default value is + 0 + schema: {} + - name: limit + required: true + in: query + description: Specifies number of data to be returned, default value is 10 + schema: {} + responses: + '200': + description: Succesfully returning volumes + '403': + description: Forbidden + '404': + description: Not found + tags: + - pool + "/v1/pool_liquidity/{pool_token}": + get: + operationId: PoolController_getPoolLiquidityHistory + summary: Returns liquidity in time series + parameters: + - name: pool_token + required: true + in: path + description: pool token of swap pool eg. fwp-alex-wslm + schema: + oneOf: + - type: string + - type: integer + - name: offset + required: false + in: query + description: Specifies the offset of data to be returned, default value is + 0 + schema: {} + - name: limit + required: true + in: query + description: Specifies number of data to be returned, default value is 10 + schema: {} + responses: + '200': + description: Succesfully returning liquidity + '403': + description: Forbidden + '404': + description: Not found + tags: + - pool + "/v1/liquidity/{token}": + get: + operationId: PoolController_getLiquidityHistory + summary: Returns liquidity of token in time series + parameters: + - name: token + required: true + in: path + description: name of token eg. age000-governance-token + schema: + oneOf: + - type: string + - type: integer + - name: offset + required: false + in: query + description: Specifies the offset of data to be returned, default value is + 0 + schema: {} + - name: limit + required: false + in: query + description: Specifies number of data to be returned, default value is 10 + schema: {} + responses: + '200': + description: Succesfully returning liquidity + '403': + description: Forbidden + '404': + description: Not found + tags: + - pool + "/v1/fee/{pool_token}": + get: + operationId: PoolController_getFeeHistory + summary: Returns pool fee in time series + parameters: + - name: pool_token + required: true + in: path + description: pool token of swap pool eg. fwp-alex-wslm + schema: + oneOf: + - type: string + - type: integer + - name: offset + required: false + in: query + description: Specifies the offset of data to be returned, default value is + 0 + schema: {} + - name: limit + required: true + in: query + description: Specifies number of data to be returned, default value is 10 + schema: {} + responses: + '200': + description: Succesfully returning fee + '403': + description: Forbidden + '404': + description: Not found + tags: + - pool + "/v1/stats/tvl": + get: + operationId: StatsController_getTVL + summary: Returns total TVL(total value locked) value of ALEX platform + parameters: [] + responses: + '200': + description: Succesfully returning TVL + '403': + description: Forbidden + '404': + description: Not found + tags: + - stats + "/v1/stats/tvl/{token}": + get: + operationId: StatsController_getTokenTVL + summary: Returns token TVL(total value locked) in time series + parameters: + - name: token + required: true + in: path + schema: + type: string + - name: offset + required: false + in: query + description: Specifies the offset of data to be returned, default value is + 0 + schema: {} + - name: limit + required: false + in: query + description: Specifies number of data to be returned, default value is 10 + schema: {} + responses: + '200': + description: Succesfully returning liquidity + '403': + description: Forbidden + '404': + description: Not found + tags: + - stats + "/v1/stats/total_supply/{token}": + get: + operationId: StatsController_getTotalSupply + summary: Returns total supply of queried token eg. age000-governance-token + parameters: + - name: token + required: true + in: path + schema: + type: string + responses: + '200': + description: Succesfully returning total supply + '403': + description: Forbidden + '404': + description: Not found + tags: + - stats + "/v1/price/{token}": + get: + operationId: PriceController_getPrice + summary: Returns price of token + parameters: + - name: token + required: true + in: path + description: name of token eg. age000-governance-token + schema: + oneOf: + - type: string + - type: integer + responses: + '200': + description: Succesfully returning price + '403': + description: Forbidden + '404': + description: Not found + tags: + - price + "/v1/pool_token_price/{pool_token}": + get: + operationId: PriceController_getPoolTokenPrice + summary: Returns pool token price value of ALEX platform + parameters: + - name: pool_token + required: true + in: path + description: pool token of swap pool eg. fwp-alex-wslm + schema: + oneOf: + - type: string + - type: integer + responses: + '200': + description: Succesfully returning Pool token price + '403': + description: Forbidden + '404': + description: Not found + tags: + - price + "/v1/pool_token_stats": + get: + operationId: PriceController_getAllPoolTokenPrice + summary: Returns pool token price value of ALEX platform + parameters: [] + responses: + '200': + description: Succesfully returning all existing pool token stats + '403': + description: Forbidden + '404': + description: Not found + tags: + - price + "/v1/price_history/{token}": + get: + operationId: PriceController_getPriceHistory + summary: Returns price history of token + parameters: + - name: token + required: true + in: path + description: name of token eg. age000-governance-token + schema: + oneOf: + - type: string + - type: integer + - name: offset + required: false + in: query + description: Specifies the offset of data to be returned, default value is + 0 + schema: {} + - name: limit + required: false + in: query + description: Specifies number of data to be returned, default value is 10 + schema: {} + responses: + '200': + description: Succesfully returning price history + '403': + description: Forbidden + '404': + description: Not found + tags: + - price + "/v1/pairs": + get: + operationId: DexController_getAllPairs + summary: Returns all existing pairs + parameters: [] + responses: + '200': + description: Succesfully returning all existing pairs + '403': + description: Forbidden + '404': + description: Not found + tags: + - dex + "/v1/tickers": + get: + operationId: DexController_getAllTickers + summary: Returns all markets statistics for the last 24 hours + parameters: [] + responses: + '200': + description: Succesfully returning all markets statistics for the last 24 + hours + '403': + description: Forbidden + '404': + description: Not found + tags: + - dex + "/v1/historical_swaps/{ticker}": + get: + operationId: DexController_getHistoricalTrades + summary: Returns all existing historical trades + parameters: + - name: ticker + required: true + in: path + description: A ticker with delimiter between different cryptoassets eg. ALEX_WSLM + schema: + oneOf: + - type: string + - type: integer + - name: limit + required: true + in: query + description: Specifies number of recent block heights to be returned, default + value is 1000 + schema: {} + responses: + '200': + description: Succesfully returning all historical trades of certain ticker + '403': + description: Forbidden + '404': + description: Not found + tags: + - dex + "/v1/orderbook/{ticker_id}": + get: + operationId: DexController_getOrderBookDepth + summary: Returns orderbook information + parameters: + - name: ticker_id + required: true + in: path + description: A ticker with delimiter between different cryptoassets eg. ALEX_WSLM + schema: + oneOf: + - type: string + - type: integer + - name: depth + required: true + in: query + description: Specifies value of depth on either side of bid/ask + schema: {} + responses: + '200': + description: Return orderbook information of queried ticker + '403': + description: Forbidden + '404': + description: Not found + tags: + - dex +info: + title: Alex REST API + description: Alex Open API service + version: '1.0' + contact: + name: ALEX DEV Team + url: https://app.alexgo.io + email: sidney@alexgo.io +tags: +- name: ALEX REST API + description: ALEX Open API for public usage +servers: [] +components: + securitySchemes: + bearer: + scheme: bearer + bearerFormat: JWT + type: http + schemas: {} diff --git a/.gitbook/assets/openapi.json b/.gitbook/assets/openapi.json deleted file mode 100644 index 1392227..0000000 --- a/.gitbook/assets/openapi.json +++ /dev/null @@ -1,822 +0,0 @@ -{ - "openapi": "3.0.0", - "paths": { - "/v1/allswaps": { - "get": { - "operationId": "PoolController_getAllSwaps", - "summary": "Returns all existing swaps with status", - "parameters": [], - "responses": { - "200": { - "description": "Succesfully returning all existing swaps", - "schema": { - "$ref": "#/definitions/ApiResponse" - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "pool" - ] - } - }, - "/v1/pool_stats/{pool_token}": { - "get": { - "operationId": "PoolController_getPriceHistory", - "summary": "Returns pool stats", - "parameters": [ - { - "name": "pool_token", - "required": true, - "in": "path", - "description": "pool token of swap pool eg. fwp-alex-wslm", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - } - }, - { - "name": "offset", - "required": false, - "in": "query", - "description": "Specifies the offset of data to be returned, default value is 0", - "schema": {} - }, - { - "name": "limit", - "required": true, - "in": "query", - "description": "Specifies number of data to be returned, default value is 10", - "schema": {} - } - ], - "responses": { - "200": { - "description": "Succesfully returning pool stats", - "schema": { - "$ref": "#/definitions/ApiResponse" - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "pool" - ] - } - }, - "/v1/pool_volume/{pool_token}": { - "get": { - "operationId": "PoolController_getPoolVolumeHistory", - "summary": "Returns all 24 hour pool volumes in time series", - "parameters": [ - { - "name": "pool_token", - "required": true, - "in": "path", - "description": "pool token of swap pool eg. fwp-alex-wslm", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - } - }, - { - "name": "offset", - "required": false, - "in": "query", - "description": "Specifies the offset of data to be returned, default value is 0", - "schema": {} - }, - { - "name": "limit", - "required": true, - "in": "query", - "description": "Specifies number of data to be returned, default value is 10", - "schema": {} - } - ], - "responses": { - "200": { - "description": "Succesfully returning volumes", - "schema": { - "$ref": "#/definitions/ApiResponse" - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "pool" - ] - } - }, - "/v1/volume_24h/{token}": { - "get": { - "operationId": "PoolController_getVolume24HRHistory", - "summary": "Returns daily volumes of token in time series", - "parameters": [ - { - "name": "token", - "required": true, - "in": "path", - "description": "name of token eg. age000-governance-token", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - } - }, - { - "name": "offset", - "required": false, - "in": "query", - "description": "Specifies the offset of data to be returned, default value is 0", - "schema": {} - }, - { - "name": "limit", - "required": true, - "in": "query", - "description": "Specifies number of data to be returned, default value is 10", - "schema": {} - } - ], - "responses": { - "200": { - "description": "Succesfully returning volumes" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "pool" - ] - } - }, - "/v1/volume_7d/{token}": { - "get": { - "operationId": "PoolController_getVolume7DHistory", - "summary": "Returns weekly volumes of token in time series", - "parameters": [ - { - "name": "token", - "required": true, - "in": "path", - "description": "name of token eg. age000-governance-token", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - } - }, - { - "name": "offset", - "required": false, - "in": "query", - "description": "Specifies the offset of data to be returned, default value is 0", - "schema": {} - }, - { - "name": "limit", - "required": true, - "in": "query", - "description": "Specifies number of data to be returned, default value is 10", - "schema": {} - } - ], - "responses": { - "200": { - "description": "Succesfully returning volumes" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "pool" - ] - } - }, - "/v1/pool_liquidity/{pool_token}": { - "get": { - "operationId": "PoolController_getPoolLiquidityHistory", - "summary": "Returns liquidity in time series", - "parameters": [ - { - "name": "pool_token", - "required": true, - "in": "path", - "description": "pool token of swap pool eg. fwp-alex-wslm", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - } - }, - { - "name": "offset", - "required": false, - "in": "query", - "description": "Specifies the offset of data to be returned, default value is 0", - "schema": {} - }, - { - "name": "limit", - "required": true, - "in": "query", - "description": "Specifies number of data to be returned, default value is 10", - "schema": {} - } - ], - "responses": { - "200": { - "description": "Succesfully returning liquidity" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "pool" - ] - } - }, - "/v1/liquidity/{token}": { - "get": { - "operationId": "PoolController_getLiquidityHistory", - "summary": "Returns liquidity of token in time series", - "parameters": [ - { - "name": "token", - "required": true, - "in": "path", - "description": "name of token eg. age000-governance-token", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - } - }, - { - "name": "offset", - "required": false, - "in": "query", - "description": "Specifies the offset of data to be returned, default value is 0", - "schema": {} - }, - { - "name": "limit", - "required": false, - "in": "query", - "description": "Specifies number of data to be returned, default value is 10", - "schema": {} - } - ], - "responses": { - "200": { - "description": "Succesfully returning liquidity" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "pool" - ] - } - }, - "/v1/fee/{pool_token}": { - "get": { - "operationId": "PoolController_getFeeHistory", - "summary": "Returns pool fee in time series", - "parameters": [ - { - "name": "pool_token", - "required": true, - "in": "path", - "description": "pool token of swap pool eg. fwp-alex-wslm", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - } - }, - { - "name": "offset", - "required": false, - "in": "query", - "description": "Specifies the offset of data to be returned, default value is 0", - "schema": {} - }, - { - "name": "limit", - "required": true, - "in": "query", - "description": "Specifies number of data to be returned, default value is 10", - "schema": {} - } - ], - "responses": { - "200": { - "description": "Succesfully returning fee" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "pool" - ] - } - }, - "/v1/stats/tvl": { - "get": { - "operationId": "StatsController_getTVL", - "summary": "Returns total TVL(total value locked) value of ALEX platform", - "parameters": [], - "responses": { - "200": { - "description": "Succesfully returning TVL" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "stats" - ] - } - }, - "/v1/stats/tvl/{token}": { - "get": { - "operationId": "StatsController_getTokenTVL", - "summary": "Returns token TVL(total value locked) in time series", - "parameters": [ - { - "name": "token", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "offset", - "required": false, - "in": "query", - "description": "Specifies the offset of data to be returned, default value is 0", - "schema": {} - }, - { - "name": "limit", - "required": false, - "in": "query", - "description": "Specifies number of data to be returned, default value is 10", - "schema": {} - } - ], - "responses": { - "200": { - "description": "Succesfully returning liquidity", - "schema": { - "$ref": "#/definitions/ApiResponse" - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "stats" - ] - } - }, - "/v1/stats/total_supply/{token}": { - "get": { - "operationId": "StatsController_getTotalSupply", - "summary": "Returns total supply of queried token eg. age000-governance-token", - "parameters": [ - { - "name": "token", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Succesfully returning total supply" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "stats" - ] - } - }, - "/v1/price/{token}": { - "get": { - "operationId": "PriceController_getPrice", - "summary": "Returns price of token", - "parameters": [ - { - "name": "token", - "required": true, - "in": "path", - "description": "name of token eg. age000-governance-token", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - } - } - ], - "responses": { - "200": { - "description": "Succesfully returning price" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "price" - ] - } - }, - "/v1/pool_token_price/{pool_token}": { - "get": { - "operationId": "PriceController_getPoolTokenPrice", - "summary": "Returns pool token price value of ALEX platform", - "parameters": [ - { - "name": "pool_token", - "required": true, - "in": "path", - "description": "pool token of swap pool eg. fwp-alex-wslm", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - } - } - ], - "responses": { - "200": { - "description": "Succesfully returning Pool token price" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "price" - ] - } - }, - "/v1/pool_token_stats": { - "get": { - "operationId": "PriceController_getAllPoolTokenPrice", - "summary": "Returns pool token price value of ALEX platform", - "parameters": [], - "responses": { - "200": { - "description": "Succesfully returning all existing pool token stats" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "price" - ] - } - }, - "/v1/price_history/{token}": { - "get": { - "operationId": "PriceController_getPriceHistory", - "summary": "Returns price history of token", - "parameters": [ - { - "name": "token", - "required": true, - "in": "path", - "description": "name of token eg. age000-governance-token", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - } - }, - { - "name": "offset", - "required": false, - "in": "query", - "description": "Specifies the offset of data to be returned, default value is 0", - "schema": {} - }, - { - "name": "limit", - "required": false, - "in": "query", - "description": "Specifies number of data to be returned, default value is 10", - "schema": {} - } - ], - "responses": { - "200": { - "description": "Succesfully returning price history" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "price" - ] - } - }, - "/v1/pairs": { - "get": { - "operationId": "DexController_getAllPairs", - "summary": "Returns all existing pairs", - "parameters": [], - "responses": { - "200": { - "description": "Succesfully returning all existing pairs" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "dex" - ] - } - }, - "/v1/tickers": { - "get": { - "operationId": "DexController_getAllTickers", - "summary": "Returns all markets statistics for the last 24 hours", - "parameters": [], - "responses": { - "200": { - "description": "Succesfully returning all markets statistics for the last 24 hours" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "dex" - ] - } - }, - "/v1/historical_swaps/{ticker}": { - "get": { - "operationId": "DexController_getHistoricalTrades", - "summary": "Returns all existing historical trades", - "parameters": [ - { - "name": "ticker", - "required": true, - "in": "path", - "description": "A ticker with delimiter between different cryptoassets eg. ALEX_WSLM", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - } - }, - { - "name": "limit", - "required": true, - "in": "query", - "description": "Specifies number of recent block heights to be returned, default value is 1000", - "schema": {} - } - ], - "responses": { - "200": { - "description": "Succesfully returning all historical trades of certain ticker" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "dex" - ] - } - }, - "/v1/orderbook/{ticker_id}": { - "get": { - "operationId": "DexController_getOrderBookDepth", - "summary": "Returns orderbook information", - "parameters": [ - { - "name": "ticker_id", - "required": true, - "in": "path", - "description": "A ticker with delimiter between different cryptoassets eg. ALEX_WSLM", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - } - }, - { - "name": "depth", - "required": true, - "in": "query", - "description": "Specifies value of depth on either side of bid/ask", - "schema": {} - } - ], - "responses": { - "200": { - "description": "Return orderbook information of queried ticker" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not found" - } - }, - "tags": [ - "dex" - ] - } - } - }, - "info": { - "title": "Alex REST API", - "description": "Alex Open API service", - "version": "1.0", - "contact": { - "name": "ALEX DEV Team", - "url": "https://app.alexgo.io", - "email": "sidney@alexgo.io" - } - }, - "tags": [ - { - "name": "ALEX REST API", - "description": "ALEX Open API for public usage" - } - ], - "servers": [], - "components": { - "securitySchemes": { - "bearer": { - "scheme": "bearer", - "bearerFormat": "JWT", - "type": "http" - } - }, - "schemas": {} - }, - "definitions": { - "ApiResponse": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "type": { - "type": "string" - }, - "message": { - "type": "string" - } - } - } - } -} \ No newline at end of file diff --git a/developers/api-references.md b/developers/api-references.md index aa9416c..1d20fed 100644 --- a/developers/api-references.md +++ b/developers/api-references.md @@ -6,6 +6,510 @@ Documentation is also available in json format at [https://api.alexlab.co/swagge +### General + +{% swagger method="get" path="" baseUrl="https://api.alexlab.co/v1/allswaps" summary="/v1/allswaps" %} +{% swagger-description %} +Returns all existing swaps with status +{% endswagger-description %} + +{% swagger-response status="200: OK" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="403: Forbidden" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="404: Not Found" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} +{% endswagger %} + +{% swagger method="get" path="" baseUrl="https://api.alexlab.co/v1/pool_stats" summary="/v1/pool_stats/{pool_token}" %} +{% swagger-description %} +Returns pool stats +{% endswagger-description %} + +{% swagger-parameter in="path" name="pool_token" required="true" %} +pool token of swap pool eg. fwp-alex-wslm +{% endswagger-parameter %} + +{% swagger-response status="200: OK" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="403: Forbidden" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="404: Not Found" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} +{% endswagger %} + +{% swagger method="get" path="" baseUrl="https://api.alexlab.co/v1/pool_volume" summary="/v1/pool_volume/{pool_token}" %} +{% swagger-description %} +Returns all 24 hour pool volumes in time series +{% endswagger-description %} + +{% swagger-parameter in="path" name="pool_token" required="true" %} +pool token of swap pool eg. fwp-alex-wslm +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="offset" type="Int" %} +Specifies the offset of data to be returned, default value is 0 +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="limit" type="Int" %} +Specifies number of data to be returned, default value is 10 +{% endswagger-parameter %} + +{% swagger-response status="200: OK" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="403: Forbidden" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="404: Not Found" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} +{% endswagger %} + +{% swagger method="get" path="" baseUrl="https://api.alexlab.co/v1/volume_24h" summary="/v1/volume_24h/{token}" %} +{% swagger-description %} +Returns daily volumes of token in time series +{% endswagger-description %} + +{% swagger-parameter in="path" name="token" required="true" %} +name of token eg. age000-governance-token" +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="offset" type="Int" %} +Specifies the offset of data to be returned, default value is 0 +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="limit" type="Int" %} +Specifies number of data to be returned, default value is 10 +{% endswagger-parameter %} + +{% swagger-response status="200: OK" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="403: Forbidden" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="404: Not Found" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} +{% endswagger %} + +{% swagger method="get" path="" baseUrl="https://api.alexlab.co/v1/volume_7d" summary="/v1/volume_7d/{token}" %} +{% swagger-description %} +Returns daily volumes of token in time series +{% endswagger-description %} + +{% swagger-parameter in="path" name="token" required="true" %} +name of token eg. age000-governance-token" +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="offset" type="Int" %} +Specifies the offset of data to be returned, default value is 0 +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="limit" type="Int" %} +Specifies number of data to be returned, default value is 10 +{% endswagger-parameter %} + +{% swagger-response status="200: OK" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="403: Forbidden" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="404: Not Found" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} +{% endswagger %} + +{% swagger method="get" path="" baseUrl="https://api.alexlab.co/v1/pool_liquidity" summary="/v1/pool_liquidity/{pool_token}" %} +{% swagger-description %} +Returns liquidity in time series +{% endswagger-description %} + +{% swagger-parameter in="path" name="pool_token" required="true" %} +pool token of swap pool eg. fwp-alex-wslm +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="offset" type="Int" %} +Specifies the offset of data to be returned, default value is 0 +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="limit" type="Int" %} +Specifies number of data to be returned, default value is 10 +{% endswagger-parameter %} + +{% swagger-response status="200: OK" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="403: Forbidden" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="404: Not Found" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} +{% endswagger %} + +{% swagger method="get" path="" baseUrl="https://api.alexlab.co/v1/liquidity" summary="/v1/liquidity/{token}" %} +{% swagger-description %} +Returns liquidity of token in time series +{% endswagger-description %} + +{% swagger-parameter in="path" name="token" required="true" %} +name of token eg. age000-governance-token" +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="offset" type="Int" %} +Specifies the offset of data to be returned, default value is 0 +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="limit" type="Int" %} +Specifies number of data to be returned, default value is 10 +{% endswagger-parameter %} + +{% swagger-response status="200: OK" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="403: Forbidden" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="404: Not Found" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} +{% endswagger %} + +{% swagger method="get" path="" baseUrl="https://api.alexlab.co/v1/fee" summary="/v1/fee/{pool_token}" %} +{% swagger-description %} +Returns pool fee in time series +{% endswagger-description %} + +{% swagger-parameter in="path" name="pool_token" required="true" %} +pool token of swap pool eg. fwp-alex-wslm +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="offset" type="Int" %} +Specifies the offset of data to be returned, default value is 0 +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="limit" type="Int" %} +Specifies number of data to be returned, default value is 10 +{% endswagger-parameter %} + +{% swagger-response status="200: OK" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="403: Forbidden" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="404: Not Found" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} +{% endswagger %} + +{% swagger method="get" path="" baseUrl="https://api.alexlab.co/v1/stats/tvl" summary="/v1/stats/tvl" %} +{% swagger-description %} +Returns total TVL(total value locked) value of ALEX platform +{% endswagger-description %} + +{% swagger-response status="200: OK" description="Succesfully returning all existing pairs" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="403: Forbidden" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="404: Not Found" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} +{% endswagger %} + +{% swagger method="get" path="" baseUrl="https://api.alexlab.co/v1/stats/tvl" summary="/v1/stats/tvl/{token}" %} +{% swagger-description %} +Returns token TVL(total value locked) in time series +{% endswagger-description %} + +{% swagger-parameter in="path" name="token" required="true" %} +name of token eg. age000-governance-token" +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="offset" type="Int" %} +Specifies the offset of data to be returned, default value is 0 +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="limit" type="Int" %} +Specifies number of data to be returned, default value is 10 +{% endswagger-parameter %} + +{% swagger-response status="200: OK" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="403: Forbidden" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="404: Not Found" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} +{% endswagger %} + +{% swagger method="get" path="" baseUrl="https://api.alexlab.co/v1/stats/total_supply" summary="/v1/stats/total_supply/{token}" %} +{% swagger-description %} +Returns total supply of queried token eg. age000-governance-token" +{% endswagger-description %} + +{% swagger-parameter in="path" name="token" required="true" %} +name of token eg. age000-governance-token" +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="offset" type="Int" %} +Specifies the offset of data to be returned, default value is 0 +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="limit" type="Int" %} +Specifies number of data to be returned, default value is 10 +{% endswagger-parameter %} + +{% swagger-response status="200: OK" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="403: Forbidden" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="404: Not Found" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} +{% endswagger %} + +{% swagger method="get" path="" baseUrl="https://api.alexlab.co/v1/price" summary="/v1/price/{token}" %} +{% swagger-description %} +Returns price of token +{% endswagger-description %} + +{% swagger-parameter in="path" name="token" required="true" %} +name of token eg. age000-governance-token" +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="offset" type="Int" %} +Specifies the offset of data to be returned, default value is 0 +{% endswagger-parameter %} + +{% swagger-parameter in="query" name="limit" type="Int" %} +Specifies number of data to be returned, default value is 10 +{% endswagger-parameter %} + +{% swagger-response status="200: OK" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="403: Forbidden" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="404: Not Found" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} +{% endswagger %} + +{% swagger method="get" path="" baseUrl="https://api.alexlab.co/v1/pool_token_stats" summary="/v1/pool_token_stats" %} +{% swagger-description %} +Returns pool token price value of ALEX platform +{% endswagger-description %} + +{% swagger-response status="200: OK" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="403: Forbidden" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} + +{% swagger-response status="404: Not Found" description="" %} +```javascript +{ + // Response +} +``` +{% endswagger-response %} +{% endswagger %} + ### DEX {% swagger method="get" path="" baseUrl="https://api.alexlab.co/v1/pairs" summary="/v1/pairs" %}