Skip to content

Add /ping endpoint#14

Merged
wjdp merged 1 commit intomainfrom
ping-endpoint
Oct 24, 2025
Merged

Add /ping endpoint#14
wjdp merged 1 commit intomainfrom
ping-endpoint

Conversation

@wjdp
Copy link
Collaborator

@wjdp wjdp commented Oct 23, 2025

No description provided.

@wjdp wjdp requested a review from Copilot October 23, 2025 18:01
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a /ping endpoint to the API for testing API key authentication and basic connectivity. The endpoint serves as a simple health check that requires authentication but performs no other operations.

Key changes:

  • Added a new /ping endpoint to the OpenAPI specification that returns a "pong" message
  • Updated API key documentation to include instructions for testing API keys using the new endpoint
  • Added the "utility" tag group to organize health check and similar endpoints

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
reference/2024-02-05/openapi.json Defines the new /ping endpoint under a "utility" tag, with a 200 response returning {"message": "pong"}
getting-started/api-key.mdx Adds a "Testing your API key" section with curl example using the /ping endpoint and troubleshooting tips
docs.json Adds the "Utility" group to the documentation navigation, referencing the ping endpoint page

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@hleimig
Copy link

hleimig commented Oct 24, 2025

Looks good to me

@dw-runa
Copy link

dw-runa commented Oct 24, 2025

LGTM

@wjdp wjdp merged commit 3c39baa into main Oct 24, 2025
4 checks passed
@wjdp wjdp deleted the ping-endpoint branch October 24, 2025 10:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants