From 78bdb53715eef3884a06a0dc7a86a6a36fc8abc5 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Thu, 6 Aug 2020 13:12:03 -0600 Subject: [PATCH] updated swagger.yml for beta-16 --- api-docs/v2.0/swagger.yml | 1253 +++++++++++++++---------------------- 1 file changed, 509 insertions(+), 744 deletions(-) diff --git a/api-docs/v2.0/swagger.yml b/api-docs/v2.0/swagger.yml index 94df83321..926b2e4a9 100644 --- a/api-docs/v2.0/swagger.yml +++ b/api-docs/v2.0/swagger.yml @@ -2449,7 +2449,7 @@ paths: - "UpdatedAt" - in: query name: id - description: List of dashboard IDs to return. If both `id and `owner` are specified, only `id` is used. + description: List of dashboard IDs to return. If both `id` and `owner` are specified, only `id` is used. schema: type: array items: @@ -3126,36 +3126,6 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - "/dashboards/{dashboardID}/logs": - get: - operationId: GetDashboardsIDLogs - tags: - - Dashboards - - OperationLogs - summary: Retrieve operation logs for a dashboard - parameters: - - $ref: "#/components/parameters/TraceSpan" - - $ref: "#/components/parameters/Offset" - - $ref: "#/components/parameters/Limit" - - in: path - name: dashboardID - required: true - description: The dashboard ID. - schema: - type: string - responses: - "200": - description: Operation logs for the dashboard - content: - application/json: - schema: - $ref: "#/components/schemas/OperationLogs" - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" /query/ast: post: operationId: PostQueryAst @@ -3962,36 +3932,6 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - "/buckets/{bucketID}/logs": - get: - operationId: GetBucketsIDLogs - tags: - - Buckets - - OperationLogs - summary: Retrieve operation logs for a bucket - parameters: - - $ref: "#/components/parameters/TraceSpan" - - $ref: "#/components/parameters/Offset" - - $ref: "#/components/parameters/Limit" - - in: path - name: bucketID - required: true - description: The bucket ID. - schema: - type: string - responses: - "200": - description: Operation logs for the bucket - content: - application/json: - schema: - $ref: "#/components/schemas/OperationLogs" - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" /orgs: get: operationId: GetOrgs @@ -4143,101 +4083,6 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - "/orgs/{orgID}/labels": - get: - operationId: GetOrgsIDLabels - tags: - - Organizations - summary: List all labels for a organization - parameters: - - $ref: "#/components/parameters/TraceSpan" - - in: path - name: orgID - schema: - type: string - required: true - description: The organization ID. - responses: - "200": - description: A list of all labels for an organization - content: - application/json: - schema: - $ref: "#/components/schemas/LabelsResponse" - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - post: - operationId: PostOrgsIDLabels - tags: - - Organizations - summary: Add a label to an organization - parameters: - - $ref: "#/components/parameters/TraceSpan" - - in: path - name: orgID - schema: - type: string - required: true - description: The organization ID. - requestBody: - description: Label to add - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/LabelMapping" - responses: - "201": - description: Returns the created label - content: - application/json: - schema: - $ref: "#/components/schemas/LabelResponse" - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - "/orgs/{orgID}/labels/{labelID}": - delete: - operationId: DeleteOrgsIDLabelsID - tags: - - Organizations - summary: Delete a label from an organization - parameters: - - $ref: "#/components/parameters/TraceSpan" - - in: path - name: orgID - schema: - type: string - required: true - description: The organization ID. - - in: path - name: labelID - schema: - type: string - required: true - description: The label ID. - responses: - "204": - description: Delete has been accepted - "404": - description: Organization not found - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" "/orgs/{orgID}/secrets": get: operationId: GetOrgsIDSecrets @@ -4493,300 +4338,12 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - "/orgs/{orgID}/invites": - post: - operationId: PostOrgsIDInvites - tags: - - Invites - - Organizations - summary: Creates an invite to an organization - parameters: - - $ref: "#/components/parameters/TraceSpan" - - in: path - name: orgID - schema: - type: string - required: true - description: The organization ID. - requestBody: - description: Invite to be sent - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/Invite" - responses: - "201": - description: Invite sent - content: - application/json: - schema: - $ref: "#/components/schemas/Invite" - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - "/orgs/{orgID}/invites/{inviteID}": - delete: - operationId: DeleteOrgsIDInviteID - tags: - - Invites - - Organizations - summary: Remove an invite to an organization - parameters: - - $ref: "#/components/parameters/TraceSpan" - - in: path - name: inviteID - schema: - type: string - required: true - description: The ID of the invite to remove. - - in: path - name: orgID - schema: - type: string - required: true - description: The organization ID. - responses: - "204": - description: Invite removed - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - "/orgs/{orgID}/invites/{inviteID}/resend": - post: - operationId: DeleteOrgsIDInviteID - tags: - - Invites - - Organizations - summary: Resends an invite - parameters: - - $ref: "#/components/parameters/TraceSpan" - - in: path - name: inviteID - schema: - type: string - required: true - description: The ID of the invite to resend. - - in: path - name: orgID - schema: - type: string - required: true - description: The organization ID. - responses: - "200": - description: Invite resent - content: - application/json: - schema: - $ref: "#/components/schemas/Invite" - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - "/orgs/{orgID}/users": - get: - operationId: GetCloudUsers - tags: - - CloudUsers - parameters: - - $ref: "#/components/parameters/TraceSpan" - - in: path - name: orgID - description: Specifies the organization ID of the CloudUser. - required: true - schema: - type: string - responses: - "200": - description: A list of cloud users - content: - application/json: - schema: - $ref: "#/components/schemas/CloudUsers" - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - "/orgs/{orgID}/users/{userID}": - delete: - operationId: DeleteOrgsIDCloudUserID - tags: - - CloudUsers - - Organizations - summary: Deletes a cloud user - parameters: - - $ref: "#/components/parameters/TraceSpan" - - in: path - name: userID - schema: - type: string - required: true - description: The ID of the user to remove. - - in: path - name: orgID - schema: - type: string - required: true - description: The organization ID. - responses: - "204": - description: User removed - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - "/orgs/{orgID}/owners/{userID}": - delete: - operationId: DeleteOrgsIDOwnersID - tags: - - Users - - Organizations - summary: Remove an owner from an organization - parameters: - - $ref: "#/components/parameters/TraceSpan" - - in: path - name: userID - schema: - type: string - required: true - description: The ID of the owner to remove. - - in: path - name: orgID - schema: - type: string - required: true - description: The organization ID. - responses: - "204": - description: Owner removed - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - "/orgs/{orgID}/logs": - get: - operationId: GetOrgsIDLogs - tags: - - Organizations - - OperationLogs - summary: Retrieve operation logs for an organization - parameters: - - $ref: "#/components/parameters/TraceSpan" - - $ref: "#/components/parameters/Offset" - - $ref: "#/components/parameters/Limit" - - in: path - name: orgID - required: true - description: The organization ID. - schema: - type: string - responses: - "200": - description: Operation logs for the organization - content: - application/json: - schema: - $ref: "#/components/schemas/OperationLogs" - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - /packages: - post: - operationId: CreatePkg - tags: - - InfluxPackages - summary: Create a new Influx package - requestBody: - description: Influx package to create. - required: false - content: - application/json: - schema: - $ref: "#/components/schemas/PkgCreate" - responses: - "200": - description: Influx package created - content: - application/json: - schema: - $ref: "#/components/schemas/Pkg" - application/x-yaml: - schema: - $ref: "#/components/schemas/Pkg" - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - /packages/apply: - post: - operationId: ApplyPkg - tags: - - InfluxPackages - summary: Apply or dry-run an Influx package - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/PkgApply" - application/x-jsonnet: - schema: - $ref: "#/components/schemas/PkgApply" - text/yml: - schema: - $ref: "#/components/schemas/PkgApply" - responses: - "200": - description: > - Influx package dry-run successful, no new resources created. - The provided diff and summary will not have IDs for resources - that do not exist at the time of the dry run. - content: - application/json: - schema: - $ref: "#/components/schemas/PkgSummary" - "201": - description: > - Influx package applied successfully. Newly created resources created - available in summary. The diff compares the state of the world before - the package is applied with the changes the application will impose. - This corresponds to `"dryRun": true` - content: - application/json: - schema: - $ref: "#/components/schemas/PkgSummary" - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - /packages/stacks: + /stacks: get: operationId: ListStacks tags: - - InfluxPackages - summary: Grab a list of installed Influx packages + - InfluxDB Templates + summary: Grab a list of installed InfluxDB Templates parameters: - in: query name: orgID @@ -4810,50 +4367,12 @@ paths: content: application/json: schema: - type: array - items: - type: object - properties: - id: - type: string - orgID: - type: string - name: - type: string - description: - type: string - urls: - type: array - items: - type: string - createdAt: - type: string - format: date-time - readOnly: true - updatedAt: - type: string - format: date-time - readOnly: true - resources: - type: object - properties: - apiVersion: - type: string - resourceID: - type: string - kind: - type: string - pkgName: - type: string - associations: - type: array - items: - type: object - properties: - kind: - type: string - pkgName: - type: string + type: object + properties: + stacks: + type: array + items: + $ref: "#/components/schemas/Stack" default: description: Unexpected error content: @@ -4863,10 +4382,10 @@ paths: post: operationId: CreateStack tags: - - InfluxPackages - summary: Create a new Influx package + - InfluxDB Templates + summary: Create a new stack requestBody: - description: Influx package to create. + description: Stack to create. required: true content: application/json: @@ -4885,43 +4404,103 @@ paths: type: string responses: "201": - description: Influx stack created + description: InfluxDB Stack created content: application/json: schema: - type: object - properties: - id: - type: string - orgID: - type: string - name: - type: string - description: - type: string - urls: - type: array - items: - type: string - createdAt: - type: string - format: date-time - readOnly: true - updatedAt: - type: string - format: date-time - readOnly: true + $ref: "#/components/schemas/Stack" + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + /stacks/{stack_id}: + get: + operationId: ReadStack + tags: + - InfluxDB Templates + summary: Grab a stack by its ID + parameters: + - in: path + name: stack_id + required: true + schema: + type: string + description: The stack id + responses: + "200": + description: Read an influx stack by ID + content: + application/json: + schema: + $ref: "#/components/schemas/Stack" + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + patch: + operationId: UpdateStack + tags: + - InfluxDB Templates + summary: Update an InfluxDB Stack + parameters: + - in: path + name: stack_id + required: true + schema: + type: string + description: The stack id + requestBody: + description: Influx stack to update. + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + nullable: true + description: + type: string + nullable: true + templateURLs: + type: array + items: + type: string + nullable: true + additionalResources: + type: array + items: + type: object + properties: + resourceID: + type: string + kind: + type: string + templateMetaName: + type: string + required: ["kind","resourceID"] + responses: + "200": + description: Influx stack updated + content: + application/json: + schema: + $ref: "#/components/schemas/Stack" default: description: Unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" - /packages/stacks/{stack_id}: delete: operationId: DeleteStack tags: - - InfluxPackages + - InfluxDB Templates summary: Delete a stack and remove all its associated resources parameters: - in: path @@ -4929,7 +4508,7 @@ paths: required: true schema: type: string - description: The stack id to be removed + description: The stack id - in: query name: orgID required: true @@ -4945,35 +4524,99 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - /packages/stacks/{stack_id}/export: - delete: - operationId: ExportStack + /stacks/{stack_id}/uninstall: + post: + operationId: UninstallStack tags: - - InfluxPackages - summary: Export a stack's resources in the form of a package + - InfluxDB Templates + summary: Uninstall an InfluxDB Stack parameters: - in: path name: stack_id required: true schema: type: string - description: The stack id to be removed - - in: query - name: orgID - required: true - schema: - type: string - description: The organization id of the user + description: The stack id responses: "200": - description: Stack and all its associated resources are deleted + description: Influx stack uninstalled content: application/json: schema: - $ref: "#/components/schemas/Pkg" + $ref: "#/components/schemas/Stack" + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + /templates/apply: + post: + operationId: ApplyTemplate + tags: + - InfluxDB Templates + summary: Apply or dry-run an InfluxDB Template + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/TemplateApply" + application/x-jsonnet: + schema: + $ref: "#/components/schemas/TemplateApply" + text/yml: + schema: + $ref: "#/components/schemas/TemplateApply" + responses: + "200": + description: > + Influx package dry-run successful, no new resources created. + The provided diff and summary will not have IDs for resources + that do not exist at the time of the dry run. + content: + application/json: + schema: + $ref: "#/components/schemas/TemplateSummary" + "201": + description: > + Influx package applied successfully. Newly created resources created + available in summary. The diff compares the state of the world before + the package is applied with the changes the application will impose. + This corresponds to `"dryRun": true` + content: + application/json: + schema: + $ref: "#/components/schemas/TemplateSummary" + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + /templates/export: + post: + operationId: ExportTemplate + tags: + - InfluxDB Templates + summary: Export a new Influx Template + requestBody: + description: Export resources as an InfluxDB template. + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/TemplateExport" + responses: + "200": + description: InfluxDB template created + content: + application/json: + schema: + $ref: "#/components/schemas/Template" application/x-yaml: schema: - $ref: "#/components/schemas/Pkg" + $ref: "#/components/schemas/Template" default: description: Unexpected error content: @@ -5898,36 +5541,6 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - "/users/{userID}/logs": - get: - operationId: GetUsersIDLogs - tags: - - Users - - OperationLogs - summary: Retrieve operation logs for a user - parameters: - - $ref: "#/components/parameters/TraceSpan" - - $ref: "#/components/parameters/Offset" - - $ref: "#/components/parameters/Limit" - - in: path - name: userID - required: true - description: The user ID. - schema: - type: string - responses: - "200": - description: Operation logs for the user - content: - application/json: - schema: - $ref: "#/components/schemas/OperationLogs" - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" /checks: get: operationId: GetChecks @@ -7566,7 +7179,7 @@ components: type: string retentionRules: $ref: "#/components/schemas/RetentionRules" - required: [name, retentionRules] + required: [orgID, name, retentionRules] Bucket: properties: links: @@ -7574,7 +7187,6 @@ components: readOnly: true example: labels: "/api/v2/buckets/1/labels" - logs: "/api/v2/buckets/1/logs" members: "/api/v2/buckets/1/members" org: "/api/v2/orgs/2" owners: "/api/v2/buckets/1/owners" @@ -7584,9 +7196,6 @@ components: labels: description: URL to retrieve labels for this bucket $ref: "#/components/schemas/Link" - logs: - description: URL to retrieve operation logs for this bucket - $ref: "#/components/schemas/Link" members: description: URL to retrieve members that can read this bucket $ref: "#/components/schemas/Link" @@ -7698,35 +7307,6 @@ components: description: A description of the event that occurred. type: string example: Halt and catch fire - OperationLog: - type: object - readOnly: true - properties: - description: - type: string - description: A description of the event that occurred. - example: Bucket Created - time: - type: string - description: Time event occurred, RFC3339Nano. - format: date-time - userID: - type: string - description: ID of the user who operated the event. - links: - type: object - properties: - user: - $ref: "#/components/schemas/Link" - OperationLogs: - type: object - properties: - logs: - type: array - items: - $ref: "#/components/schemas/OperationLog" - links: - $ref: "#/components/schemas/Links" Organization: properties: links: @@ -7741,7 +7321,6 @@ components: buckets: "/api/v2/buckets?org=myorg" tasks: "/api/v2/tasks?org=myorg" dashboards: "/api/v2/dashboards?org=myorg" - logs: "/api/v2/orgs/1/logs" properties: self: $ref: "#/components/schemas/Link" @@ -7759,8 +7338,6 @@ components: $ref: "#/components/schemas/Link" dashboards: $ref: "#/components/schemas/Link" - logs: - $ref: "#/components/schemas/Link" id: readOnly: true type: string @@ -7793,7 +7370,7 @@ components: type: array items: $ref: "#/components/schemas/Organization" - PkgApply: + TemplateApply: type: object properties: dryRun: @@ -7802,12 +7379,38 @@ components: type: string stackID: type: string - package: - $ref: "#/components/schemas/Pkg" - packages: + template: + type: object + properties: + contentType: + type: string + sources: + type: array + items: + type: string + contents: + $ref: "#/components/schemas/Template" + templates: type: array items: - $ref: "#/components/schemas/Pkg" + type: object + properties: + contentType: + type: string + sources: + type: array + items: + type: string + contents: + $ref: "#/components/schemas/Template" + envRefs: + type: object + additionalProperties: + oneOf: + - type: string + - type: integer + - type: number + - type: boolean secrets: type: object additionalProperties: @@ -7822,21 +7425,56 @@ components: contentType: type: string required: ["url"] - PkgCreateKind: + actions: + type: array + items: + oneOf: + - type: object + properties: + action: + type: string + enum: ["skipKind"] + properties: + type: object + properties: + kind: + $ref: "#/components/schemas/TemplateKind" + required: ["kind"] + - type: object + properties: + action: + type: string + enum: ["skipResource"] + properties: + type: object + properties: + kind: + $ref: "#/components/schemas/TemplateKind" + resourceTemplateName: + type: string + required: ["kind", "resourceTemplateName"] + TemplateKind: type: string enum: - - bucket - - check - - dashboard - - label - - notification_endpoint - - notification_rule - - task - - telegraf - - variable - PkgCreate: + - Bucket + - Check + - CheckDeadman + - CheckThreshold + - Dashboard + - Label + - NotificationEndpoint + - NotificationEndpointHTTP + - NotificationEndpointPagerDuty + - NotificationEndpointSlack + - NotificationRule + - Task + - Telegraf + - Variable + TemplateExport: type: object properties: + stackID: + type: string orgIDs: type: array items: @@ -7854,18 +7492,18 @@ components: byResourceKind: type: array items: - $ref: "#/components/schemas/PkgCreateKind" + $ref: "#/components/schemas/TemplateKind" resources: type: object properties: id: type: string kind: - $ref: "#/components/schemas/PkgCreateKind" + $ref: "#/components/schemas/TemplateKind" name: type: string required: [id, kind] - Pkg: + Template: type: array items: type: object @@ -7873,20 +7511,7 @@ components: apiVersion: type: string kind: - type: string - enum: - - Bucket - - CheckDeadman - - CheckThreshold - - Dashboard - - Label - - NotificationEndpointHTTP - - NotificationEndpointPagerDuty - - NotificationEndpointSlack - - NotificationRule - - Task - - Telegraf - - Variable + $ref: "#/components/schemas/TemplateKind" meta: type: object properties: @@ -7894,7 +7519,7 @@ components: type: string spec: type: object - PkgEnvReferences: + TemplateEnvReferences: type: array items: type: object @@ -7906,15 +7531,29 @@ components: type: string description: Key identified as environment reference and is the key identified in the template value: - type: string description: Value provided to fulfill reference + nullable: true + oneOf: + - type: string + - type: integer + - type: number + - type: boolean defaultValue: - type: string description: Default value that will be provided for the reference when no value is provided - required: [resourceField, envRefKey, defaultValue] - PkgSummary: + nullable: true + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + required: [resourceField, envRefKey] + TemplateSummary: type: object properties: + sources: + type: array + items: + type: string stackID: type: string summary: @@ -7929,7 +7568,9 @@ components: type: string orgID: type: string - pkgName: + kind: + $ref: "#/components/schemas/TemplateKind" + templateMetaName: type: string name: type: string @@ -7940,9 +7581,9 @@ components: labelAssociations: type: array items: - $ref: "#/components/schemas/PkgSummaryLabel" + $ref: "#/components/schemas/TemplateSummaryLabel" envReferences: - $ref: "#/components/schemas/PkgEnvReferences" + $ref: "#/components/schemas/TemplateEnvReferences" checks: type: array items: @@ -7950,18 +7591,16 @@ components: - $ref: "#/components/schemas/CheckDiscriminator" - type: object properties: - pkgName: + kind: + $ref: "#/components/schemas/TemplateKind" + templateMetaName: type: string labelAssociations: type: array items: - $ref: "#/components/schemas/PkgSummaryLabel" + $ref: "#/components/schemas/TemplateSummaryLabel" envReferences: - $ref: "#/components/schemas/PkgEnvReferences" - labels: - type: array - items: - $ref: "#/components/schemas/PkgSummaryLabel" + $ref: "#/components/schemas/TemplateEnvReferences" dashboards: type: array items: @@ -7971,7 +7610,9 @@ components: type: "string" orgID: type: "string" - pkgName: + kind: + $ref: "#/components/schemas/TemplateKind" + templateMetaName: type: string name: type: "string" @@ -7980,13 +7621,17 @@ components: labelAssociations: type: array items: - $ref: "#/components/schemas/PkgSummaryLabel" + $ref: "#/components/schemas/TemplateSummaryLabel" charts: type: array items: - $ref: "#/components/schemas/PkgChart" + $ref: "#/components/schemas/TemplateChart" envReferences: - $ref: "#/components/schemas/PkgEnvReferences" + $ref: "#/components/schemas/TemplateEnvReferences" + labels: + type: array + items: + $ref: "#/components/schemas/TemplateSummaryLabel" labelMappings: type: array items: @@ -7994,7 +7639,7 @@ components: properties: status: type: string - resourcePkgName: + resourceTemplateMetaName: type: string resourceName: type: string @@ -8002,7 +7647,7 @@ components: type: string resourceType: type: string - labelPkgName: + labelTemplateMetaName: type: string labelName: type: string @@ -8023,26 +7668,30 @@ components: - $ref: "#/components/schemas/NotificationEndpointDiscrimator" - type: object properties: - pkgName: + kind: + $ref: "#/components/schemas/TemplateKind" + templateMetaName: type: string labelAssociations: type: array items: - $ref: "#/components/schemas/PkgSummaryLabel" + $ref: "#/components/schemas/TemplateSummaryLabel" envReferences: - $ref: "#/components/schemas/PkgEnvReferences" + $ref: "#/components/schemas/TemplateEnvReferences" notificationRules: type: array items: type: object properties: - pkgName: + kind: + $ref: "#/components/schemas/TemplateKind" + templateMetaName: type: string name: type: string description: type: string - endpointPkgName: + endpointTemplateMetaName: type: string endpointID: type: string @@ -8079,15 +7728,17 @@ components: labelAssociations: type: array items: - $ref: "#/components/schemas/PkgSummaryLabel" + $ref: "#/components/schemas/TemplateSummaryLabel" envReferences: - $ref: "#/components/schemas/PkgEnvReferences" + $ref: "#/components/schemas/TemplateEnvReferences" tasks: type: array items: type: object properties: - pkgName: + kind: + $ref: "#/components/schemas/TemplateKind" + templateMetaName: type: string id: type: string @@ -8106,7 +7757,7 @@ components: status: type: string envReferences: - $ref: "#/components/schemas/PkgEnvReferences" + $ref: "#/components/schemas/TemplateEnvReferences" telegrafConfigs: type: array items: @@ -8114,20 +7765,24 @@ components: - $ref: "#/components/schemas/TelegrafRequest" - type: object properties: - pkgName: + kind: + $ref: "#/components/schemas/TemplateKind" + templateMetaName: type: string labelAssociations: type: array items: - $ref: "#/components/schemas/PkgSummaryLabel" + $ref: "#/components/schemas/TemplateSummaryLabel" envReferences: - $ref: "#/components/schemas/PkgEnvReferences" + $ref: "#/components/schemas/TemplateEnvReferences" variables: type: array items: type: object properties: - pkgName: + kind: + $ref: "#/components/schemas/TemplateKind" + templateMetaName: type: string id: type: string @@ -8142,9 +7797,9 @@ components: labelAssociations: type: array items: - $ref: "#/components/schemas/PkgSummaryLabel" + $ref: "#/components/schemas/TemplateSummaryLabel" envReferences: - $ref: "#/components/schemas/PkgEnvReferences" + $ref: "#/components/schemas/TemplateEnvReferences" diff: type: object properties: @@ -8153,11 +7808,13 @@ components: items: type: object properties: + kind: + $ref: "#/components/schemas/TemplateKind" stateStatus: type: string id: type: string - pkgName: + templateMetaName: type: string new: type: object @@ -8182,11 +7839,13 @@ components: items: type: object properties: + kind: + $ref: "#/components/schemas/TemplateKind" stateStatus: type: string id: type: string - pkgName: + templateMetaName: type: string new: $ref: "#/components/schemas/CheckDiscriminator" @@ -8201,7 +7860,9 @@ components: type: string id: type: string - pkgName: + kind: + $ref: "#/components/schemas/TemplateKind" + templateMetaName: type: string new: type: object @@ -8213,7 +7874,7 @@ components: charts: type: array items: - $ref: "#/components/schemas/PkgChart" + $ref: "#/components/schemas/TemplateChart" old: type: object properties: @@ -8224,7 +7885,7 @@ components: charts: type: array items: - $ref: "#/components/schemas/PkgChart" + $ref: "#/components/schemas/TemplateChart" labels: type: array items: @@ -8232,9 +7893,11 @@ components: properties: stateStatus: type: string + kind: + $ref: "#/components/schemas/TemplateKind" id: type: string - pkgName: + templateMetaName: type: string new: type: object @@ -8265,13 +7928,13 @@ components: type: string resourceID: type: string - resourcePkgName: + resourceTemplateMetaName: type: string resourceName: type: string labelID: type: string - labelPkgName: + labelTemplateMetaName: type: string labelName: type: string @@ -8280,11 +7943,13 @@ components: items: type: object properties: + kind: + $ref: "#/components/schemas/TemplateKind" stateStatus: type: string id: type: string - pkgName: + templateMetaName: type: string new: $ref: "#/components/schemas/NotificationEndpointDiscrimator" @@ -8295,11 +7960,13 @@ components: items: type: object properties: + kind: + $ref: "#/components/schemas/TemplateKind" stateStatus: type: string id: type: string - pkgName: + templateMetaName: type: string new: type: object @@ -8388,11 +8055,13 @@ components: items: type: object properties: + kind: + $ref: "#/components/schemas/TemplateKind" stateStatus: type: string id: type: string - pkgName: + templateMetaName: type: string new: type: object @@ -8433,11 +8102,13 @@ components: items: type: object properties: + kind: + $ref: "#/components/schemas/TemplateKind" stateStatus: type: string id: type: string - pkgName: + templateMetaName: type: string new: $ref: "#/components/schemas/TelegrafRequest" @@ -8448,11 +8119,13 @@ components: items: type: object properties: + kind: + $ref: "#/components/schemas/TemplateKind" stateStatus: type: string id: type: string - pkgName: + templateMetaName: type: string new: type: object @@ -8478,7 +8151,7 @@ components: type: object properties: kind: - type: string + $ref: "#/components/schemas/TemplateKind" reason: type: string fields: @@ -8489,14 +8162,16 @@ components: type: array items: type: integer - PkgSummaryLabel: + TemplateSummaryLabel: type: object properties: id: type: string orgID: type: string - pkgName: + kind: + $ref: "#/components/schemas/TemplateKind" + templateMetaName: type: string name: type: string @@ -8508,8 +8183,8 @@ components: description: type: string envReferences: - $ref: "#/components/schemas/PkgEnvReferences" - PkgChart: + $ref: "#/components/schemas/TemplateEnvReferences" + TemplateChart: type: object properties: xPos: @@ -8522,6 +8197,67 @@ components: type: integer properties: # field name is properties $ref: "#/components/schemas/ViewProperties" + Stack: + type: object + properties: + id: + type: string + orgID: + type: string + createdAt: + type: string + format: date-time + readOnly: true + events: + type: array + items: + type: object + properties: + eventType: + type: string + name: + type: string + description: + type: string + sources: + type: array + items: + type: string + resources: + type: array + items: + type: object + properties: + apiVersion: + type: string + resourceID: + type: string + kind: + $ref: "#/components/schemas/TemplateKind" + templateMetaName: + type: string + associations: + type: array + items: + type: object + properties: + kind: + $ref: "#/components/schemas/TemplateKind" + metaName: + type: string + links: + type: object + properties: + self: + type: string + urls: + type: array + items: + type: string + updatedAt: + type: string + format: date-time + readOnly: true Runs: type: object properties: @@ -8587,7 +8323,6 @@ components: self: "/api/v2/tasks/1/runs/1" task: "/api/v2/tasks/1" retry: "/api/v2/tasks/1/runs/1/retry" - logs: "/api/v2/tasks/1/runs/1/logs" properties: self: type: string @@ -8595,9 +8330,6 @@ components: task: type: string format: uri - logs: - type: string - format: uri retry: type: string format: uri @@ -8747,46 +8479,6 @@ components: type: array items: $ref: "#/components/schemas/Invite" - CloudUser: - properties: - id: - description: the idpe id of the user - readOnly: true - type: string - firstName: - type: string - lastName: - type: string - email: - type: string - role: - type: string - enum: - - member - - owner - links: - type: object - readOnly: true - example: - self: "/api/v2/cloud_users/1" - properties: - self: - type: string - format: uri - required: [id, email, role] - CloudUsers: - type: object - properties: - links: - type: object - properties: - self: - type: string - format: uri - users: - type: array - items: - $ref: "#/components/schemas/CloudUser" User: properties: id: @@ -8808,14 +8500,10 @@ components: readOnly: true example: self: "/api/v2/users/1" - logs: "/api/v2/users/1/logs" properties: self: type: string format: uri - logs: - type: string - format: uri required: [name] Users: type: object @@ -9097,6 +8785,8 @@ components: properties: period: type: string + fillValues: + type: boolean BuilderTagsType: type: object properties: @@ -9253,6 +8943,9 @@ components: type: string shadeBelow: type: boolean + hoverDimension: + type: string + enum: [auto, x, y, xy] position: type: string enum: [overlaid, stacked] @@ -9309,6 +9002,9 @@ components: type: string shadeBelow: type: boolean + hoverDimension: + type: string + enum: [auto, x, y, xy] position: type: string enum: [overlaid, stacked] @@ -9318,6 +9014,81 @@ components: type: string decimalPlaces: $ref: "#/components/schemas/DecimalPlaces" + MosaicViewProperties: + type: object + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - ySeriesColumns + - fillColumns + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + properties: + timeFormat: + type: string + type: + type: string + enum: [mosaic] + queries: + type: array + items: + $ref: "#/components/schemas/DashboardQuery" + colors: + description: Colors define color encoding of data into a visualization + type: array + items: + type: string + shape: + type: string + enum: ["chronograf-v2"] + note: + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + xColumn: + type: string + ySeriesColumns: + type: array + items: + type: string + fillColumns: + type: array + items: + type: string + xDomain: + type: array + items: + type: number + maxItems: 2 + yDomain: + type: array + items: + type: number + maxItems: 2 + xAxisLabel: + type: string + yAxisLabel: + type: string + xPrefix: + type: string + xSuffix: + type: string + yPrefix: + type: string + ySuffix: + type: string ScatterViewProperties: type: object required: @@ -9900,6 +9671,7 @@ components: - $ref: "#/components/schemas/CheckViewProperties" - $ref: "#/components/schemas/ScatterViewProperties" - $ref: "#/components/schemas/HeatmapViewProperties" + - $ref: "#/components/schemas/MosaicViewProperties" View: required: - name @@ -10078,7 +9850,6 @@ components: cells: "/api/v2/dashboards/1/cells" owners: "/api/v2/dashboards/1/owners" members: "/api/v2/dashboards/1/members" - logs: "/api/v2/dashboards/1/logs" labels: "/api/v2/dashboards/1/labels" org: "/api/v2/labels/1" properties: @@ -10090,8 +9861,6 @@ components: $ref: "#/components/schemas/Link" owners: $ref: "#/components/schemas/Link" - logs: - $ref: "#/components/schemas/Link" labels: $ref: "#/components/schemas/Link" org: @@ -10125,7 +9894,6 @@ components: cells: "/api/v2/dashboards/1/cells" owners: "/api/v2/dashboards/1/owners" members: "/api/v2/dashboards/1/members" - logs: "/api/v2/dashboards/1/logs" labels: "/api/v2/dashboards/1/labels" org: "/api/v2/labels/1" properties: @@ -10137,8 +9905,6 @@ components: $ref: "#/components/schemas/Link" owners: $ref: "#/components/schemas/Link" - logs: - $ref: "#/components/schemas/Link" labels: $ref: "#/components/schemas/Link" org: @@ -10940,7 +10706,6 @@ components: type: integer required: - username - - password - org - bucket OnboardingResponse: