registry/internal/api/handlers/v0/ping.go
Radoslav Dimitrov 087d8085b7
Replace / with - for operation IDs (#660)
<!-- Provide a brief summary of your changes -->

## Motivation and Context
<!-- Why is this change needed? What problem does it solve? -->
Follow up from #658 addressing the feedback from @tadasant 

## How Has This Been Tested?
<!-- Have you tested this in a real application? Which scenarios were
tested? -->

## Breaking Changes
<!-- Will users need to update their code or configurations? -->

## Types of changes
<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Documentation update

## Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply. -->
- [ ] I have read the [MCP
Documentation](https://modelcontextprotocol.io)
- [ ] My code follows the repository's style guidelines
- [ ] New and existing tests pass locally
- [ ] I have added appropriate error handling
- [ ] I have added or updated documentation as needed

## Additional context
<!-- Add any other context, implementation notes, or design decisions
-->

Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
2025-10-14 15:26:43 +03:00

32 lines
789 B
Go

package v0
import (
"context"
"net/http"
"strings"
"github.com/danielgtaylor/huma/v2"
)
// PingBody represents the ping response body
type PingBody struct {
Pong bool `json:"pong" example:"true" doc:"Ping response"`
}
// RegisterPingEndpoint registers the ping endpoint with a custom path prefix
func RegisterPingEndpoint(api huma.API, pathPrefix string) {
huma.Register(api, huma.Operation{
OperationID: "ping" + strings.ReplaceAll(pathPrefix, "/", "-"),
Method: http.MethodGet,
Path: pathPrefix + "/ping",
Summary: "Ping",
Description: "Simple ping endpoint",
Tags: []string{"ping"},
}, func(_ context.Context, _ *struct{}) (*Response[PingBody], error) {
return &Response[PingBody]{
Body: PingBody{
Pong: true,
},
}, nil
})
}