Elgato_dark/appwrite
1
0
Fork 0
mirror of https://github.com/appwrite/appwrite synced 2026-05-22 00:18:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Merge pull request #9685 from appwrite/chore-docs-endpoint

Browse source 
core: introduce endpoint.docs in specs
This commit is contained in:
Christy Jacob 2025-04-24 18:14:01 +04:00 committed by GitHub
commit 8cb4d2894b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 36 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
app/config/specs/open-api3-1.6.x-client.json
View file

@ -16,6 +16,9 @@
}
},
"servers": [
{
"url": "https:\/\/cloud.appwrite.io\/v1"
},
{
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
}

3
app/config/specs/open-api3-1.6.x-console.json
View file

@ -16,6 +16,9 @@
}
},
"servers": [
{
"url": "https:\/\/cloud.appwrite.io\/v1"
},
{
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
}

3
app/config/specs/open-api3-1.6.x-server.json
View file

@ -16,6 +16,9 @@
}
},
"servers": [
{
"url": "https:\/\/cloud.appwrite.io\/v1"
},
{
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
}

3
app/config/specs/open-api3-latest-client.json
View file

@ -16,6 +16,9 @@
}
},
"servers": [
{
"url": "https:\/\/cloud.appwrite.io\/v1"
},
{
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
}

3
app/config/specs/open-api3-latest-console.json
View file

@ -16,6 +16,9 @@
}
},
"servers": [
{
"url": "https:\/\/cloud.appwrite.io\/v1"
},
{
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
}

3
app/config/specs/open-api3-latest-server.json
View file

@ -16,6 +16,9 @@
}
},
"servers": [
{
"url": "https:\/\/cloud.appwrite.io\/v1"
},
{
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
}

3
app/config/specs/swagger2-1.6.x-client.json
View file

@ -15,7 +15,8 @@
"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",
"schemes": [
"https"

3
app/config/specs/swagger2-1.6.x-console.json
View file

@ -15,7 +15,8 @@
"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",
"schemes": [
"https"

3
app/config/specs/swagger2-1.6.x-server.json
View file

@ -15,7 +15,8 @@
"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",
"schemes": [
"https"

3
app/config/specs/swagger2-latest-client.json
View file

@ -15,7 +15,8 @@
"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",
"schemes": [
"https"

3
app/config/specs/swagger2-latest-console.json
View file

@ -15,7 +15,8 @@
"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",
"schemes": [
"https"

3
app/config/specs/swagger2-latest-server.json
View file

@ -15,7 +15,8 @@
"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",
"schemes": [
"https"

3
src/Appwrite/Platform/Tasks/Specs.php
View file

@ -289,7 +289,8 @@ class Specs extends Action
$formatInstance
->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('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('terms', $endpoint . '/policy/terms')
->setParam('support.email', $email)

3
src/Appwrite/Specification/Format/OpenAPI3.php
View file

@ -84,6 +84,9 @@ class OpenAPI3 extends Format
[
'url' => $this->getParam('endpoint', ''),
],
[
'url' => $this->getParam('endpoint.docs', ''),
],
],
'paths' => [],
'tags' => $this->services,

1
src/Appwrite/Specification/Format/Swagger2.php
View file

@ -80,6 +80,7 @@ class Swagger2 extends Format
],
],
'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),
'schemes' => [\parse_url($this->getParam('endpoint', ''), PHP_URL_SCHEME)],
'consumes' => ['application/json', 'multipart/form-data'],