diff --git a/components/Sidebar/index.js b/components/Sidebar/index.js index 8dd93dc1..48ec36a5 100644 --- a/components/Sidebar/index.js +++ b/components/Sidebar/index.js @@ -1769,21 +1769,7 @@ const Sidebar = ({ searchOpen, setSearchOpen }) => { - API - - - شروع به کار - - - برنامهها - - - دیتابیسها - - - دامنهها - - + API diff --git a/pages/client-api/app.js b/pages/client-api/app.js deleted file mode 100644 index 59c0f7d4..00000000 --- a/pages/client-api/app.js +++ /dev/null @@ -1,349 +0,0 @@ -import Layout from "../../components/Layout"; -import Head from "next/head"; -import Notice from "../../components/Notice"; -import Label from "../../components/Label"; - -export default () => ( - - - مستندات API برنامهها در لیارا - - فهرست عناوین: - - - ایجاد برنامه - - - حذف برنامه - - - روشن کردن برنامه - - - خاموش کردن برنامه - - - استقرار سورسکد - - - بهروزرسانی متغیرهای برنامه - - - تغییر اندازه برنامه - - - دریافت مشخصات یک برنامه مشخص - - - دریافت مشخصات تمام برنامهها - - - - - - - ایجاد برنامه - - POST - /v1/projects - - - ورودیها - - - BODY - - - name - node-app - - - - planID - ir-small - - - - platform - node - - - - - - - - حذف برنامه - - DELETE - - /v1/projects/{`{app-name}`} - - - - ورودیها - - - URL - - - app-name - نام برنامه - - - - - - - روشن کردن برنامه - - POST - - /v1/projects/{`{app-name}`} - /actions/scale - - - - ورودیها - - - URL - - - app-name - نام برنامه - - - BODY - - - scale - 1 - - - - - - - - خاموش کردن برنامه - - POST - - /v1/projects/{`{app-name}`} - /actions/scale - - - - ورودیها - - - URL - - - app-name - نام برنامه - - - BODY - - - scale - 0 - - - - - - - - استقرار سورسکد - - - POST - - /v1/projects/{`{app-name}`} - /sources - - - - ورودیها - - - URL - - - app-name - نام برنامه - - - HEADER - - - Content-Type - multipart/form-data - - - - BODY - - - file - file.tar.gz - - - - - - - - - POST - - /v1/projects/{`{app-name}`} - /releases - - - - ورودیها - - - URL - - - app-name - نام برنامه - - - BODY - - - sourceID - 913ca858-0888-479f-9d9b-aeedca62ca85 - - - port - 3000 - - - type - node - - - - - - - - - ریاستارت کردن برنامه - - POST - - /v1/projects/{`{app-name}`} - /actions/restart - - - - - - - بهروزرسانی متغیرهای برنامه - - POST - /v1/projects/update-envs - - - ورودیها - - - - BODY - - - project - app-name - - - - variables - {`[ - { - "key": "APP_DB_HOST", - "value": "app-db:3306" - }, - { - "key": "APP_DB_USER", - "value": "root" - } - ]`} - - - - - - - - تغییر اندازه برنامه - - POST - - /v1/projects/{`{app-name}`} - /resize - - - - ورودیها - - - URL - - - app-name - نام برنامه - - - BODY - - - planID - ir-standard - - - - - - - - دریافت مشخصات یک برنامه مشخص - - GET - - /v1/projects/{`{app-name}`} - - - - ورودیها - - - URL - - - app-name - نام برنامه - - - - - - - دریافت مشخصات تمام برنامهها - - GET - /v1/projects - - - - - -); diff --git a/pages/client-api/database.js b/pages/client-api/database.js deleted file mode 100644 index ff68fffa..00000000 --- a/pages/client-api/database.js +++ /dev/null @@ -1,303 +0,0 @@ -import Layout from "../../components/Layout"; -import Head from "next/head"; -import Notice from "../../components/Notice"; -import Label from "../../components/Label"; - -export default () => ( - - - مستندات API دیتابیسها در لیارا - - فهرست عناوین: - - - راهاندازی دیتابیس - - - حذف دیتابیس - - - روشن کردن دیتابیس - - - خاموش کردن دیتابیس - - - تغییر اندازه دیتابیس - - - ایجاد فایل پشتیبان - - - لیست تمام فایلهای پشتیبان - - - دریافت فایل پشتیبان - - - دریافت مشخصات یک دیتابیس مشخص - - - دریافت مشخصات تمام دیتابیسها - - - - - - - راهاندازی دیتابیس - - POST - /v1/databases - - - ورودیها - - - BODY - - - hostname - mysql-db - - - - publicNetwork - true - - - - planID - ir-small - - - - type - mysql - - - - version - 8.0 - - - - - - - - حذف دیتابیس - - DELETE - - /v1/databases/{`{database-id}`} - - - - ورودیها - - - URL - - - database-id - شناسه دیتابیس - - - - - - - روشن کردن دیتابیس - - POST - - /v1/databases/{`{database-id}`} - /actions/scale - - - - ورودیها - - - URL - - - database-id - شناسه دیتابیس - - - BODY - - - scale - 1 - - - - - - - - خاموش کردن دیتابیس - - POST - - /v1/databases/{`{database-id}`} - /actions/scale - - - - ورودیها - - - URL - - - database-id - شناسه دیتابیس - - - BODY - - - scale - 0 - - - - - - - - تغییر اندازه دیتابیس - - POST - - /v1/databases/{`{database-id}`} - /resize - - - - ورودیها - - - URL - - - database-id - شناسه دیتابیس - - - BODY - - - disk - false - - - - planID - ir-standard - - - - - - - - ایجاد فایل پشتیبان - - POST - - /v1/databases/{`{database-id}`} - /backups - - - - ورودیها - - - URL - - - database-id - شناسه دیتابیس - - - - - - - لیست تمام فایلهای پشتیبان - - GET - - /v1/databases/{`{database-id}`} - /backups - - - - - - - دریافت فایل پشتیبان - - POST - - /v1/databases/{`{database-id}`} - /backups/{`{backups-name}`} - /download - - - - ورودیها - - - URL - - - database-id - شناسه دیتابیس - - - backups-name - نام فایل پشتیبان - - - - - - - دریافت مشخصات یک دیتابیس مشخص - - GET - - /v1/databases/{`{database-id}`} - - - - ورودیها - - - URL - - - database-id - شناسه دیتابیس - - - - - - - دریافت مشخصات تمام دیتابیسها - - GET - /v1/databases - - - - - -); diff --git a/pages/client-api/domain.js b/pages/client-api/domain.js deleted file mode 100644 index f578548d..00000000 --- a/pages/client-api/domain.js +++ /dev/null @@ -1,188 +0,0 @@ -import Layout from "../../components/Layout"; -import Head from "next/head"; -import Notice from "../../components/Notice"; -import Label from "../../components/Label"; - -export default () => ( - - - مستندات API دامنهها در لیارا - - فهرست عناوین: - - - افزودن دامنه - - - حذف دامنه - - - دریافت مشخصات یک دامنه - - - اتصال دامنه به یک برنامه مشخص - - - صدور گواهی SSL - - - غیرفعال کردن گواهی SSL - - - مشاهدهی تمام دامنهها - - - - - - - افزودن دامنه - - POST - /v1/domains - - - ورودیها - - - BODY - - - type - PROJECT - - - - name - my-domain.ir - - - - - - - - حذف دامنه - - DELETE - - /v1/domains/{`{domain-id}`} - - - - ورودیها - - - URL - - - domain-id - شناسه دامنه - - - - - - - دریافت مشخصات یک دامنه - - GET - - /v1/domains/{`{domain-name}`} - - - - ورودیها - - - URL - - - domain-name - نام دامنه - - - - - - - اتصال دامنه به یک برنامه مشخص - - POST - /v1/domains/set-project - - - ورودیها - - - BODY - - - projectID - 60fe7f251e7b5f00114c77b1 - - - - domainID - 60fe86b11e7b5f00114c7878 - - - - - - - - صدور گواهی SSL - - POST - /v1/domains/provision-ssl-certs - - - ورودیها - - - BODY - - - domain - my-domain.ir - - - - - - - - غیرفعال کردن گواهی SSL - - POST - - /v1/domains/{`{domain-id}`} - /ssl/disable - - - - ورودیها - - - URL - - - domain-id - شناسه دامنه - - - - - - - مشاهدهی تمام دامنهها - - GET - /v1/domains - - - - - -); diff --git a/pages/client-api/about.js b/pages/openapi.js similarity index 64% rename from pages/client-api/about.js rename to pages/openapi.js index e98024ef..35329274 100644 --- a/pages/client-api/about.js +++ b/pages/openapi.js @@ -1,7 +1,6 @@ -import Layout from "../../components/Layout"; +import Layout from "../components/Layout"; import Head from "next/head"; -import Notice from "../../components/Notice"; -import Label from "../../components/Label"; +import Label from "../components/Label"; import Highlight from "react-highlight"; import Link from "next/link"; @@ -15,7 +14,7 @@ export default () => ( (Liara API) - وبسرویس و در واقع API ما به شما دسترسی کامل به امکانات پلتفرم ابری لیارا + وبسرویس و در واقع API ما به شما دسترسی کامل به امکانات زیرساخت ابری لیارا را میدهد. با استفاده از این API، میتوانید در برنامهها و سرویسهای خودتان از لیارا به عنوان فراهمکنندهی زیر ساخت استفاده کنید. @@ -28,15 +27,18 @@ export default () => ( دریافت اطلاعات جامع کاربری + + مستندات OpenAPI + آدرس API - آدرس API برای دسترسی به برنامهها: - - {`https://api.iran.liara.ir/`} - + هر کدام از محصولات لیارا، آدرس API مخصوص خود را دارند. برای مثال، آدرس API + برای دسترسی به برنامهها: + {`https://api.iran.liara.ir/`} + کلید احراز هویت شما با مراجعه به پنل کاربری و وارد شدن به بخش API امکان مشاهده و دریافت @@ -47,10 +49,10 @@ export default () => ( نحوهی استفاده از این Token برای کار با APIها به این صورت است که آن را بهشکل زیر در HEADERها به سمت endpoint مربوطه ارسال میکنید: - - {`Authorization: Bearer $TOKEN`} - + + {`Authorization: Bearer $TOKEN`} + دریافت اطلاعات جامع کاربری @@ -63,5 +65,20 @@ export default () => ( باشید. بنابراین از اطلاعاتی که از این endpoint دریافت میکنید میتوانید در endpointهای دیگر استفاده کنید. + + مستندات OpenAPI + + مستندات API لیارا در آدرس زیر در دسترس است: + + + https://openapi.liara.ir + + + + ما برای نوشتن این مستندات از OpenAPI Specification v3 استفاده کردهایم که + در GitHub در دسترس + است. بنابراین، میتوانید فایلهای Yaml موجود در ریپازیتوری گیتهاب را در + Postman وارد کنید تا مستقیما به تمام Endpointها دسترسی داشته باشید. + );
- وبسرویس و در واقع API ما به شما دسترسی کامل به امکانات پلتفرم ابری لیارا + وبسرویس و در واقع API ما به شما دسترسی کامل به امکانات زیرساخت ابری لیارا را میدهد. با استفاده از این API، میتوانید در برنامهها و سرویسهای خودتان از لیارا به عنوان فراهمکنندهی زیر ساخت استفاده کنید.
- آدرس API برای دسترسی به برنامهها: - - {`https://api.iran.liara.ir/`} - + هر کدام از محصولات لیارا، آدرس API مخصوص خود را دارند. برای مثال، آدرس API + برای دسترسی به برنامهها:
شما با مراجعه به پنل کاربری و وارد شدن به بخش API امکان مشاهده و دریافت @@ -47,10 +49,10 @@ export default () => ( نحوهی استفاده از این Token برای کار با APIها به این صورت است که آن را بهشکل زیر در HEADERها به سمت endpoint مربوطه ارسال میکنید: - - {`Authorization: Bearer $TOKEN`} -
+ مستندات API لیارا در آدرس زیر در دسترس است: + + + https://openapi.liara.ir + +
+ ما برای نوشتن این مستندات از OpenAPI Specification v3 استفاده کردهایم که + در GitHub در دسترس + است. بنابراین، میتوانید فایلهای Yaml موجود در ریپازیتوری گیتهاب را در + Postman وارد کنید تا مستقیما به تمام Endpointها دسترسی داشته باشید. +