chore: Update OpenAPI Specs

clerk · Feb 5, 2025 · 0872238 · 0872238
1 parent f7bae1e
commit 0872238
Show file tree

Hide file tree

Showing 5 changed files with 116 additions and 18 deletions.
diff --git a/bapi/2021-02-05.yml b/bapi/2021-02-05.yml
@@ -1169,7 +1169,6 @@ paths:
             The query value doesn't need to match the exact value you are looking for, it is capable of partial matches as well.
           schema:
             type: string
-            minLength: 3
           required: false
         - name: email_address_query
           in: query
@@ -1178,7 +1177,6 @@ paths:
             For example, `email_address_query=ello` will match a user with the email `[email protected]`.
           schema:
             type: string
-            minLength: 3
           required: false
         - name: phone_number_query
           in: query
@@ -1187,7 +1185,6 @@ paths:
             For example, `phone_number_query=555` will match a user with the phone number `+1555xxxxxxx`.
           schema:
             type: string
-            minLength: 3
           required: false
         - name: username_query
           in: query
@@ -1196,13 +1193,11 @@ paths:
             For example, `username_query=CoolUser` will match a user with the username `SomeCoolUser`.
           schema:
             type: string
-            minLength: 3
         - name: name_query
           in: query
           description: Returns users with names that match the given query, via case-insensitive partial match.
           schema:
             type: string
-            minLength: 3
         - name: banned
           in: query
           required: false
@@ -1516,7 +1511,6 @@ paths:
             The query value doesn't need to match the exact value you are looking for, it is capable of partial matches as well.
           schema:
             type: string
-            minLength: 3
           required: false
         - name: email_address_query
           in: query
@@ -1526,7 +1520,6 @@ paths:
             and will be included in the resulting count.
           schema:
             type: string
-            minLength: 3
           required: false
         - name: phone_number_query
           in: query
@@ -1536,7 +1529,6 @@ paths:
             and will be included in the resulting count.
           schema:
             type: string
-            minLength: 3
           required: false
         - name: username_query
           in: query
@@ -1546,7 +1538,6 @@ paths:
             and will be included in the resulting count.
           schema:
             type: string
-            minLength: 3
         - name: banned
           in: query
           required: false
@@ -3449,6 +3440,22 @@ paths:
             Uses exact match for organization ID and partial match for name and slug.
           schema:
             type: string
+        - in: query
+          name: organization_id
+          description: |-
+            Returns organizations with the organization ids specified.
+            Any organization ids not found are ignored.
+            For each organization id, the `+` and `-` can be
+            prepended to the id, which denote whether the
+            respective organization should be included or
+            excluded from the result set.
+            Accepts up to 100 organization ids.
+            Example: ?organization_id=+org_1&organization_id=-org_2
+          schema:
+            type: array
+            items:
+              type: string
+          required: false
         - in: query
           name: order_by
           description: |-

diff --git a/bapi/2024-10-01.yml b/bapi/2024-10-01.yml
@@ -1169,7 +1169,6 @@ paths:
             The query value doesn't need to match the exact value you are looking for, it is capable of partial matches as well.
           schema:
             type: string
-            minLength: 3
           required: false
         - name: email_address_query
           in: query
@@ -1178,7 +1177,6 @@ paths:
             For example, `email_address_query=ello` will match a user with the email `[email protected]`.
           schema:
             type: string
-            minLength: 3
           required: false
         - name: phone_number_query
           in: query
@@ -1187,7 +1185,6 @@ paths:
             For example, `phone_number_query=555` will match a user with the phone number `+1555xxxxxxx`.
           schema:
             type: string
-            minLength: 3
           required: false
         - name: username_query
           in: query
@@ -1196,13 +1193,11 @@ paths:
             For example, `username_query=CoolUser` will match a user with the username `SomeCoolUser`.
           schema:
             type: string
-            minLength: 3
         - name: name_query
           in: query
           description: Returns users with names that match the given query, via case-insensitive partial match.
           schema:
             type: string
-            minLength: 3
         - name: banned
           in: query
           required: false
@@ -1516,7 +1511,6 @@ paths:
             The query value doesn't need to match the exact value you are looking for, it is capable of partial matches as well.
           schema:
             type: string
-            minLength: 3
           required: false
         - name: email_address_query
           in: query
@@ -1526,7 +1520,6 @@ paths:
             and will be included in the resulting count.
           schema:
             type: string
-            minLength: 3
           required: false
         - name: phone_number_query
           in: query
