Skip to content

chore: Update OpenAPI Specs #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brunol95 merged 1 commit into from
Jun 11, 2026
Merged

chore: Update OpenAPI Specs #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 74 additions & 8 deletions bapi/2021-02-05.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2418,21 +2418,29 @@ paths:
You must provide the backup codes in plain format or the corresponding bcrypt digest.
public_metadata:
type: object
description: Metadata saved on the user, that is visible to both your Frontend and Backend APIs
description: |-
Metadata saved on the user, that is visible to both your Frontend and Backend APIs.
Deprecated: As of API version 2026-05-12, this field is rejected on `PATCH /v1/users/{user_id}`. Use `PATCH /v1/users/{user_id}/metadata` to merge updates into existing metadata, or `PUT /v1/users/{user_id}/metadata` to replace a metadata field entirely.
additionalProperties: true
nullable: true
deprecated: true
private_metadata:
type: object
description: Metadata saved on the user, that is only visible to your Backend API
description: |-
Metadata saved on the user, that is only visible to your Backend API.
Deprecated: As of API version 2026-05-12, this field is rejected on `PATCH /v1/users/{user_id}`. Use `PATCH /v1/users/{user_id}/metadata` to merge updates into existing metadata, or `PUT /v1/users/{user_id}/metadata` to replace a metadata field entirely.
additionalProperties: true
nullable: true
deprecated: true
unsafe_metadata:
type: object
description: |-
Metadata saved on the user, that can be updated from both the Frontend and Backend APIs.
Note: Since this data can be modified from the frontend, it is not guaranteed to be safe.
Deprecated: As of API version 2026-05-12, this field is rejected on `PATCH /v1/users/{user_id}`. Use `PATCH /v1/users/{user_id}/metadata` to merge updates into existing metadata, or `PUT /v1/users/{user_id}/metadata` to replace a metadata field entirely.
additionalProperties: true
nullable: true
deprecated: true
delete_self_enabled:
type: boolean
description: If true, the user can delete themselves with the Frontend API.
Expand Down Expand Up @@ -2776,12 +2784,12 @@ paths:
Replace a user's metadata attributes with the provided values.

Unlike `PATCH /v1/users/{user_id}/metadata` (merge semantics), this endpoint
replaces the supplied metadata columns entirely — the prior contents of each
supplied column are discarded. Columns omitted from the request body are
replaces the supplied metadata fields entirely — the prior contents of each
supplied field are discarded. Fields omitted from the request body are
left unchanged.

Prefer the `PATCH` endpoint for partial updates. Use `PUT` only when you
explicitly intend to overwrite a metadata column wholesale.
explicitly intend to overwrite a metadata field wholesale.
tags:
- Users
parameters:
Expand Down Expand Up @@ -5166,14 +5174,20 @@ paths:
properties:
public_metadata:
type: object
description: Metadata saved on the organization, that is visible to both your frontend and backend.
description: |-
Metadata saved on the organization, that is visible to both your frontend and backend.
Deprecated: As of API version 2026-05-12, this field is rejected on `PATCH /v1/organizations/{organization_id}`. Use `PATCH /v1/organizations/{organization_id}/metadata` to merge updates into existing metadata, or `PUT /v1/organizations/{organization_id}/metadata` to replace a metadata field entirely.
additionalProperties: true
nullable: true
deprecated: true
private_metadata:
type: object
description: Metadata saved on the organization that is only visible to your backend.
description: |-
Metadata saved on the organization that is only visible to your backend.
Deprecated: As of API version 2026-05-12, this field is rejected on `PATCH /v1/organizations/{organization_id}`. Use `PATCH /v1/organizations/{organization_id}/metadata` to merge updates into existing metadata, or `PUT /v1/organizations/{organization_id}/metadata` to replace a metadata field entirely.
additionalProperties: true
nullable: true
deprecated: true
name:
type: string
description: |-
Expand Down Expand Up @@ -5208,7 +5222,7 @@ paths:
'400':
$ref: '#/components/responses/ClerkErrors'
'402':
$ref: '#/components/responses/ResourceNotFound'
$ref: '#/components/responses/PaymentRequired'
'403':
$ref: '#/components/responses/AuthorizationInvalid'
'404':
Expand Down Expand Up @@ -5292,6 +5306,58 @@ paths:
$ref: '#/components/responses/ResourceNotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
put:
operationId: ReplaceOrganizationMetadata
x-speakeasy-group: organizations
x-speakeasy-name-override: replaceMetadata
summary: Replace metadata for an organization
description: |-
Replace an organization's metadata attributes with the provided values.
Unlike `PATCH /v1/organizations/{organization_id}/metadata` (merge semantics), this
endpoint replaces the supplied metadata fields entirely — the prior contents of each
supplied field are discarded. Fields omitted from the request body are left unchanged.
Prefer the `PATCH` endpoint for partial updates. Use `PUT` only when you explicitly
intend to overwrite a metadata field wholesale.
tags:
- Organizations
parameters:
- name: organization_id
in: path
description: The ID of the organization whose metadata will be replaced
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
public_metadata:
type: object
description: |-
Metadata saved on the organization, that is visible to both your frontend and backend.
The existing value will be replaced entirely with the new object.
additionalProperties: true
private_metadata:
type: object
description: |-
Metadata saved on the organization that is only visible to your backend.
The existing value will be replaced entirely with the new object.
additionalProperties: true
responses:
'200':
$ref: '#/components/responses/Organization'
'400':
$ref: '#/components/responses/ClerkErrors'
'401':
$ref: '#/components/responses/AuthenticationInvalid'
'404':
$ref: '#/components/responses/ResourceNotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
/organizations/{organization_id}/logo:
put:
operationId: UploadOrganizationLogo
Expand Down
82 changes: 74 additions & 8 deletions bapi/2024-10-01.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2418,21 +2418,29 @@ paths:
You must provide the backup codes in plain format or the corresponding bcrypt digest.
public_metadata:
type: object
description: Metadata saved on the user, that is visible to both your Frontend and Backend APIs
description: |-
Metadata saved on the user, that is visible to both your Frontend and Backend APIs.
Deprecated: As of API version 2026-05-12, this field is rejected on `PATCH /v1/users/{user_id}`. Use `PATCH /v1/users/{user_id}/metadata` to merge updates into existing metadata, or `PUT /v1/users/{user_id}/metadata` to replace a metadata field entirely.
additionalProperties: true
nullable: true
deprecated: true
private_metadata:
type: object
description: Metadata saved on the user, that is only visible to your Backend API
description: |-
Metadata saved on the user, that is only visible to your Backend API.
Deprecated: As of API version 2026-05-12, this field is rejected on `PATCH /v1/users/{user_id}`. Use `PATCH /v1/users/{user_id}/metadata` to merge updates into existing metadata, or `PUT /v1/users/{user_id}/metadata` to replace a metadata field entirely.
additionalProperties: true
nullable: true
deprecated: true
unsafe_metadata:
type: object
description: |-
Metadata saved on the user, that can be updated from both the Frontend and Backend APIs.
Note: Since this data can be modified from the frontend, it is not guaranteed to be safe.
Deprecated: As of API version 2026-05-12, this field is rejected on `PATCH /v1/users/{user_id}`. Use `PATCH /v1/users/{user_id}/metadata` to merge updates into existing metadata, or `PUT /v1/users/{user_id}/metadata` to replace a metadata field entirely.
additionalProperties: true
nullable: true
deprecated: true
delete_self_enabled:
type: boolean
description: If true, the user can delete themselves with the Frontend API.
Expand Down Expand Up @@ -2776,12 +2784,12 @@ paths:
Replace a user's metadata attributes with the provided values.

