Skip to content

[BUG] OpenApi spec does not match returned dataΒ #2678

@dealloc

Description

@dealloc

Describe the bug
When calling the /v1/tenants/{{tenant_id}}/schemas/read endpoint the OpenApi specification defines an entityDefinitions property under schema, however the returned JSON contains entity_definitions

This breaks tools that auto-generate client code from the spec (like Kiota).

To Reproduce

  • launch Permify (podman run -p 3476:3476 -p 3478:3478 ghcr.io/permify/permify)
  • write schema (see below)
  • read schema

schema

entity user {}

entity organization {
    relation admin @user
    relation member @user
    relation owner @user

    action manage = admin
    action view = admin or member
}

entity document {
    relation parent @organization
    relation owner @user

    action view = owner or parent.admin
    action delete = owner or parent.admin

    permission edit = parent.admin or owner
}

Here is a sample of my code and/or tests that demonstrate the issue in my app:
Image

Image

Example Application
https://github.com/dealloc/permify-client/blob/934149382aa936d00fafcc631db4e9ffad194f31/src/Permify.Client.Http/Generated/Models/SchemaDefinition_entityDefinitions.cs#L11

Expected behavior
Either the endpoint returns entityDefinitions or the OpenApi spec is updated to return entity_definitions (which is what the API currently returns)

Additional context
This problem only seems to occur on the HTTP API, my gRPC implementation seems to work without problems

Environment (please complete the following information, because it helps us investigate better):

  • OS: OSX 26.1 (running Podman 5.7.0)
  • Version Permify v1.5.3

Metadata

Metadata

Labels

bugSometing isn't working

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions