Skip to content

Define "primary key" for objects #587

Open
@ralfhandl

Description

@ralfhandl

OData APIs are based on an entity-relationship model, so the top-level resources are collections of identically structured objects, and there's a subset of properties whose values uniquely identify an object (think: records in a database table).

A similar issue has been addressed in the JSON Schema discussion group, see https://groups.google.com/d/msg/json-schema/CYd8xk1Czyg/XLNxEzDOPj4J

We currently solve this with an extension keyword "x-keys" whose value is an array of strings listing the names of the "primary key" properties.

Anyone else seeing a need for this and wanting to have it in OpenAPI.Next?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions