diff --git a/apps/docs/content/references/api.mdx b/apps/docs/content/references/api.mdx new file mode 100644 index 00000000..38d98009 --- /dev/null +++ b/apps/docs/content/references/api.mdx @@ -0,0 +1,111 @@ +--- +title: REST API Reference +desc: Overview of Zerops REST API endpoints and authentication, designed to help you integrate with Zerops programmatically +--- + +The Zerops REST API allows you to programmatically interact with Zerops platform by providing access to resources like projects, services, users, billing, and configurations. + +## Base URL + +All API requests should be made to: +``` +https://api.app-prg1.zerops.io/api/rest/public +``` + +## Authentication + +The API uses Bearer token authentication. You can obtain your Personal access token from the **Access Token management** section in the Zerops GUI. + +Include the token in the Authorization header: +``` +Authorization: Bearer +``` + +## API Resources + +:::note +Some resource groups have non-obvious naming: +- `/service-stack` endpoints handle services management +- `/user-data` endpoints handle environment variables management +::: + +View the [full Swagger documentation](https://api.app-prg1.zerops.io/api/rest/public/swagger) or jump to a specific resource group: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
GroupDescription
/app-versionManage application versions, builds, and deployments
/authAuthentication and token management
/billingBilling operations and payment management
/clientClient account management
/client-userUser management within client accounts
/githubGitHub repository connections and authorization
/gitlabGitLab repository connections and authorization
/projectProject management operations
/project-envProject environment variables management
/public-http-routingHTTP routing configuration
/public-port-routingPort routing and firewall rules configuration
/service-stackService stack operations and configuration
/settingsSystem settings and configurations
/userUser account management
/user-dataEnvironment variables management
/user-notificationUser notifications management
/user-tokenPersonal access tokens management
\ No newline at end of file diff --git a/apps/docs/sidebars.js b/apps/docs/sidebars.js index 329d802d..291e32b5 100644 --- a/apps/docs/sidebars.js +++ b/apps/docs/sidebars.js @@ -643,6 +643,15 @@ module.exports = { }, className: 'homepage-sidebar-item', }, + { + type: 'doc', + id: 'references/api', + label: 'API', + customProps: { + sidebar_icon: 'curly-braces', + }, + className: 'homepage-sidebar-item', + }, { type: 'html', value: 'Help', diff --git a/apps/docs/src/theme/Icon/CurlyBraces/index.tsx b/apps/docs/src/theme/Icon/CurlyBraces/index.tsx new file mode 100644 index 00000000..e82c9481 --- /dev/null +++ b/apps/docs/src/theme/Icon/CurlyBraces/index.tsx @@ -0,0 +1,27 @@ +import { IconProps } from '@medusajs/icons/dist/types'; +import clsx from 'clsx'; +import React from 'react'; + +const IconCurlyBraces = (props: IconProps) => { + return ( + + + + ); +}; + +export default IconCurlyBraces; diff --git a/apps/docs/src/theme/Icon/index.tsx b/apps/docs/src/theme/Icon/index.tsx index bfb33572..9c56bd56 100644 --- a/apps/docs/src/theme/Icon/index.tsx +++ b/apps/docs/src/theme/Icon/index.tsx @@ -41,6 +41,7 @@ import { ComputerDesktopSolid, CreditCardSolid, CubeSolid, + CurlyBraces, CurrencyDollar, CurrencyDollarSolid, Discord, @@ -150,7 +151,7 @@ import IconCloudOk from './CloudOk'; import IconGitlab from './Gitlab'; import IconTypesense from './Typesense'; import IconDocker from './Docker'; - +import IconCurlyBraces from './CurlyBraces'; export default { 'academic-cap-solid': AcademicCapSolid, @@ -306,4 +307,5 @@ export default { database: IconDatabase, cloudok: IconCloudOk, typesense: IconTypesense, + 'curly-braces': IconCurlyBraces, };