Resources Enums Models Unions Clients

apidoc-example-union-types 0.3.46

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

Resources

user

Operations

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

Headers

No headers

Imports

No imports

Enums

bar

Name Value Description
b b

foo

Name Value Description
a a

Interfaces

No interfaces

Models

guest_user

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
guid uuid Yes -

Internal unique identifier for this user.
email string Yes -

registered_user

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
guid uuid Yes -

Internal unique identifier for this user.
email string Yes -

preference foobar Yes -

Unions

foobar

Interfaces: None

  • Type discriminator: N/A
Type Discriminator Value Example Json Description
foo foo Minimal | Full

bar bar Minimal | Full

user

Interfaces: None

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

guest_user guest_user Minimal | Full

uuid uuid Minimal | Full

Annotations

No annotations