Skip to content

OpenAPI spec: Health endpoint uses 'healthy' field but spec documents 'health' #24

Description

@Bafbi

The OpenAPI specification incorrectly documents the health endpoint response field.

Issue Details

Spec location: luckperms-openapi.yml:2110

  • Documents field as health

Actual implementation: src/main/java/me/lucko/luckperms/extension/rest/bind/HealthSerializer.java:43-49

record Model(boolean healthy, Map<String, Object> details) {
    static Model from(Health health) {
        return new Model(
                health.isHealthy(),
                health.getDetails()
        );
    }
}

The serializer explicitly uses healthy as the field name, which is what the API actually returns.

Request

Update the OpenAPI spec to use healthy instead of health to match the implementation.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions