From 191b1955f473b40ab96c51224a97a8ff2b057f50 Mon Sep 17 00:00:00 2001 From: pheralb Date: Fri, 29 Aug 2025 13:44:14 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=84=20Initial=20API=20docs=20without?= =?UTF-8?q?=20svelte=20components=20(working)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/docs/api.md | 33 +-------------------------------- 1 file changed, 1 insertion(+), 32 deletions(-) diff --git a/src/docs/api.md b/src/docs/api.md index fcbf322..16ff811 100644 --- a/src/docs/api.md +++ b/src/docs/api.md @@ -3,11 +3,6 @@ title: API Reference description: The API reference is a detailed documentation of all the endpoints available in the SVGL API. --- - - ## Introduction SVGL API is a RESTFul API that allows you to get all the information of the SVGs that are in the repository. @@ -16,9 +11,7 @@ SVGL API is a RESTFul API that allows you to get all the information of the SVGs The API is currently open to everyone and does not require any authentication. However, to prevent abusive use of the API, there is a limit to the number of requests. - - Don't use the API for create the same product as SVGL. The API is intended to be used for extensions, plugins, or other tools that can help the community. - +Don't use the API for create the same product as SVGL. The API is intended to be used for extensions, plugins, or other tools that can help the community. ## Base URL @@ -64,8 +57,6 @@ export interface iSVG { ## Endpoints - - ```bash https://api.svgl.app ``` @@ -86,10 +77,6 @@ https://api.svgl.app ] ``` - - - - ```bash https://api.svgl.app?limit=10 ``` @@ -110,10 +97,6 @@ https://api.svgl.app?limit=10 ] ``` - - - - ```bash https://api.svgl.app/category/software ``` @@ -136,10 +119,6 @@ https://api.svgl.app/category/software The list of categories is available [here](https://github.com/pheralb/svgl/blob/main/src/types/categories.ts) (except for the _all_ category). - - - - ```bash https://api.svgl.app/svg/adobe.svg ``` @@ -171,10 +150,6 @@ https://api.svgl.app/svg/adobe.svg ``` - - - - ```bash https://api.svgl.app/categories ``` @@ -196,10 +171,6 @@ https://api.svgl.app/categories ] ``` - - - - ```bash https://api.svgl.app?search=axiom ``` @@ -221,5 +192,3 @@ https://api.svgl.app?search=axiom } ] ``` - -