Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add docs links to error responses #403

Merged
merged 3 commits into from
Jul 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions config/default.cjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
module.exports = {
server: {
host: 'https://api.globalping.io',
docsHost: 'https://www.jsdelivr.com',
port: 3000,
processes: 2,
},
Expand Down
13 changes: 0 additions & 13 deletions docs/CLIENT_GUIDELINES.md

This file was deleted.

27 changes: 2 additions & 25 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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).
124 changes: 0 additions & 124 deletions docs/measurement/get.md

This file was deleted.

162 changes: 0 additions & 162 deletions docs/measurement/post-create.md

This file was deleted.

Loading