new API structure #159
Open
new API structure #159
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sujaya-sys
reviewed
Feb 2, 2026
Contributor
sujaya-sys
left a comment
sujaya-sys
left a comment
There was a problem hiding this comment.
@guolau I don't really have context on this change so mainly looked for wording inconsistencies. Hope that helps - feel free to disregard anything that doesn't make sense :)
| @@ -1,3 +1,4 @@ | |||
| --- | |||
| openapi: get /v1/accounts/{accountId} | |||
| title: Get specific account details | |||
Contributor
There was a problem hiding this comment.
Suggested change
| title: Get specific account details | |
| title: Get details for a specific account |
| @@ -1,3 +1,4 @@ | |||
| --- | |||
| openapi: get /v1/accounts/me | |||
| title: Get current account details | |||
Contributor
There was a problem hiding this comment.
Suggested change
| title: Get current account details | |
| title: Get details for the current account |
| @@ -1,3 +1,4 @@ | |||
| --- | |||
| openapi: get /v1/accounts | |||
| title: Get all account details | |||
Contributor
There was a problem hiding this comment.
Suggested change
| title: Get all account details | |
| title: Get details for all accounts |
| @@ -1,3 +1,4 @@ | |||
| --- | |||
| openapi: post /v1/client-certificates | |||
| title: Create new client certificate | |||
Contributor
There was a problem hiding this comment.
Suggested change
| title: Create new client certificate | |
| title: Create a client certificate |
| @@ -1,3 +1,4 @@ | |||
| --- | |||
| openapi: get /v1/analytics/api-checks/{id} | |||
| title: Get API Check analytics | |||
Contributor
There was a problem hiding this comment.
Suggested change
| title: Get API Check analytics | |
| title: Get API check analytics |
| @@ -1,3 +1,4 @@ | |||
| --- | |||
| openapi: get /v1/checks/heartbeats/{checkId}/events/{id} | |||
| title: List a specific heartbeat event | |||
Contributor
There was a problem hiding this comment.
Suggested change
| title: List a specific heartbeat event | |
| title: List a specific event for a heartbeat monitor |
| @@ -1,3 +1,4 @@ | |||
| --- | |||
| openapi: get /v1/checks/heartbeats/{checkId}/availability | |||
| title: Get heartbeat availability | |||
Contributor
There was a problem hiding this comment.
Suggested change
| title: Get heartbeat availability | |
| title: Get heartbeat monitor availability |
| @@ -1,3 +1,4 @@ | |||
| --- | |||
| openapi: put /v1/checks/heartbeat/{id} | |||
| title: Update a heartbeat check | |||
Contributor
There was a problem hiding this comment.
Suggested change
| title: Update a heartbeat check | |
| title: Update a heartbeat monitor |
| @@ -1,3 +1,4 @@ | |||
| --- | |||
| openapi: delete /v1/client-certificates/{id} | |||
| title: Delete existing client certificate | |||
Contributor
There was a problem hiding this comment.
Suggested change
| title: Delete existing client certificate | |
| title: Delete a client certificate |
|
|
||
| #### Broken Navigation Links (in docs.json but no MDX file) | ||
|
|
||
| | Missing File | |
Contributor
There was a problem hiding this comment.
I'm missing context on the purpose of this doc, but why are we documenting issues, missing files, open questions, inconsistencies etc here?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Affected Components
Notes for the Reviewer
New Dependency Submission
Screenshots