You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
InfluxDB 2.0: The "Bucket.organization", "ScraperTargetResponse.organization" and "TelegrafPluginOutputInfluxDBV2Config.organization" should be rename to "org" [area/api]
#13148
Bucket:
properties:
links:
type: objectreadOnly: trueexample:
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"self: "/api/v2/buckets/1"write: "/api/v2/write?org=2&bucket=1"properties:
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"org:
description: URL to retrieve parent organization for this bucket$ref: "#/components/schemas/Link"owners:
description: URL to retrieve owners that can read and write to this bucket.$ref: "#/components/schemas/Link"self:
description: URL for this bucket$ref: "#/components/schemas/Link"write:
description: URL to write line protocol for this bucket$ref: "#/components/schemas/Link"id:
readOnly: truetype: stringname:
type: stringorganizationID:
type: stringorganization:
type: stringrp:
type: stringretentionRules:
type: arraydescription: rules to expire or retain data. No rules means data never expires.items:
type: objectproperties:
type:
type: stringdefault: expireenum:
- expireeverySeconds:
type: integerdescription: duration in seconds for how long data will be kept in the database.example: 86400minimum: 1required: [type, everySeconds]labels:
$ref: "#/components/schemas/Labels"required: [name, retentionRules]
ScraperTargetResponse is defined as:
ScraperTargetResponse:
type: objectallOf:
- $ref: "#/components/schemas/ScraperTargetRequest"
- type: objectproperties:
id:
type: stringreadOnly: trueorganization:
type: stringdescription: name of the organizationbucket:
type: stringdescription: name of the bucketlinks:
type: objectreadOnly: trueexample:
self: "/api/v2/scrapers/1"owners: "/api/v2/scrapers/1/owners"members: "/api/v2/scrapers/1/members"bucket: "/api/v2/buckets/1"organization: "/api/v2/orgs/1"properties:
self:
$ref: "#/components/schemas/Link"members:
$ref: "#/components/schemas/Link"owners:
$ref: "#/components/schemas/Link"bucket:
$ref: "#/components/schemas/Link"organization:
$ref: "#/components/schemas/Link"
and TelegrafPluginOutputInfluxDBV2Config is defined as:
The properties organization should be renamed to org as is in rest of API:
TaskCreateRequest:
type: objectproperties:
orgID:
description: The ID of the organization that owns this Task.type: stringorg:
description: The name of the organization that owns this Task.type: stringstatus:
description: Starting state of the task. 'inactive' tasks are not run until they are updated to 'active'default: activetype: stringenum:
- active
- inactiveflux:
description: The Flux script to run for this task.type: stringtoken:
description: The token to use for authenticating this task when it executes queries. If omitted, uses the token associated with the request that creates the task.type: stringrequired: [flux]
...
Permission:
required: [action, resource]properties:
action:
type: stringenum:
- read
- writeresource:
type: objectrequired: [type]properties:
type:
type: stringenum:
- authorizations
- buckets
- dashboards
- orgs
- sources
- tasks
- telegrafs
- users
- variables
- scrapers
- secrets
- labels
- views
- documentsid:
type: stringnullable: truedescription: if id is set that is a permission for a specific resource. if it is not set it is a permission for all resources of that resource type.name:
type: stringnullable: truedescription: optional name of the resource if the resource has a name field.orgID:
type: stringnullable: truedescription: if orgID is set that is a permission for all resources owned my that org. if it is not set it is a permission for all resources of that resource type.org:
type: stringnullable: truedescription: optional name of the organization of the organization with orgID.Authorization:
required: [orgID, permissions]allOf:
- $ref: "#/components/schemas/AuthorizationUpdateRequest"
- type: objectproperties:
orgID:
type: stringdescription: ID of org that authorization is scoped to.permissions:
type: arrayminLength: 1description: List of permissions for an auth. An auth must have at least one Permission.items:
$ref: "#/components/schemas/Permission"id:
readOnly: truetype: stringtoken:
readOnly: truetype: stringdescription: Passed via the Authorization Header and Token Authentication type.userID:
readOnly: truetype: stringdescription: ID of user that created and owns the token.user:
readOnly: truetype: stringdescription: Name of user that created and owns the token.org:
readOnly: truetype: stringdescription: Name of the org token is scoped to.links:
type: objectreadOnly: trueexample:
self: "/api/v2/authorizations/1"user: "/api/v2/users/12"properties:
self:
readOnly: truetype: stringformat: uriuser:
readOnly: truetype: stringformat: uri
...
/buckets:
get:
tags:
- Bucketssummary: List all bucketsparameters:
- $ref: '#/components/parameters/TraceSpan'
- $ref: "#/components/parameters/Offset"
- $ref: "#/components/parameters/Limit"
- in: queryname: orgdescription: specifies the organization name of the resourceschema:
type: string
- in: queryname: orgIDdescription: specifies the organization id of the resourceschema:
type: string
- in: queryname: namedescription: only returns buckets with the specified nameschema:
type: stringresponses:
The text was updated successfully, but these errors were encountered:
The
Bucket
schema is defined as:ScraperTargetResponse
is defined as:and
TelegrafPluginOutputInfluxDBV2Config
is defined as:The properties
organization
should be renamed toorg
as is in rest of API:The text was updated successfully, but these errors were encountered: