chore(docs): Generated API Reference (#3262)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
67f9429293
commit
4fb22e8ba5
@@ -2,42 +2,64 @@ title: User
|
||||
description: Represents a User who can manage store settings.
|
||||
type: object
|
||||
required:
|
||||
- api_token
|
||||
- created_at
|
||||
- deleted_at
|
||||
- email
|
||||
- first_name
|
||||
- id
|
||||
- last_name
|
||||
- metadata
|
||||
- role
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The user's ID
|
||||
type: string
|
||||
example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
|
||||
role:
|
||||
description: The user's role
|
||||
type: string
|
||||
enum:
|
||||
- admin
|
||||
- member
|
||||
- developer
|
||||
default: member
|
||||
email:
|
||||
description: The email of the User
|
||||
type: string
|
||||
format: email
|
||||
first_name:
|
||||
description: The first name of the User
|
||||
nullable: true
|
||||
type: string
|
||||
example: Levi
|
||||
last_name:
|
||||
description: The last name of the User
|
||||
nullable: true
|
||||
type: string
|
||||
example: Bogan
|
||||
api_token:
|
||||
description: An API token associated with the user.
|
||||
nullable: true
|
||||
type: string
|
||||
example: null
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was updated.
|
||||
type: string
|
||||
format: date-time
|
||||
deleted_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was deleted.
|
||||
nullable: true
|
||||
type: string
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
|
||||
Reference in New Issue
Block a user