Unlike `PATCH /v1/users/{user_id}/metadata` (merge semantics), this endpoint
replaces the supplied metadata columns entirely — the prior contents of each
supplied column are discarded. Columns omitted from the request body are
replaces the supplied metadata fields entirely — the prior contents of each
supplied field are discarded. Fields omitted from the request body are
left unchanged.

Prefer the `PATCH` endpoint for partial updates. Use `PUT` only when you
explicitly intend to overwrite a metadata column wholesale.
explicitly intend to overwrite a metadata field wholesale.
tags:
- Users
parameters:
Expand Down Expand Up @@ -5166,14 +5174,20 @@ paths:
properties:
public_metadata:
type: object
description: Metadata saved on the organization, that is visible to both your frontend and backend.
description: |-
Metadata saved on the organization, that is visible to both your frontend and backend.
Deprecated: As of API version 2026-05-12, this field is rejected on `PATCH /v1/organizations/{organization_id}`. Use `PATCH /v1/organizations/{organization_id}/metadata` to merge updates into existing metadata, or `PUT /v1/organizations/{organization_id}/metadata` to replace a metadata field entirely.
additionalProperties: true
nullable: true
deprecated: true
private_metadata:
type: object
description: Metadata saved on the organization that is only visible to your backend.
description: |-
Metadata saved on the organization that is only visible to your backend.
Deprecated: As of API version 2026-05-12, this field is rejected on `PATCH /v1/organizations/{organization_id}`. Use `PATCH /v1/organizations/{organization_id}/metadata` to merge updates into existing metadata, or `PUT /v1/organizations/{organization_id}/metadata` to replace a metadata field entirely.
additionalProperties: true
nullable: true
deprecated: true
name:
type: string
description: |-
Expand Down Expand Up @@ -5208,7 +5222,7 @@ paths:
'400':
$ref: '#/components/responses/ClerkErrors'
'402':
$ref: '#/components/responses/ResourceNotFound'
$ref: '#/components/responses/PaymentRequired'
'403':
$ref: '#/components/responses/AuthorizationInvalid'
'404':
Expand Down Expand Up @@ -5292,6 +5306,58 @@ paths:
$ref: '#/components/responses/ResourceNotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
put:
operationId: ReplaceOrganizationMetadata
x-speakeasy-group: organizations
x-speakeasy-name-override: replaceMetadata
summary: Replace metadata for an organization
description: |-
Replace an organization's metadata attributes with the provided values.
Unlike `PATCH /v1/organizations/{organization_id}/metadata` (merge semantics), this
endpoint replaces the supplied metadata fields entirely — the prior contents of each
supplied field are discarded. Fields omitted from the request body are left unchanged.
Prefer the `PATCH` endpoint for partial updates. Use `PUT` only when you explicitly
intend to overwrite a metadata field wholesale.
tags:
- Organizations
parameters:
- name: organization_id
in: path
description: The ID of the organization whose metadata will be replaced
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
public_metadata:
type: object
description: |-
Metadata saved on the organization, that is visible to both your frontend and backend.
The existing value will be replaced entirely with the new object.
additionalProperties: true
private_metadata:
type: object
description: |-
Metadata saved on the organization that is only visible to your backend.
The existing value will be replaced entirely with the new object.
additionalProperties: true
responses:
'200':
$ref: '#/components/responses/Organization'
'400':
$ref: '#/components/responses/ClerkErrors'
'401':
$ref: '#/components/responses/AuthenticationInvalid'
'404':
$ref: '#/components/responses/ResourceNotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
/organizations/{organization_id}/logo:
put:
operationId: UploadOrganizationLogo
Expand Down
Loading
Loading