From 487e3cb1dc10aa94e66affc518f5d19194ab07bc Mon Sep 17 00:00:00 2001 From: Mitchell Date: Wed, 13 Mar 2024 10:51:39 -0500 Subject: [PATCH] periodic docs update --- openapi-v2.yaml | 279 +++++++++++++----------------------------------- openapi-v3.yaml | 25 +++-- 2 files changed, 92 insertions(+), 212 deletions(-) diff --git a/openapi-v2.yaml b/openapi-v2.yaml index b46bc1a..cc55662 100644 --- a/openapi-v2.yaml +++ b/openapi-v2.yaml @@ -152,170 +152,6 @@ paths: items: $ref: '#/components/schemas/BaseConnectionEnveloped' description: '' - post: - operationId: Create Connection - description: Deprecated. Consider using the v3 API instead. - parameters: - - in: path - name: account_id - schema: - type: integer - required: true - tags: - - Connections - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BaseConnectionRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/BaseConnectionRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/BaseConnectionRequest' - required: true - security: - - BearerAuthentication: [] - deprecated: true - responses: - '200': - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/BaseConnectionEnveloped' - description: '' - /api/v2/accounts/{account_id}/connections/{id}/: - get: - operationId: Retrieve Connection - description: Deprecated. Consider using the v3 API instead. - parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: query - name: limit - schema: - type: integer - - in: query - name: offset - schema: - type: integer - - in: query - name: project_id - schema: - type: integer - - in: query - name: state - schema: - type: integer - tags: - - Connections - security: - - BearerAuthentication: [] - deprecated: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/BaseConnectionEnveloped' - description: '' - post: - operationId: Update Connection - description: Deprecated. Consider using the v3 API instead. - parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - tags: - - Connections - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BaseConnectionRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/BaseConnectionRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/BaseConnectionRequest' - required: true - security: - - BearerAuthentication: [] - deprecated: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/BaseConnectionEnveloped' - description: '' - delete: - operationId: Destroy Connection - description: Deprecated. Consider using the v3 API instead. - parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: query - name: limit - schema: - type: integer - - in: query - name: offset - schema: - type: integer - - in: query - name: project_id - schema: - type: integer - - in: query - name: state - schema: - type: integer - tags: - - Connections - security: - - BearerAuthentication: [] - deprecated: true - responses: - '204': - description: No response body /api/v2/accounts/{account_id}/encryptions/: get: operationId: List SSH Tunnels @@ -1246,7 +1082,6 @@ paths: name: account_id schema: type: integer - required: true - in: query name: external_email schema: @@ -1259,6 +1094,10 @@ paths: name: offset schema: type: integer + - in: query + name: pk + schema: + type: integer - in: query name: slack_channel_id schema: @@ -1267,6 +1106,14 @@ paths: name: state schema: type: integer + - in: query + name: type + schema: + type: integer + - in: query + name: user_id + schema: + type: integer tags: - Notifications security: @@ -1330,7 +1177,6 @@ paths: name: account_id schema: type: integer - required: true - in: query name: external_email schema: @@ -1348,6 +1194,10 @@ paths: name: offset schema: type: integer + - in: query + name: pk + schema: + type: integer - in: query name: slack_channel_id schema: @@ -1356,6 +1206,14 @@ paths: name: state schema: type: integer + - in: query + name: type + schema: + type: integer + - in: query + name: user_id + schema: + type: integer tags: - Notifications security: @@ -1416,7 +1274,6 @@ paths: name: account_id schema: type: integer - required: true - in: query name: external_email schema: @@ -1434,6 +1291,10 @@ paths: name: offset schema: type: integer + - in: query + name: pk + schema: + type: integer - in: query name: slack_channel_id schema: @@ -1442,6 +1303,14 @@ paths: name: state schema: type: integer + - in: query + name: type + schema: + type: integer + - in: query + name: user_id + schema: + type: integer tags: - Notifications security: @@ -2333,7 +2202,6 @@ paths: name: account_id schema: type: integer - required: true - in: path name: id schema: @@ -2347,6 +2215,10 @@ paths: name: offset schema: type: integer + - in: query + name: pk + schema: + type: integer - in: query name: state schema: @@ -2816,43 +2688,6 @@ components: required: - data - status - BaseConnectionRequest: - type: object - required: - - id - - account_id - - name - - type - - state - properties: - id: - oneOf: - - type: 'null' - - type: integer - account_id: - type: integer - dbt_project_id: - type: integer - created_by_id: - oneOf: - - type: 'null' - - type: integer - created_by_service_token_id: - oneOf: - - type: 'null' - - type: integer - name: - allOf: - - type: string - - minLength: 1 - maxLength: 255 - type: - type: string - state: - type: integer - additionalProperties: false - definitions: {} - $schema: http://json-schema.org/draft-07/schema# BaseConnectionV3: type: object properties: @@ -2969,11 +2804,13 @@ components: - every_day - days_of_week - custom_cron + - interval_cron type: string description: |- * `every_day` - every_day * `days_of_week` - days_of_week * `custom_cron` - custom_cron + * `interval_cron` - interval_cron Defaults: type: object properties: @@ -3257,6 +3094,7 @@ components: - state - generate_docs - run_generate_sources + - run_audit_helper properties: id: oneOf: @@ -3332,6 +3170,10 @@ components: type: boolean run_generate_sources: type: boolean + run_audit_helper: + oneOf: + - type: 'null' + - type: boolean environment: {} account: oneOf: @@ -3413,6 +3255,7 @@ components: - state - generate_docs - run_generate_sources + - run_audit_helper properties: id: oneOf: @@ -3488,6 +3331,10 @@ components: type: boolean run_generate_sources: type: boolean + run_audit_helper: + oneOf: + - type: 'null' + - type: boolean environment: {} account: oneOf: @@ -3567,6 +3414,7 @@ components: - state - generate_docs - run_generate_sources + - run_audit_helper properties: id: oneOf: @@ -3634,6 +3482,10 @@ components: type: boolean run_generate_sources: type: boolean + run_audit_helper: + oneOf: + - type: 'null' + - type: boolean environment: {} account: oneOf: @@ -3842,6 +3694,9 @@ components: triggers_on_draft_pr: type: boolean default: false + run_audit_helper: + type: boolean + default: false required: - account_id - deactivated @@ -3861,6 +3716,7 @@ components: - on_cancel - on_failure - on_success + - user_id properties: id: oneOf: @@ -3947,6 +3803,7 @@ components: - on_cancel - on_failure - on_success + - user_id properties: id: oneOf: @@ -4836,6 +4693,8 @@ components: dbt_version_override: type: string minLength: 1 + description: 'Allowed values are: 1.0.0, 1.1.0-latest, 1.2.0-latest, 1.3.0-latest, + 1.4.0-latest, 1.5.0-latest, 1.6.0-latest, 1.7.0-latest' threads_override: type: integer target_name_override: @@ -5011,6 +4870,11 @@ components: permissions: {} licenses: {} user_feature_flags: {} + apitoken_last_used: + oneOf: + - type: 'null' + - type: string + format: date-time additionalProperties: false definitions: {} $schema: http://json-schema.org/draft-07/schema# @@ -5167,6 +5031,11 @@ components: permissions: {} licenses: {} user_feature_flags: {} + apitoken_last_used: + oneOf: + - type: 'null' + - type: string + format: date-time additionalProperties: false definitions: {} $schema: http://json-schema.org/draft-07/schema# diff --git a/openapi-v3.yaml b/openapi-v3.yaml index 6844e6d..2dc97cc 100644 --- a/openapi-v3.yaml +++ b/openapi-v3.yaml @@ -4136,7 +4136,7 @@ paths: description: '' /api/v3/users/{user_id}/credentials/: get: - operationId: List Users Credentials + operationId: List Users Credential description: List the development credentials associated with a given user. parameters: - in: query @@ -4181,9 +4181,7 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/UserCredentialsEnveloped' + $ref: '#/components/schemas/UserCredentialsEnveloped' description: '' post: operationId: Create Users Credential @@ -4215,9 +4213,7 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/UserCredentialsEnveloped' + $ref: '#/components/schemas/UserCredentialsEnveloped' description: '' /api/v3/users/{user_id}/credentials/{id}/: get: @@ -4894,11 +4890,13 @@ components: - every_day - days_of_week - custom_cron + - interval_cron type: string description: |- * `every_day` - every_day * `days_of_week` - days_of_week * `custom_cron` - custom_cron + * `interval_cron` - interval_cron DbtAdapter: type: object properties: @@ -5665,6 +5663,9 @@ components: triggers_on_draft_pr: type: boolean default: false + run_audit_helper: + type: boolean + default: false required: - account_id - deactivated @@ -6429,6 +6430,11 @@ components: type: array items: type: integer + failures: + type: object + additionalProperties: {} + description: This field will detail specific failures within a single environment + variable you are attempting to create. required: - message - new_var_ids @@ -7092,6 +7098,11 @@ components: permissions: {} licenses: {} user_feature_flags: {} + apitoken_last_used: + oneOf: + - type: 'null' + - type: string + format: date-time additionalProperties: false definitions: {} $schema: http://json-schema.org/draft-07/schema#