Skip to content

title: "API schema" description: "The Minyu API exposes a GraphQL schema generated directly from the configured data model." Tables, columns, and relations are mapped to types and fields using...


API schema

The Minyu API exposes a GraphQL schema generated directly from the configured data model. Tables, columns, and relations are mapped to types and fields using their configured API names.

Schema changes are reflected immediately after configuration updates.

Schema model

The API schema is derived from:

  • Table API names
  • Column API names
  • Relation API names

The schema represents the current active configuration. There is no separate API schema definition independent of the data model.

Types

Each table is exposed as a GraphQL type.

For a table with API name <entity>:

  • <entities> exposes a collection query
  • <entity> exposes a single-row query

Mutation names are derived from the same API name:

  • add_<entity>
  • edit_<entity>
  • delete_<entity>

Type and field availability reflect the current schema configuration.

Relations

Relations are exposed as fields on types.

Relation fields:

  • Use the configured relation API name
  • Reflect the relation’s cardinality
  • Allow traversal in queries and nested input in mutations

Relation exposure follows the schema definition and does not introduce additional edge objects.

System fields

System-managed fields are exposed consistently across types.

Common system fields include:

  • id — internal row identifier
  • _id — external identifier, if configured

System fields are available for querying, filtering, and mutation targeting where applicable.