Merge pull request #403 from jsdelivr/docs

feat: add docs links to error responses
jsdelivr · Jul 27, 2023 · 7526181 · 7526181
2 parents ec21d54 + 7c9130c
commit 7526181
Show file tree

Hide file tree

Showing 24 changed files with 109 additions and 2,228 deletions.
diff --git a/README.md b/README.md
@@ -108,7 +108,7 @@ POST https://api.globalping.io/v1/measurements
 }
 ```
 
-[Read the full API documentation](docs) and [explore our dev demo](https://api.globalping.io/demo/)
+[Read the full API documentation](https://www.jsdelivr.com/docs/api.globalping.io) and [explore our dev demo](https://api.globalping.io/demo/)
 
 
 ### Slack App

diff --git a/config/default.cjs b/config/default.cjs
@@ -1,6 +1,7 @@
 module.exports = {
 	server: {
 		host: 'https://api.globalping.io',
+		docsHost: 'https://www.jsdelivr.com',
 		port: 3000,
 		processes: 2,
 	},

diff --git a/docs/CLIENT_GUIDELINES.md b/docs/CLIENT_GUIDELINES.md
diff --git a/docs/README.md b/docs/README.md
@@ -1,27 +1,4 @@
 # Globalping API
 
-**API domain**: `api.globalping.io`
-
-**API prefix**: `/v1`
-
-If you are implementing an application interacting with the API, please also see the
-[client guidelines](CLIENT_GUIDELINES.md).
-
-## Open Endpoints
-
-Open endpoints require no Authentication.
-
-### probe
-
-- [show probe list](probes/get.md): `GET /v1/probes`
-
-### measurement
-
-- [post measurement](measurement/post-create.md): `POST /v1/measurements`
-- [get measurement](measurement/get.md): `GET /v1/measurements/:id`
-
-### schemas
-
-- [Location filters](measurement/schema/location.md)
-- [Measurement Request](measurement/schema/request.md)
-- [Measurement Response](measurement/schema/response.md)
+The documentation has moved to https://www.jsdelivr.com/docs/api.globalping.io.
+To edit it, see the [OpenAPI document](../public/v1/spec.yaml).
diff --git a/docs/measurement/get.md b/docs/measurement/get.md
diff --git a/docs/measurement/post-create.md b/docs/measurement/post-create.md