@@ -1536,7 +1529,6 @@ paths:
             and will be included in the resulting count.
           schema:
             type: string
-            minLength: 3
           required: false
         - name: username_query
           in: query
@@ -1546,7 +1538,6 @@ paths:
             and will be included in the resulting count.
           schema:
             type: string
-            minLength: 3
         - name: banned
           in: query
           required: false
@@ -3449,6 +3440,22 @@ paths:
             Uses exact match for organization ID and partial match for name and slug.
           schema:
             type: string
+        - in: query
+          name: organization_id
+          description: |-
+            Returns organizations with the organization ids specified.
+            Any organization ids not found are ignored.
+            For each organization id, the `+` and `-` can be
+            prepended to the id, which denote whether the
+            respective organization should be included or
+            excluded from the result set.
+            Accepts up to 100 organization ids.
+            Example: ?organization_id=+org_1&organization_id=-org_2
+          schema:
+            type: array
+            items:
+              type: string
+          required: false
         - in: query
           name: order_by
           description: |-

diff --git a/fapi/2021-02-05.yml b/fapi/2021-02-05.yml
@@ -4522,6 +4522,28 @@ components:
           type: string
         logo_link_url:
           type: string
+        customization:
+          type: object
+          properties:
+            appearance:
+              type: string
+              enum:
+                - auto
+                - dark
+                - light
+              nullable: true
+            background_color_dark:
+              type: string
+              nullable: true
+            background_color_light:
+              type: string
+              nullable: true
+            primary_color_dark:
+              type: string
+              nullable: true
+            primary_color_light:
+              type: string
+              nullable: true
       required:
         - object
         - enabled
@@ -4531,6 +4553,7 @@ components:
         - after_create_organization_url
         - after_leave_organization_url
         - logo_link_url
+        - customization
     Client.AuthConfig:
       type: object
       additionalProperties: false
@@ -5255,6 +5278,11 @@ components:
       type: object
       additionalProperties: false
       properties:
+        object:
+          type: string
+          description: String representing the object's type. Objects of the same type share the same value.
+          enum:
+            - fraud_settings
         native:
           $ref: '#/components/schemas/FraudSettings.NativeSettings'
       required:

diff --git a/fapi/2024-10-01.yml b/fapi/2024-10-01.yml
@@ -4522,6 +4522,28 @@ components:
           type: string
         logo_link_url:
           type: string
+        customization:
+          type: object
+          properties:
+            appearance:
+              type: string
+              enum:
+                - auto
+                - dark
+                - light
+              nullable: true
+            background_color_dark:
+              type: string
+              nullable: true
+            background_color_light:
+              type: string
+              nullable: true
+            primary_color_dark:
+              type: string
+              nullable: true
+            primary_color_light:
+              type: string
+              nullable: true
       required:
         - object
         - enabled
@@ -4531,6 +4553,7 @@ components:
         - after_create_organization_url
         - after_leave_organization_url
         - logo_link_url
+        - customization
     Client.AuthConfig:
       type: object
       additionalProperties: false
@@ -5255,6 +5278,11 @@ components:
       type: object
       additionalProperties: false
       properties:
+        object:
+          type: string
+          description: String representing the object's type. Objects of the same type share the same value.
+          enum:
+            - fraud_settings
         native:
           $ref: '#/components/schemas/FraudSettings.NativeSettings'
       required:

diff --git a/fapi/2025-01-15.yml b/fapi/2025-01-15.yml
@@ -4522,6 +4522,28 @@ components:
           type: string
         logo_link_url:
           type: string
+        customization:
+          type: object
+          properties:
+            appearance:
+              type: string
+              enum:
+                - auto
+                - dark
+                - light
+              nullable: true
+            background_color_dark:
+              type: string
+              nullable: true
+            background_color_light:
+              type: string
+              nullable: true
+            primary_color_dark:
+              type: string
+              nullable: true
+            primary_color_light:
+              type: string
+              nullable: true
       required:
         - object
         - enabled
@@ -4531,6 +4553,7 @@ components:
         - after_create_organization_url
         - after_leave_organization_url
         - logo_link_url
+        - customization
     Client.AuthConfig:
       type: object
       additionalProperties: false
@@ -5255,6 +5278,11 @@ components:
       type: object
       additionalProperties: false
       properties:
+        object:
+          type: string
+          description: String representing the object's type. Objects of the same type share the same value.
+          enum:
+            - fraud_settings
         native:
           $ref: '#/components/schemas/FraudSettings.NativeSettings'
       required: