Resources Enums Models Unions Clients

apidoc-example-union-types-discriminator 0.3.46

History | Watch
  • Contact: N/A
  • License: N/A

Resources

user

Operations

Method and Path Description
GET /users
GET /users/:id
POST /users

Headers

No headers

Imports

No imports

Enums

system_user

Name Value Description
system system

anonymous anonymous

Models

guest_user

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

Internal unique identifier for this user.
email string No -

registered_user

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

email string Yes -

Unions

user

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
registered_user registered_user Minimal | Full

guest_user guest_user Minimal | Full

system_user system_user Minimal | Full

string string Minimal | Full

Annotations

No annotations