mirror of
https://github.com/appwrite/appwrite
synced 2026-05-24 01:18:37 +00:00
Merge pull request #9685 from appwrite/chore-docs-endpoint
core: introduce endpoint.docs in specs
This commit is contained in:
commit
8cb4d2894b
15 changed files with 36 additions and 7 deletions
|
|
@ -16,6 +16,9 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"servers": [
|
"servers": [
|
||||||
|
{
|
||||||
|
"url": "https:\/\/cloud.appwrite.io\/v1"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
|
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -16,6 +16,9 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"servers": [
|
"servers": [
|
||||||
|
{
|
||||||
|
"url": "https:\/\/cloud.appwrite.io\/v1"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
|
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -16,6 +16,9 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"servers": [
|
"servers": [
|
||||||
|
{
|
||||||
|
"url": "https:\/\/cloud.appwrite.io\/v1"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
|
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -16,6 +16,9 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"servers": [
|
"servers": [
|
||||||
|
{
|
||||||
|
"url": "https:\/\/cloud.appwrite.io\/v1"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
|
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -16,6 +16,9 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"servers": [
|
"servers": [
|
||||||
|
{
|
||||||
|
"url": "https:\/\/cloud.appwrite.io\/v1"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
|
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -16,6 +16,9 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"servers": [
|
"servers": [
|
||||||
|
{
|
||||||
|
"url": "https:\/\/cloud.appwrite.io\/v1"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
|
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,8 @@
|
||||||
"url": "https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"
|
"url": "https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"host": "<REGION>.cloud.appwrite.io",
|
"host": "cloud.appwrite.io",
|
||||||
|
"x-host-docs": "<REGION>.cloud.appwrite.io",
|
||||||
"basePath": "\/v1",
|
"basePath": "\/v1",
|
||||||
"schemes": [
|
"schemes": [
|
||||||
"https"
|
"https"
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,8 @@
|
||||||
"url": "https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"
|
"url": "https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"host": "<REGION>.cloud.appwrite.io",
|
"host": "cloud.appwrite.io",
|
||||||
|
"x-host-docs": "<REGION>.cloud.appwrite.io",
|
||||||
"basePath": "\/v1",
|
"basePath": "\/v1",
|
||||||
"schemes": [
|
"schemes": [
|
||||||
"https"
|
"https"
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,8 @@
|
||||||
"url": "https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"
|
"url": "https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"host": "<REGION>.cloud.appwrite.io",
|
"host": "cloud.appwrite.io",
|
||||||
|
"x-host-docs": "<REGION>.cloud.appwrite.io",
|
||||||
"basePath": "\/v1",
|
"basePath": "\/v1",
|
||||||
"schemes": [
|
"schemes": [
|
||||||
"https"
|
"https"
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,8 @@
|
||||||
"url": "https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"
|
"url": "https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"host": "<REGION>.cloud.appwrite.io",
|
"host": "cloud.appwrite.io",
|
||||||
|
"x-host-docs": "<REGION>.cloud.appwrite.io",
|
||||||
"basePath": "\/v1",
|
"basePath": "\/v1",
|
||||||
"schemes": [
|
"schemes": [
|
||||||
"https"
|
"https"
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,8 @@
|
||||||
"url": "https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"
|
"url": "https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"host": "<REGION>.cloud.appwrite.io",
|
"host": "cloud.appwrite.io",
|
||||||
|
"x-host-docs": "<REGION>.cloud.appwrite.io",
|
||||||
"basePath": "\/v1",
|
"basePath": "\/v1",
|
||||||
"schemes": [
|
"schemes": [
|
||||||
"https"
|
"https"
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,8 @@
|
||||||
"url": "https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"
|
"url": "https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"host": "<REGION>.cloud.appwrite.io",
|
"host": "cloud.appwrite.io",
|
||||||
|
"x-host-docs": "<REGION>.cloud.appwrite.io",
|
||||||
"basePath": "\/v1",
|
"basePath": "\/v1",
|
||||||
"schemes": [
|
"schemes": [
|
||||||
"https"
|
"https"
|
||||||
|
|
|
||||||
|
|
@ -289,7 +289,8 @@ class Specs extends Action
|
||||||
$formatInstance
|
$formatInstance
|
||||||
->setParam('name', APP_NAME)
|
->setParam('name', APP_NAME)
|
||||||
->setParam('description', 'Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)')
|
->setParam('description', 'Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)')
|
||||||
->setParam('endpoint', 'https://<REGION>.cloud.appwrite.io/v1')
|
->setParam('endpoint', 'https://cloud.appwrite.io/v1')
|
||||||
|
->setParam('endpoint.docs', 'https://<REGION>.cloud.appwrite.io/v1')
|
||||||
->setParam('version', APP_VERSION_STABLE)
|
->setParam('version', APP_VERSION_STABLE)
|
||||||
->setParam('terms', $endpoint . '/policy/terms')
|
->setParam('terms', $endpoint . '/policy/terms')
|
||||||
->setParam('support.email', $email)
|
->setParam('support.email', $email)
|
||||||
|
|
|
||||||
|
|
@ -84,6 +84,9 @@ class OpenAPI3 extends Format
|
||||||
[
|
[
|
||||||
'url' => $this->getParam('endpoint', ''),
|
'url' => $this->getParam('endpoint', ''),
|
||||||
],
|
],
|
||||||
|
[
|
||||||
|
'url' => $this->getParam('endpoint.docs', ''),
|
||||||
|
],
|
||||||
],
|
],
|
||||||
'paths' => [],
|
'paths' => [],
|
||||||
'tags' => $this->services,
|
'tags' => $this->services,
|
||||||
|
|
|
||||||
|
|
@ -80,6 +80,7 @@ class Swagger2 extends Format
|
||||||
],
|
],
|
||||||
],
|
],
|
||||||
'host' => \parse_url($this->getParam('endpoint', ''), PHP_URL_HOST),
|
'host' => \parse_url($this->getParam('endpoint', ''), PHP_URL_HOST),
|
||||||
|
'x-host-docs' => \parse_url($this->getParam('endpoint.docs', ''), PHP_URL_HOST),
|
||||||
'basePath' => \parse_url($this->getParam('endpoint', ''), PHP_URL_PATH),
|
'basePath' => \parse_url($this->getParam('endpoint', ''), PHP_URL_PATH),
|
||||||
'schemes' => [\parse_url($this->getParam('endpoint', ''), PHP_URL_SCHEME)],
|
'schemes' => [\parse_url($this->getParam('endpoint', ''), PHP_URL_SCHEME)],
|
||||||
'consumes' => ['application/json', 'multipart/form-data'],
|
'consumes' => ['application/json', 'multipart/form-data'],
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue