├── .circleci └── config.yml ├── .gitattributes ├── .gitignore ├── CODEOWNERS ├── LICENSE ├── Makefile ├── README.md ├── contracts ├── README.md ├── cloud-diff.yml ├── cloud.json ├── cloud.yml ├── common.yml ├── invocable-scripts.yml ├── legacy.yml ├── mapsd.yml ├── oss-diff.yml ├── oss.json ├── oss.yml ├── priv │ ├── annotationd-oss.yml │ ├── annotationd.yml │ ├── cloud-priv.yml │ ├── fluxdocsd.yml │ ├── nifid.yml │ ├── notebooksd.yml │ ├── quartz-oem.yml │ ├── uiproxyd.yml │ └── unity.yml ├── ref │ ├── cloud.yml │ └── oss.yml ├── svc │ ├── annotationd-oss.yml │ ├── annotationd.yml │ ├── fluxdocsd.yml │ ├── invocable-scripts.yml │ ├── mapsd.yml │ ├── nifid.yml │ ├── notebooksd.yml │ └── uiproxyd.yml └── swaggerV1Compat.yml ├── docs └── templates │ └── pathTemplate.yml ├── scripts ├── ci-oats.dockerfile ├── ci-swagger-cli.dockerfile ├── ci-swagrag.dockerfile ├── generate-svc.sh ├── generate.sh ├── oats.dockerfile ├── reference.sh ├── swagger-cli.dockerfile ├── test-oats.sh ├── test-openapi.sh └── test.sh └── src ├── README.md ├── cloud-priv.yml ├── cloud.yml ├── cloud ├── paths │ ├── dashboards.yml │ ├── flags.yml │ ├── limitevents.yml │ ├── measurements.yml │ ├── measurements_measurementID.yml │ ├── oauth_clientConfig.yml │ ├── orgs_orgID_limits.yml │ ├── orgs_orgID_limits_get.yml │ ├── orgs_orgID_limits_status.yml │ ├── orgs_orgID_secrets_delete.yml │ ├── orgs_orgID_secrets_secretID.yml │ ├── orgs_orgID_settings.yml │ ├── orgs_orgID_usage.yml │ ├── provision.yml │ ├── provision_delete.yml │ ├── provision_setup.yml │ ├── provision_suspend.yml │ ├── provision_unsuspend.yml │ ├── provision_user.yml │ ├── provision_user_delete.yml │ ├── setup.yml │ ├── setup_user.yml │ ├── tasks.yml │ ├── tasks_taskID.yml │ ├── tenants.yml │ ├── users.yml │ ├── users_userID.yml │ ├── variables.yml │ └── variables_variableID.yml ├── schemas │ ├── ColumnDataType.yml │ ├── ColumnSemanticType.yml │ ├── ForbiddenRequestError.yml │ ├── Identity.yml │ ├── IdentityWithLinks.yml │ ├── InvalidRequestError.yml │ ├── Limit.yml │ ├── LimitEvent.yml │ ├── LimitEvents.yml │ ├── LimitPatch.yml │ ├── LimitPublic.yml │ ├── LimitStatus.yml │ ├── LimitStatuses.yml │ ├── MeasurementSchema.yml │ ├── MeasurementSchemaColumn.yml │ ├── MeasurementSchemaCreateRequest.yml │ ├── MeasurementSchemaList.yml │ ├── MeasurementSchemaUpdateRequest.yml │ ├── OAuthClientConfig.yml │ ├── OnboardingRequest.yml │ ├── OnboardingResponse.yml │ ├── OrgConfig.yml │ ├── OrgSetting.yml │ ├── OrgSettings.yml │ ├── OrganizationRequest.yml │ ├── OrganizationResponse.yml │ ├── ProvisionDeleteRequest.yml │ ├── ProvisionRequest.yml │ ├── ProvisionResponse.yml │ ├── ProvisionSetupRequest.yml │ ├── ProvisionSetupResponse.yml │ ├── ProvisionSuspendRequest.yml │ ├── ProvisionUserDeleteRequest.yml │ ├── ProvisionUserRequest.yml │ ├── ProvisionUserResponse.yml │ ├── Resource.yml │ ├── Role.yml │ ├── Task.yml │ ├── TaskCreateRequest.yml │ ├── TaskUpdateRequest.yml │ ├── Tasks.yml │ ├── User.yml │ ├── Users.yml │ ├── Variable.yml │ └── Variables.yml ├── tag-groups.yml └── tags.yml ├── common.yml ├── common ├── _parameters.yml ├── _paths.yml ├── _responses.yml ├── _schemas.yml ├── parameters │ ├── After.yml │ ├── Descending.yml │ ├── Limit.yml │ ├── Offset.yml │ ├── SortBy.yml │ └── TraceSpan.yml ├── paths │ ├── 0slash.yml │ ├── authorizations.yml │ ├── authorizations_authID.yml │ ├── buckets.yml │ ├── buckets_bucketID.yml │ ├── buckets_bucketID_labels.yml │ ├── buckets_bucketID_labels_labelID.yml │ ├── buckets_bucketID_members.yml │ ├── buckets_bucketID_members_userID.yml │ ├── buckets_bucketID_owners.yml │ ├── buckets_bucketID_owners_userID.yml │ ├── checks.yml │ ├── checks_checkID.yml │ ├── checks_checkID_labels.yml │ ├── checks_checkID_labels_labelID.yml │ ├── checks_checkID_query.yml │ ├── dashboards.yml │ ├── dashboards_dashboardID.yml │ ├── dashboards_dashboardID_cells.yml │ ├── dashboards_dashboardID_cells_cellID.yml │ ├── dashboards_dashboardID_cells_cellID_view.yml │ ├── dashboards_dashboardID_labels.yml │ ├── dashboards_dashboardID_labels_labelID.yml │ ├── dashboards_dashboardID_members.yml │ ├── dashboards_dashboardID_members_userID.yml │ ├── dashboards_dashboardID_owners.yml │ ├── dashboards_dashboardID_owners_userID.yml │ ├── dbrps.yml │ ├── dbrps_dbrpID.yml │ ├── delete.yml │ ├── flags.yml │ ├── labels.yml │ ├── labels_labelID.yml │ ├── me.yml │ ├── me_password.yml │ ├── notificationEndpoints.yml │ ├── notificationEndpoints_endpointID.yml │ ├── notificationEndpoints_endpointID_labels.yml │ ├── notificationEndpoints_endpointID_labels_labelID.yml │ ├── notificationRules.yml │ ├── notificationRules_ruleID.yml │ ├── notificationRules_ruleID_labels.yml │ ├── notificationRules_ruleID_labels_labelID.yml │ ├── notificationRules_ruleID_query.yml │ ├── orgs.yml │ ├── orgs_orgID.yml │ ├── orgs_orgID_members.yml │ ├── orgs_orgID_members_userID.yml │ ├── orgs_orgID_owners.yml │ ├── orgs_orgID_owners_userID.yml │ ├── orgs_orgID_secrets.yml │ ├── orgs_orgID_secrets_delete.yml │ ├── orgs_orgID_secrets_secretID.yml │ ├── ping.yml │ ├── query.yml │ ├── query_analyze.yml │ ├── query_ast.yml │ ├── query_suggestions.yml │ ├── query_suggestions_name.yml │ ├── resources.yml │ ├── scrapers.yml │ ├── scrapers_scraperTargetID.yml │ ├── scrapers_scraperTargetID_labels.yml │ ├── scrapers_scraperTargetID_labels_labelID.yml │ ├── scrapers_scraperTargetID_members.yml │ ├── scrapers_scraperTargetID_members_userID.yml │ ├── scrapers_scraperTargetID_owners.yml │ ├── scrapers_scraperTargetID_owners_userID.yml │ ├── setup.yml │ ├── signin.yml │ ├── signout.yml │ ├── sources.yml │ ├── sources_sourceID.yml │ ├── sources_sourceID_buckets.yml │ ├── sources_sourceID_health.yml │ ├── stacks.yml │ ├── stacks_stack_id.yml │ ├── stacks_stack_id_uninstall.yml │ ├── tasks.yml │ ├── tasks_taskID.yml │ ├── tasks_taskID_labels.yml │ ├── tasks_taskID_labels_labelID.yml │ ├── tasks_taskID_logs.yml │ ├── tasks_taskID_members.yml │ ├── tasks_taskID_members_userID.yml │ ├── tasks_taskID_owners.yml │ ├── tasks_taskID_owners_userID.yml │ ├── tasks_taskID_runs.yml │ ├── tasks_taskID_runs_runID.yml │ ├── tasks_taskID_runs_runID_logs.yml │ ├── tasks_taskID_runs_runID_retry.yml │ ├── telegraf_plugins.yml │ ├── telegrafs.yml │ ├── telegrafs_telegrafID.yml │ ├── telegrafs_telegrafID_labels.yml │ ├── telegrafs_telegrafID_labels_labelID.yml │ ├── telegrafs_telegrafID_members.yml │ ├── telegrafs_telegrafID_members_userID.yml │ ├── telegrafs_telegrafID_owners.yml │ ├── telegrafs_telegrafID_owners_userID.yml │ ├── templates_apply.yml │ ├── templates_export.yml │ ├── users.yml │ ├── users_userID.yml │ ├── users_userID_password.yml │ ├── variables.yml │ ├── variables_variableID.yml │ ├── variables_variableID_labels.yml │ ├── variables_variableID_labels_labelID.yml │ └── write.yml ├── requestBody │ └── examples │ │ ├── AuthorizationRequestExamples.yml │ │ └── TaskRequestExamples.yml ├── responses │ ├── AuthorizationError.yml │ ├── BadRequestError.yml │ ├── InternalServerError.yml │ ├── NoContent.yml │ ├── ResourceNotFoundError.yml │ ├── ServerError.yml │ └── example-responses │ │ ├── GetBucketsIDLabelsSuccessResponse.yml │ │ ├── GetBucketsIDMembersSuccessResponse.yml │ │ ├── GetBucketsIDOwnersSuccessResponse.yml │ │ ├── GetBucketsIDSuccessResponse.yml │ │ ├── GetBucketsSuccessResponse.yml │ │ ├── GetDBRPsIDSuccessResponse.yml │ │ ├── GetDBRPsSuccessResponse.yml │ │ ├── GetOrgsIDMembersSuccessResponse.yml │ │ ├── GetOrgsIDOwnersSuccessResponse.yml │ │ ├── GetOrgsSuccessResponse.yml │ │ ├── GetTasksSuccessResponse.yml │ │ ├── PatchBucketsIDSuccessResponse.yml │ │ ├── PatchDBRPIDSuccessResponse.yml │ │ ├── PostBucketsIDLabelsSuccessResponse.yml │ │ ├── PostBucketsIDMembersSuccessResponse.yml │ │ ├── PostBucketsIDOwnersSuccessResponse.yml │ │ ├── PostBucketsSuccessResponse.yml │ │ ├── PostDBRPSuccessResponse.yml │ │ ├── PostOrgsIDMembersSuccessResponse.yml │ │ ├── PostOrgsIDOwnersSuccessResponse.yml │ │ └── PostOrgsSuccessResponse.yml └── schemas │ ├── ASTResponse.yml │ ├── ASTSuccessResponse.yml │ ├── AddResourceMemberRequestBody.yml │ ├── AnalyzeQueryResponse.yml │ ├── ArrayExpression.yml │ ├── Authorization.yml │ ├── AuthorizationPostRequest.yml │ ├── AuthorizationUpdateRequest.yml │ ├── Authorizations.yml │ ├── Axes.yml │ ├── Axis.yml │ ├── AxisScale.yml │ ├── BadStatement.yml │ ├── BandViewProperties.yml │ ├── BinaryExpression.yml │ ├── Block.yml │ ├── BooleanLiteral.yml │ ├── Bucket.yml │ ├── Buckets.yml │ ├── BuilderAggregateFunctionType.yml │ ├── BuilderConfig.yml │ ├── BuilderFunctionsType.yml │ ├── BuilderTagsType.yml │ ├── BuiltinStatement.yml │ ├── CallExpression.yml │ ├── Cell.yml │ ├── CellUpdate.yml │ ├── CellWithViewProperties.yml │ ├── Cells.yml │ ├── CellsWithViewProperties.yml │ ├── Check.yml │ ├── CheckBase.yml │ ├── CheckDiscriminator.yml │ ├── CheckPatch.yml │ ├── CheckStatusLevel.yml │ ├── CheckViewProperties.yml │ ├── Checks.yml │ ├── ColorMapping.yml │ ├── ConditionalExpression.yml │ ├── ConstantVariableProperties.yml │ ├── CreateCell.yml │ ├── CreateDashboardRequest.yml │ ├── CustomCheck.yml │ ├── DBRP.yml │ ├── DBRPCreate.yml │ ├── DBRPGet.yml │ ├── DBRPUpdate.yml │ ├── DBRPs.yml │ ├── Dashboard.yml │ ├── DashboardColor.yml │ ├── DashboardQuery.yml │ ├── DashboardWithViewProperties.yml │ ├── Dashboards.yml │ ├── DateTimeLiteral.yml │ ├── DeadmanCheck.yml │ ├── DecimalPlaces.yml │ ├── DeletePredicateRequest.yml │ ├── Dialect.yml │ ├── DictExpression.yml │ ├── DictItem.yml │ ├── Duration.yml │ ├── DurationLiteral.yml │ ├── Error.yml │ ├── ErrorCode.yml │ ├── Expression.yml │ ├── ExpressionStatement.yml │ ├── Field.yml │ ├── File.yml │ ├── Flags.yml │ ├── FloatLiteral.yml │ ├── FluxResponse.yml │ ├── FluxSuggestion.yml │ ├── FluxSuggestions.yml │ ├── FunctionExpression.yml │ ├── GaugeViewProperties.yml │ ├── GeoCircleViewLayer.yml │ ├── GeoHeatMapViewLayer.yml │ ├── GeoPointMapViewLayer.yml │ ├── GeoTrackMapViewLayer.yml │ ├── GeoViewLayer.yml │ ├── GeoViewLayerProperties.yml │ ├── GeoViewProperties.yml │ ├── GreaterThreshold.yml │ ├── HTTPNotificationEndpoint.yml │ ├── HTTPNotificationRule.yml │ ├── HTTPNotificationRuleBase.yml │ ├── HealthCheck.yml │ ├── HealthCheckStatus.yml │ ├── HeatmapViewProperties.yml │ ├── HistogramViewProperties.yml │ ├── Identifier.yml │ ├── ImportDeclaration.yml │ ├── IndexExpression.yml │ ├── InfluxQLQuery.yml │ ├── IntegerLiteral.yml │ ├── IsOnboarding.yml │ ├── Label.yml │ ├── LabelCreateRequest.yml │ ├── LabelMapping.yml │ ├── LabelResponse.yml │ ├── LabelUpdate.yml │ ├── Labels.yml │ ├── LabelsResponse.yml │ ├── LanguageRequest.yml │ ├── LatLonColumn.yml │ ├── LatLonColumns.yml │ ├── LesserThreshold.yml │ ├── LinePlusSingleStatProperties.yml │ ├── LineProtocolError.yml │ ├── LineProtocolErrorCode.yml │ ├── LineProtocolLengthError.yml │ ├── LineProtocolLengthErrorCode.yml │ ├── Link.yml │ ├── Links.yml │ ├── LogEvent.yml │ ├── LogicalExpression.yml │ ├── Logs.yml │ ├── MapVariableProperties.yml │ ├── MarkdownViewProperties.yml │ ├── MemberAssignment.yml │ ├── MemberExpression.yml │ ├── MosaicViewProperties.yml │ ├── MovedPermanently.yml │ ├── Node.yml │ ├── NodeType.yml │ ├── NotificationEndpoint.yml │ ├── NotificationEndpointBase.yml │ ├── NotificationEndpointDiscriminator.yml │ ├── NotificationEndpointType.yml │ ├── NotificationEndpointUpdate.yml │ ├── NotificationEndpoints.yml │ ├── NotificationRule.yml │ ├── NotificationRuleBase.yml │ ├── NotificationRuleDiscriminator.yml │ ├── NotificationRuleUpdate.yml │ ├── NotificationRules.yml │ ├── ObjectExpression.yml │ ├── OnboardingRequest.yml │ ├── OnboardingResponse.yml │ ├── OptionStatement.yml │ ├── Organization.yml │ ├── Organizations.yml │ ├── Package.yml │ ├── PackageClause.yml │ ├── PagerDutyNotificationEndpoint.yml │ ├── PagerDutyNotificationRule.yml │ ├── PagerDutyNotificationRuleBase.yml │ ├── ParenExpression.yml │ ├── PasswordResetBody.yml │ ├── PatchBucketRequest.yml │ ├── PatchOrganizationRequest.yml │ ├── PatchRetentionRule.yml │ ├── PatchRetentionRules.yml │ ├── Permission.yml │ ├── PipeExpression.yml │ ├── PipeLiteral.yml │ ├── PostBucketRequest.yml │ ├── PostCheck.yml │ ├── PostNotificationEndpoint.yml │ ├── PostNotificationRule.yml │ ├── PostOrganizationRequest.yml │ ├── Property.yml │ ├── PropertyKey.yml │ ├── Query.yml │ ├── QueryEditMode.yml │ ├── QuerySuggestionsNameSuccessResponse.yml │ ├── QuerySuggestionsSuccessResponse.yml │ ├── QueryVariableProperties.yml │ ├── RangeThreshold.yml │ ├── Ready.yml │ ├── RegexpLiteral.yml │ ├── RenamableField.yml │ ├── Resource.yml │ ├── ResourceMember.yml │ ├── ResourceMembers.yml │ ├── ResourceOwner.yml │ ├── ResourceOwners.yml │ ├── Resources.yml │ ├── RetentionRule.yml │ ├── RetentionRules.yml │ ├── ReturnStatement.yml │ ├── Routes.yml │ ├── RuleStatusLevel.yml │ ├── Run.yml │ ├── RunManually.yml │ ├── Runs.yml │ ├── SMTPNotificationRule.yml │ ├── SMTPNotificationRuleBase.yml │ ├── ScatterViewProperties.yml │ ├── SchemaType.yml │ ├── ScraperTargetRequest.yml │ ├── ScraperTargetResponse.yml │ ├── ScraperTargetResponses.yml │ ├── SecretKeys.yml │ ├── SecretKeysResponse.yml │ ├── Secrets.yml │ ├── SimpleTableViewProperties.yml │ ├── SingleStatViewProperties.yml │ ├── SlackNotificationEndpoint.yml │ ├── SlackNotificationRule.yml │ ├── SlackNotificationRuleBase.yml │ ├── Source.yml │ ├── Sources.yml │ ├── Stack.yml │ ├── Statement.yml │ ├── StaticLegend.yml │ ├── StatusRule.yml │ ├── StringLiteral.yml │ ├── TableViewProperties.yml │ ├── TagRule.yml │ ├── Task.yml │ ├── TaskCreateRequest.yml │ ├── TaskStatusType.yml │ ├── TaskUpdateRequest.yml │ ├── Tasks.yml │ ├── Telegraf.yml │ ├── TelegrafPlugin.yml │ ├── TelegrafPluginRequest.yml │ ├── TelegrafPlugins.yml │ ├── TelegrafRequest.yml │ ├── Telegrafs.yml │ ├── TelegramNotificationEndpoint.yml │ ├── TelegramNotificationRule.yml │ ├── TelegramNotificationRuleBase.yml │ ├── Template.yml │ ├── TemplateApply.yml │ ├── TemplateChart.yml │ ├── TemplateEntry.yml │ ├── TemplateEnvReferences.yml │ ├── TemplateExportByID.yml │ ├── TemplateExportByName.yml │ ├── TemplateKind.yml │ ├── TemplateSummary.yml │ ├── TemplateSummaryError.yml │ ├── TemplateSummaryLabel.yml │ ├── TestStatement.yml │ ├── Threshold.yml │ ├── ThresholdBase.yml │ ├── ThresholdCheck.yml │ ├── UnaryExpression.yml │ ├── UnauthorizedRequestError.yml │ ├── UnsignedIntegerLiteral.yml │ ├── User.yml │ ├── UserResponse.yml │ ├── Users.yml │ ├── Variable.yml │ ├── VariableAssignment.yml │ ├── VariableOrMemberAssignment.yml │ ├── VariableProperties.yml │ ├── Variables.yml │ ├── View.yml │ ├── ViewProperties.yml │ ├── Views.yml │ ├── WritePrecision.yml │ ├── XYGeom.yml │ └── XYViewProperties.yml ├── legacy.yml ├── legacy ├── paths │ ├── legacy_authorizations.yml │ ├── legacy_authorizations_authID.yml │ ├── legacy_authorizations_authID_password.yml │ ├── query.yml │ └── write.yml └── schemas │ ├── InfluxqlCsvResponse.yml │ ├── InfluxqlJsonResponse.yml │ └── LegacyAuthorizationPostRequest.yml ├── oss.yml ├── oss ├── paths │ ├── backup_kv.yml │ ├── backup_metadata.yml │ ├── backup_shards_shardID.yml │ ├── config.yml │ ├── debug_pprof_all.yml │ ├── debug_pprof_allocs.yml │ ├── debug_pprof_block.yml │ ├── debug_pprof_cmdline.yml │ ├── debug_pprof_goroutine.yml │ ├── debug_pprof_heap.yml │ ├── debug_pprof_mutex.yml │ ├── debug_pprof_profile.yml │ ├── debug_pprof_threadcreate.yml │ ├── debug_pprof_trace.yml │ ├── health.yml │ ├── metrics.yml │ ├── ready.yml │ ├── remotes.yml │ ├── remotes_remoteID.yml │ ├── replications.yml │ ├── replications_replicationID.yml │ ├── replications_replicationID_validate.yml │ ├── restore_bucketMetadata.yml │ ├── restore_bucket_bucketID.yml │ ├── restore_kv.yml │ ├── restore_shards_shardID.yml │ └── restore_sql.yml ├── schemas │ ├── BucketMetadataManifest.yml │ ├── BucketMetadataManifests.yml │ ├── BucketShardMapping.yml │ ├── BucketShardMappings.yml │ ├── Config.yml │ ├── MetadataBackup.yml │ ├── PostRestoreKVResponse.yml │ ├── RemoteConnection.yml │ ├── RemoteConnectionCreationRequest.yml │ ├── RemoteConnectionUpdateRequest.yml │ ├── RemoteConnections.yml │ ├── Replication.yml │ ├── ReplicationCreationRequest.yml │ ├── ReplicationUpdateRequest.yml │ ├── Replications.yml │ ├── Resource.yml │ ├── RestoredBucketMappings.yml │ ├── RetentionPolicyManifest.yml │ ├── RetentionPolicyManifests.yml │ ├── ShardGroupManifest.yml │ ├── ShardGroupManifests.yml │ ├── ShardManifest.yml │ ├── ShardManifests.yml │ ├── ShardOwner.yml │ ├── ShardOwners.yml │ ├── SubscriptionManifest.yml │ └── SubscriptionManifests.yml ├── tag-groups.yml └── tags.yml ├── quartz-oem.yml ├── quartz ├── paths │ ├── org.yml │ ├── orgLimits.yml │ ├── orgUsers.yml │ └── orgs.yml └── schemas │ ├── BucketLimits.yml │ ├── CheckLimits.yml │ ├── DashboardLimits.yml │ ├── IOxQueryLimits.yml │ ├── Limit.yml │ ├── NotificationEndpointLimits.yml │ ├── NotificationRuleLimits.yml │ ├── OEMInvitedEmail.yml │ ├── OEMInvitedError.yml │ ├── OEMInvitedResponse.yml │ ├── OrgLimits.yml │ ├── Organization.yml │ ├── OrganizationRequest.yml │ ├── OrganizationWithToken.yml │ ├── Organizations.yml │ ├── RateLimits.yml │ ├── RestrictedLimit.yml │ ├── StackLimits.yml │ ├── TaskLimits.yml │ ├── TimeoutLimits.yml │ ├── Unlimited.yml │ ├── User.yml │ └── Users.yml ├── svc-annotationd-oss.yml ├── svc-annotationd.yml ├── svc-fluxdocsd.yml ├── svc-invocable-scripts.yml ├── svc-mapsd.yml ├── svc-nifid.yml ├── svc-notebooksd.yml ├── svc-uiproxyd.yml ├── svc ├── README.md ├── annotationd-oss │ └── paths │ │ ├── annotations.yml │ │ └── streams.yml ├── annotationd │ ├── parameters │ │ ├── AnnotationDeleteFilter.yml │ │ ├── AnnotationListFilter.yml │ │ ├── StreamDeleteFilter.yml │ │ └── StreamListFilter.yml │ ├── paths │ │ ├── annotation.yml │ │ ├── annotations.yml │ │ ├── stream.yml │ │ └── streams.yml │ └── schemas │ │ ├── Annotation.yml │ │ ├── AnnotationCreate.yml │ │ ├── AnnotationCreateList.yml │ │ ├── AnnotationDeleteFilter.yml │ │ ├── AnnotationEvent.yml │ │ ├── AnnotationEventList.yml │ │ ├── AnnotationList.yml │ │ ├── AnnotationListFilter.yml │ │ ├── AnnotationResponse.yml │ │ ├── BasicFilter.yml │ │ ├── ReadStream.yml │ │ ├── Stream.yml │ │ ├── StreamDeleteFilter.yml │ │ ├── StreamList.yml │ │ └── StreamListFilter.yml ├── fluxdocsd │ ├── paths │ │ ├── fluxdocs.yml │ │ ├── fluxdocs_id.yml │ │ └── fluxdocs_search_searchTerm.yml │ ├── requestBodies │ │ └── FluxdocsParams.yml │ └── schemas │ │ ├── fluxdocs.yml │ │ ├── fluxdocsArray.yml │ │ └── fluxdocsParameters.yml ├── invocable-scripts │ ├── paths │ │ ├── scripts.yml │ │ ├── scripts_scriptID.yml │ │ ├── scripts_scriptID_invoke.yml │ │ └── scripts_scriptID_params.yml │ └── schemas │ │ ├── Params.yml │ │ ├── Script.yml │ │ ├── ScriptCreateRequest.yml │ │ ├── ScriptCreateResponse.yml │ │ ├── ScriptGetResponse.yml │ │ ├── ScriptHTTPResponseData.yml │ │ ├── ScriptInvocationParams.yml │ │ ├── ScriptInvokeResponse.yml │ │ ├── ScriptLanguage.yml │ │ ├── ScriptListResponse.yml │ │ ├── ScriptParamsResponse.yml │ │ ├── ScriptUpdateRequest.yml │ │ ├── ScriptUpdateResponse.yml │ │ └── Scripts.yml ├── mapsd │ ├── paths │ │ └── mapToken.yml │ └── schemas │ │ └── Token.yml ├── nifid │ ├── paths │ │ ├── broker_subs.yml │ │ ├── broker_subs_id.yml │ │ ├── broker_subs_id_status.yml │ │ └── broker_subs_status.yml │ ├── requestBodies │ │ ├── SubscriptionParams.yml │ │ └── SubscriptionRunStatus.yml │ └── schemas │ │ ├── JsonSpec.yml │ │ ├── StringObject.yml │ │ ├── Subscription.yml │ │ ├── SubscriptionArray.yml │ │ ├── SubscriptionParams.yml │ │ ├── SubscriptionRunStatus.yml │ │ ├── SubscriptionStatus.yml │ │ ├── SubscriptionStatusArray.yml │ │ └── Subscriptions.yml ├── notebooksd │ ├── paths │ │ ├── api_share_id.yml │ │ ├── api_share_id_query_pipeid.yml │ │ ├── notebooks.yml │ │ ├── notebooks_id.yml │ │ ├── notebooks_id_clone.yml │ │ ├── notebooks_id_versions.yml │ │ ├── notebooks_id_versions_id.yml │ │ ├── notebooks_share.yml │ │ └── notebooks_share_id.yml │ ├── requestBodies │ │ ├── NotebookParams.yml │ │ └── ShareParams.yml │ └── schemas │ │ ├── Notebook.yml │ │ ├── NotebookArray.yml │ │ ├── NotebookParams.yml │ │ ├── NotebookVersion.yml │ │ ├── Notebooks.yml │ │ ├── Share.yml │ │ ├── ShareParams.yml │ │ ├── Shares.yml │ │ ├── VersionHistories.yml │ │ └── VersionHistory.yml └── uiproxyd │ ├── paths │ ├── mapToken.yml │ ├── quartzLoginUrl.yml │ └── sfdcSupport.yml │ ├── requestBodies │ └── SFDCSupportParams.yml │ └── schemas │ ├── SFDCSupport.yml │ └── Token.yml ├── unity.yml └── unity ├── paths ├── account.yml ├── accounts.yml ├── accounts_accountId.yml ├── accounts_accountId_orgs.yml ├── accounts_accountId_orgs_default.yml ├── accounts_default.yml ├── allowances_org_create.yml ├── billing.yml ├── billing_contact.yml ├── billing_invoices.yml ├── billing_invoices_invoiceId.yml ├── billing_payment_method.yml ├── billing_start_date.yml ├── cancel.yml ├── checkout.yml ├── clusters.yml ├── identity.yml ├── marketplace.yml ├── operator_accounts.yml ├── operator_accounts_accountId.yml ├── operator_accounts_accountId_convert.yml ├── operator_accounts_accountId_entitlements.yml ├── operator_accounts_accountId_entitlements_entitlement_id.yml ├── operator_accounts_accountId_migrate_orgs_toAccountId.yml ├── operator_accounts_accountId_reactivate.yml ├── operator_orgs.yml ├── operator_orgs_orgId.yml ├── operator_orgs_orgId_limits.yml ├── operator_orgs_orgId_migrate_toAccountId.yml ├── operator_orgs_orgId_reactivate.yml ├── operator_providers.yml ├── orgs.yml ├── orgs_orgId.yml ├── orgs_orgId_invites.yml ├── orgs_orgId_invites_inviteId.yml ├── orgs_orgId_invites_inviteId_resend.yml ├── orgs_orgId_limits.yml ├── orgs_orgId_users.yml ├── orgs_orgId_users_userId.yml ├── payment_form.yml ├── settings_notifications.yml ├── sso.yml ├── usage_billing_stats.yml ├── usage_rate_limits.yml ├── usage_vector_name.yml ├── usage_vectors.yml └── users_userId.yml └── schemas ├── Account.yml ├── AccountType.yml ├── AccountUpdate.yml ├── AccountsDefaultRequest.yml ├── Allowance.yml ├── BillingContact.yml ├── BillingDate.yml ├── BillingInfo.yml ├── BillingNotifySettings.yml ├── CheckoutRequest.yml ├── Cluster.yml ├── Clusters.yml ├── CreditCardParams.yml ├── Entitlement.yml ├── Entitlements.yml ├── Identity.yml ├── IdentityAccount.yml ├── IdentityOrganization.yml ├── IdentityUser.yml ├── Invite.yml ├── Invites.yml ├── Invoice.yml ├── Invoices.yml ├── Marketplace.yml ├── MarketplaceSubscription.yml ├── MarketplaceType.yml ├── OperatorAccount.yml ├── OperatorAccountConvertRequest.yml ├── OperatorAccounts.yml ├── OperatorOrgLimits.yml ├── OperatorOrganization.yml ├── OperatorOrganizations.yml ├── OperatorProvider.yml ├── OperatorProviders.yml ├── OperatorProvidersResponse.yml ├── OperatorRateLimits.yml ├── OperatorRegion.yml ├── OperatorRegionInfo.yml ├── OperatorRegions.yml ├── OperatorUser.yml ├── OperatorUsers.yml ├── OrgUser.yml ├── OrgUsers.yml ├── Organization.yml ├── OrganizationCreateRequest.yml ├── OrganizationDefaultRequest.yml ├── OrganizationState.yml ├── OrganizationSummaries.yml ├── OrganizationSummary.yml ├── OrganizationUpdate.yml ├── OrganizationWithToken.yml ├── PaymentFormType.yml ├── PaymentMethod.yml ├── PaymentMethodPut.yml ├── Region.yml ├── RelatedAccount.yml ├── Role.yml ├── StorageType.yml ├── TimeRange.yml ├── UpgradeOption.yml ├── UsageVector.yml ├── UsageVectors.yml ├── User.yml ├── UserAccount.yml ├── UserAccounts.yml ├── UserPatchRequest.yml ├── Users.yml └── VectorName.yml /.gitattributes: -------------------------------------------------------------------------------- 1 | contracts/**/* linguist-generated=true 2 | contracts/swaggerV1Compat.yml linguist-generated=false 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ts/ 2 | .vscode 3 | .idea/ 4 | .prettierignore 5 | -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @influxdata/docs-team 2 | 3 | -------------------------------------------------------------------------------- /scripts/ci-oats.dockerfile: -------------------------------------------------------------------------------- 1 | FROM quay.io/influxdb/oats 2 | 3 | RUN apk add --no-cache git 4 | -------------------------------------------------------------------------------- /scripts/ci-swagger-cli.dockerfile: -------------------------------------------------------------------------------- 1 | FROM quay.io/influxdb/swagger-cli 2 | 3 | RUN apk add --no-cache git 4 | -------------------------------------------------------------------------------- /scripts/ci-swagrag.dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine 2 | 3 | RUN apk add --no-cache git 4 | 5 | COPY --from=docker.io/glinton/swagrag:0.2.0 /swagrag /bin/swagrag 6 | -------------------------------------------------------------------------------- /scripts/generate-svc.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | CONTRACTS=${CONTRACTS:-contracts} 4 | 5 | # generate svc contracts 6 | for i in $(ls -d ./src/svc/*/); do 7 | SERVICE=$(basename ${i}) 8 | swagger-cli bundle "src/svc-${SERVICE}.yml" --outfile "${CONTRACTS}/svc/${SERVICE}.yml" --type yaml 9 | done 10 | -------------------------------------------------------------------------------- /scripts/oats.dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:16-alpine 2 | 3 | WORKDIR /src 4 | RUN mkdir -p /src 5 | 6 | RUN yarn add prettier 7 | RUN yarn add @influxdata/oats 8 | 9 | ENTRYPOINT ["/bin/sh", "-c"] 10 | -------------------------------------------------------------------------------- /scripts/swagger-cli.dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:16-alpine 2 | 3 | RUN npm set progress=false && npm config set depth 0 4 | RUN npm install --only=production -g swagger-cli 5 | 6 | WORKDIR /openapi 7 | RUN mkdir -p /openapi 8 | -------------------------------------------------------------------------------- /scripts/test-openapi.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -e 4 | 5 | # How to run locally: 6 | # 7 | # docker run --rm -it -e CONTRACTS=/local/contracts -v "${PWD}:/local" openapitools/openapi-generator-cli /local/scripts/test-openapi.sh 8 | # 9 | 10 | CONTRACTS=${CONTRACTS:-openapi/contracts} 11 | 12 | /usr/local/bin/docker-entrypoint.sh validate -i "${CONTRACTS}/oss.yml" 13 | /usr/local/bin/docker-entrypoint.sh validate -i "${CONTRACTS}/cloud.yml" -------------------------------------------------------------------------------- /scripts/test.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | export TMP_DIR=/tmp/openapiTest 4 | export CUR_DIR=$(dirname "$0") 5 | export CONTRACTS=$TMP_DIR 6 | 7 | # aggregate contracts from simple definitions 8 | sh $CUR_DIR/generate.sh 9 | sh $CUR_DIR/generate-svc.sh 10 | 11 | # copy non-compiled contract and readme 12 | cp $(pwd)/contracts/swaggerV1Compat.yml $CONTRACTS/ 13 | cp $(pwd)/contracts/README.md $CONTRACTS/ 14 | cp -a $(pwd)/contracts/ref $CONTRACTS/ref 15 | 16 | diff -r $CONTRACTS $(pwd)/contracts 17 | if [ "$?" -ne "0" ]; then 18 | echo "err: aggregated contract mismatch" 19 | exit 1 20 | fi 21 | 22 | if [ ! -z "$STRICT" ]; then 23 | for contract in $(find ${CONTRACTS} -iname *.yml ); do 24 | echo "ensuring ${contract} contains valid swagger..." 25 | swagger-cli validate ${contract} 26 | done 27 | fi 28 | -------------------------------------------------------------------------------- /src/cloud/paths/flags.yml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Public Flags 4 | summary: Retrieve public/preauth feature flags 5 | responses: 6 | '200': 7 | description: Pre-authentication exposed feature flags 8 | content: 9 | application/json: 10 | schema: 11 | $ref: '../../common/schemas/Flags.yml' 12 | default: 13 | description: unexpected error 14 | $ref: '../../common/responses/ServerError.yml' 15 | -------------------------------------------------------------------------------- /src/cloud/paths/oauth_clientConfig.yml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - OAuth 4 | summary: Retrieve required OAuth client variables 5 | parameters: 6 | - in: query 7 | name: redirectTo 8 | schema: 9 | type: string 10 | description: optional parameter to redirect the user to after a successful login. 11 | required: false 12 | responses: 13 | '200': 14 | description: Required OAuth client variables 15 | content: 16 | application/json: 17 | schema: 18 | $ref: '../schemas/OAuthClientConfig.yml' 19 | default: 20 | description: unexpected error 21 | $ref: '../../common/responses/ServerError.yml' 22 | -------------------------------------------------------------------------------- /src/cloud/paths/orgs_orgID_limits_get.yml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Limits 4 | summary: Retrieve limits for an organization 5 | operationId: GetOrgLimitsID 6 | parameters: 7 | - in: path 8 | name: orgID 9 | description: The ID of the organization. 10 | required: true 11 | schema: 12 | type: string 13 | responses: 14 | '200': 15 | description: Limits defined for the organization. 16 | content: 17 | application/json: 18 | schema: 19 | $ref: "../schemas/LimitPublic.yml" 20 | default: 21 | description: unexpected error 22 | $ref: '../../common/responses/ServerError.yml' 23 | -------------------------------------------------------------------------------- /src/cloud/paths/orgs_orgID_limits_status.yml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Limits 4 | summary: Get current limit status for an org 5 | parameters: 6 | - in: path 7 | name: orgID 8 | schema: 9 | type: string 10 | required: true 11 | description: The identifier of the organization. 12 | responses: 13 | '200': 14 | description: Current limit status 15 | content: 16 | application/json: 17 | schema: 18 | $ref: "../schemas/LimitStatuses.yml" 19 | default: 20 | description: unexpected error 21 | $ref: '../../common/responses/ServerError.yml' 22 | -------------------------------------------------------------------------------- /src/cloud/paths/orgs_orgID_secrets_secretID.yml: -------------------------------------------------------------------------------- 1 | delete: 2 | operationId: DeleteOrgsIDSecretsID 3 | tags: 4 | - Secrets 5 | summary: Delete a secret from an organization 6 | parameters: 7 | - $ref: '../../common/parameters/TraceSpan.yml' 8 | - in: path 9 | name: orgID 10 | schema: 11 | type: string 12 | required: true 13 | description: The organization ID. 14 | - in: path 15 | name: secretID 16 | schema: 17 | type: string 18 | required: true 19 | description: The secret ID. 20 | responses: 21 | "204": 22 | description: Keys successfully deleted 23 | default: 24 | description: Unexpected error 25 | $ref: '../../common/responses/ServerError.yml' 26 | -------------------------------------------------------------------------------- /src/cloud/paths/setup_user.yml: -------------------------------------------------------------------------------- 1 | post: 2 | operationId: PostSetupUser 3 | tags: 4 | - Setup 5 | summary: Create a new user, organization, and bucket 6 | description: Post an onboarding request to create a new user, organization, and bucket. 7 | requestBody: 8 | description: Source to create 9 | required: true 10 | content: 11 | application/json: 12 | schema: 13 | $ref: "../schemas/OnboardingRequest.yml" 14 | responses: 15 | "201": 16 | description: The created default user, bucket, and organization. 17 | content: 18 | application/json: 19 | schema: 20 | $ref: "../schemas/OnboardingResponse.yml" 21 | default: 22 | description: Unexpected error 23 | $ref: "../../common/responses/ServerError.yml" 24 | -------------------------------------------------------------------------------- /src/cloud/schemas/ColumnDataType.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | enum: 3 | - integer 4 | - float 5 | - boolean 6 | - string 7 | - unsigned 8 | -------------------------------------------------------------------------------- /src/cloud/schemas/ColumnSemanticType.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | nullable: false 3 | enum: 4 | - timestamp 5 | - tag 6 | - field 7 | -------------------------------------------------------------------------------- /src/cloud/schemas/ForbiddenRequestError.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | code: 3 | description: returns error code 403 4 | readOnly: true 5 | type: string 6 | enum: 7 | - forbidden 8 | message: 9 | readOnly: true 10 | description: message is a human-readable message. 11 | type: string 12 | -------------------------------------------------------------------------------- /src/cloud/schemas/Identity.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: string 5 | name: 6 | type: string 7 | -------------------------------------------------------------------------------- /src/cloud/schemas/IdentityWithLinks.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: string 5 | name: 6 | type: string 7 | links: 8 | $ref: '../../common/schemas/Links.yml' 9 | -------------------------------------------------------------------------------- /src/cloud/schemas/InvalidRequestError.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | code: 3 | description: returns error code 400 4 | readOnly: true 5 | type: string 6 | enum: 7 | - invalid 8 | message: 9 | readOnly: true 10 | description: message is a human-readable message. 11 | type: string 12 | -------------------------------------------------------------------------------- /src/cloud/schemas/LimitEvent.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | orgID: 4 | type: string 5 | type: 6 | type: string 7 | enum: 8 | - limited_quota 9 | - limited_write 10 | - limited_query 11 | - limited_cardinality 12 | timestamp: 13 | readOnly: true 14 | type: string 15 | format: date-time 16 | -------------------------------------------------------------------------------- /src/cloud/schemas/LimitEvents.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | links: 4 | $ref: "../../common/schemas/Links.yml" 5 | events: 6 | type: array 7 | items: 8 | $ref: "./LimitEvent.yml" 9 | -------------------------------------------------------------------------------- /src/cloud/schemas/LimitPublic.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: These are org limits similar to those configured in/by quartz. 3 | properties: 4 | links: 5 | $ref: '../../common/schemas/Links.yml' 6 | limits: 7 | $ref: "./Limit.yml" 8 | -------------------------------------------------------------------------------- /src/cloud/schemas/LimitStatus.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: string 5 | enum: 6 | - ok 7 | - exceeded 8 | required: ['status'] 9 | -------------------------------------------------------------------------------- /src/cloud/schemas/LimitStatuses.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | read: 4 | $ref: './LimitStatus.yml' 5 | write: 6 | $ref: './LimitStatus.yml' 7 | cardinality: 8 | $ref: './LimitStatus.yml' 9 | required: ['read', 'write', 'cardinality'] 10 | -------------------------------------------------------------------------------- /src/cloud/schemas/MeasurementSchemaColumn.yml: -------------------------------------------------------------------------------- 1 | description: Definition of a measurement schema column. 2 | example: 3 | name: time 4 | type: integer 5 | format: unix timestamp 6 | type: object 7 | required: 8 | - name 9 | - type 10 | properties: 11 | name: 12 | type: string 13 | type: 14 | $ref: "./ColumnSemanticType.yml" 15 | dataType: 16 | $ref: "./ColumnDataType.yml" 17 | -------------------------------------------------------------------------------- /src/cloud/schemas/MeasurementSchemaUpdateRequest.yml: -------------------------------------------------------------------------------- 1 | description: Update an existing measurement schema 2 | type: object 3 | example: 4 | columns: 5 | - name: time 6 | type: integer 7 | format: unix timestamp 8 | - name: host 9 | type: tag 10 | - name: region 11 | type: tag 12 | - name: usage_user 13 | type: field 14 | dataType: float 15 | - name: usage_user 16 | type: field 17 | dataType: float 18 | required: ["columns"] 19 | properties: 20 | columns: 21 | description: >- 22 | An ordered collection of column definitions 23 | type: array 24 | items: 25 | $ref: './MeasurementSchemaColumn.yml' 26 | -------------------------------------------------------------------------------- /src/cloud/schemas/OAuthClientConfig.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | clientID: 4 | type: string 5 | domain: 6 | type: string 7 | format: uri 8 | redirectURL: 9 | type: string 10 | format: uri 11 | state: 12 | type: string 13 | required: ['clientID', 'domain', 'redirectURL', 'state'] 14 | -------------------------------------------------------------------------------- /src/cloud/schemas/OnboardingRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | username: 4 | type: string 5 | password: 6 | type: string 7 | org: 8 | type: string 9 | bucket: 10 | type: string 11 | retentionPeriodHrs: 12 | type: integer 13 | deprecated: true 14 | retentionPeriodSeconds: 15 | type: integer 16 | limit: 17 | $ref: "./Limit.yml" 18 | required: 19 | - username 20 | - org 21 | - bucket 22 | -------------------------------------------------------------------------------- /src/cloud/schemas/OnboardingResponse.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | user: 4 | $ref: "../../common/schemas/UserResponse.yml" 5 | org: 6 | $ref: "../../common/schemas/Organization.yml" 7 | bucket: 8 | $ref: "../../common/schemas/Bucket.yml" 9 | auth: 10 | $ref: "../../common/schemas/Authorization.yml" 11 | -------------------------------------------------------------------------------- /src/cloud/schemas/OrgConfig.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | bucket: 4 | type: string 5 | description: name of non system bucket 6 | retentionPeriodSeconds: 7 | type: integer 8 | description: retention period of non system bucket 9 | limit: 10 | $ref: "./Limit.yml" 11 | -------------------------------------------------------------------------------- /src/cloud/schemas/OrgSetting.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | key: 4 | type: string 5 | value: 6 | type: string 7 | -------------------------------------------------------------------------------- /src/cloud/schemas/OrgSettings.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | orgID: 4 | type: string 5 | description: The ID of the organization. 6 | settings: 7 | type: array 8 | items: 9 | $ref: "./OrgSetting.yml" 10 | -------------------------------------------------------------------------------- /src/cloud/schemas/OrganizationRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | username: 4 | type: string 5 | description: username of the Quartz user to be added in IDPE 6 | example: "user@email.com" 7 | org: 8 | type: string 9 | description: the name of the organization to be added 10 | limit: 11 | $ref: "./Limit.yml" 12 | retentionSeconds: 13 | type: integer 14 | description: length of time to retain data in seconds 15 | bucket: 16 | type: string 17 | description: the name of the bucket to be created 18 | -------------------------------------------------------------------------------- /src/cloud/schemas/OrganizationResponse.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | orgID: 4 | type: string 5 | description: The ID of the organization. 6 | userID: 7 | type: string 8 | description: The ID of the created user. 9 | -------------------------------------------------------------------------------- /src/cloud/schemas/ProvisionDeleteRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | orgID: 4 | type: string 5 | description: organization id to delete 6 | required: 7 | - orgID 8 | -------------------------------------------------------------------------------- /src/cloud/schemas/ProvisionRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | user: 4 | $ref: './Identity.yml' 5 | org: 6 | $ref: './Identity.yml' 7 | config: 8 | $ref: './OrgConfig.yml' 9 | returnToken: 10 | type: boolean 11 | description: if true will return the auth token in the response 12 | required: 13 | - user 14 | - org 15 | - config 16 | -------------------------------------------------------------------------------- /src/cloud/schemas/ProvisionResponse.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | user: 4 | $ref: './Identity.yml' 5 | org: 6 | $ref: './IdentityWithLinks.yml' 7 | token: 8 | type: string 9 | description: the token for the created user 10 | -------------------------------------------------------------------------------- /src/cloud/schemas/ProvisionSetupRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | user: 4 | $ref: './Identity.yml' 5 | org: 6 | $ref: './Identity.yml' 7 | required: 8 | - user 9 | - org 10 | -------------------------------------------------------------------------------- /src/cloud/schemas/ProvisionSetupResponse.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | token: 4 | type: string 5 | description: the token for the created user 6 | -------------------------------------------------------------------------------- /src/cloud/schemas/ProvisionSuspendRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | orgID: 4 | type: string 5 | description: organization id to suspend or unsuspend 6 | required: 7 | - orgID 8 | -------------------------------------------------------------------------------- /src/cloud/schemas/ProvisionUserDeleteRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | userID: 4 | type: string 5 | description: user id to delete 6 | orgID: 7 | type: string 8 | description: organization id the user should be deleted from 9 | newOwnerID: 10 | type: string 11 | description: user id of the owner that user-owned resources should be transferred to. should be omitted if not transferring resources. 12 | tokenOption: 13 | type: string 14 | enum: 15 | - transfer 16 | - delete 17 | default: transfer 18 | description: delete or transfer tokens 19 | taskOption: 20 | type: string 21 | enum: 22 | - transfer 23 | - delete 24 | default: transfer 25 | description: delete or transfer tasks 26 | required: 27 | - userID 28 | - orgID 29 | -------------------------------------------------------------------------------- /src/cloud/schemas/ProvisionUserRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | user: 4 | $ref: './Identity.yml' 5 | orgID: 6 | type: string 7 | description: organization id to add user to 8 | role: 9 | $ref: './Role.yml' 10 | required: 11 | - user 12 | - orgID 13 | - role 14 | -------------------------------------------------------------------------------- /src/cloud/schemas/ProvisionUserResponse.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | user: 4 | $ref: './Identity.yml' 5 | org: 6 | $ref: './Identity.yml' 7 | -------------------------------------------------------------------------------- /src/cloud/schemas/Role.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | description: Role of the User 3 | enum: 4 | - owner 5 | - member 6 | -------------------------------------------------------------------------------- /src/cloud/schemas/Tasks.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | links: 4 | readOnly: true 5 | $ref: "../../common/schemas/Links.yml" 6 | tasks: 7 | type: array 8 | items: 9 | $ref: "./Task.yml" 10 | -------------------------------------------------------------------------------- /src/cloud/schemas/User.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | readOnly: true 4 | type: string 5 | name: 6 | type: string 7 | status: 8 | description: If inactive the user is inactive. 9 | default: active 10 | type: string 11 | enum: 12 | - active 13 | - inactive 14 | role: 15 | type: string 16 | enum: 17 | - owner 18 | - member 19 | org_id: 20 | type: string 21 | required: [name] 22 | -------------------------------------------------------------------------------- /src/cloud/schemas/Users.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | links: 4 | type: object 5 | properties: 6 | self: 7 | type: string 8 | format: uri 9 | users: 10 | type: array 11 | items: 12 | $ref: "../../common/schemas/UserResponse.yml" 13 | -------------------------------------------------------------------------------- /src/cloud/tag-groups.yml: -------------------------------------------------------------------------------- 1 | x-tagGroups: 2 | - name: Overview 3 | tags: 4 | - Quick start 5 | - Authentication 6 | - Supported operations 7 | - Headers 8 | - Pagination 9 | - Response codes 10 | - name: Popular endpoints 11 | tags: 12 | - Data I/O endpoints 13 | - Security and access endpoints 14 | - System information endpoints 15 | - name: All endpoints 16 | tags: [] 17 | -------------------------------------------------------------------------------- /src/common.yml: -------------------------------------------------------------------------------- 1 | openapi: "3.0.0" 2 | info: 3 | title: Influx Common API 4 | version: 2.0.1 5 | license: 6 | name: MIT 7 | url: 'https://opensource.org/licenses/MIT' 8 | servers: 9 | - url: /api/v2 10 | paths: 11 | #REF_COMMON_PATHS 12 | components: 13 | parameters: 14 | #REF_COMMON_PARAMETERS 15 | schemas: 16 | #REF_COMMON_SCHEMAS 17 | responses: 18 | #REF_COMMON_RESPONSES 19 | -------------------------------------------------------------------------------- /src/common/_parameters.yml: -------------------------------------------------------------------------------- 1 | TraceSpan: 2 | $ref: "./common/parameters/TraceSpan.yml" 3 | Offset: 4 | $ref: "./common/parameters/Offset.yml" 5 | Limit: 6 | $ref: "./common/parameters/Limit.yml" 7 | Descending: 8 | $ref: "./common/parameters/Descending.yml" 9 | SortBy: 10 | $ref: "./common/parameters/SortBy.yml" 11 | After: 12 | $ref: "./common/parameters/After.yml" 13 | -------------------------------------------------------------------------------- /src/common/_responses.yml: -------------------------------------------------------------------------------- 1 | AuthorizationError: 2 | $ref: "./common/responses/AuthorizationError.yml" 3 | BadRequestError: 4 | $ref: "./common/responses/BadRequestError.yml" 5 | GeneralServerError: 6 | $ref: "./common/responses/ServerError.yml" 7 | InternalServerError: 8 | $ref: "./common/responses/InternalServerError.yml" 9 | ResourceNotFoundError: 10 | $ref: "./common/responses/ResourceNotFoundError.yml" 11 | -------------------------------------------------------------------------------- /src/common/parameters/After.yml: -------------------------------------------------------------------------------- 1 | in: query 2 | name: after 3 | required: false 4 | schema: 5 | type: string 6 | description: | 7 | A resource ID to seek from. 8 | Returns records created after the specified record; 9 | results don't include the specified record. 10 | 11 | Use `after` instead of the `offset` parameter. 12 | For more information about pagination parameters, see [Pagination]({{% INFLUXDB_DOCS_URL %}}/api/#tag/Pagination). 13 | -------------------------------------------------------------------------------- /src/common/parameters/Descending.yml: -------------------------------------------------------------------------------- 1 | in: query 2 | name: descending 3 | required: false 4 | schema: 5 | type: boolean 6 | default: false 7 | -------------------------------------------------------------------------------- /src/common/parameters/Limit.yml: -------------------------------------------------------------------------------- 1 | in: query 2 | name: limit 3 | required: false 4 | description: | 5 | Limits the number of records returned. Default is `20`. 6 | schema: 7 | type: integer 8 | minimum: 1 9 | maximum: 100 10 | default: 20 11 | -------------------------------------------------------------------------------- /src/common/parameters/Offset.yml: -------------------------------------------------------------------------------- 1 | in: query 2 | name: offset 3 | required: false 4 | description: | 5 | The offset for pagination. 6 | The number of records to skip. 7 | 8 | For more information about pagination parameters, see [Pagination]({{% INFLUXDB_DOCS_URL %}}/api/#tag/Pagination). 9 | schema: 10 | type: integer 11 | minimum: 0 12 | -------------------------------------------------------------------------------- /src/common/parameters/SortBy.yml: -------------------------------------------------------------------------------- 1 | in: query 2 | name: sortBy 3 | required: false 4 | schema: 5 | type: string 6 | -------------------------------------------------------------------------------- /src/common/parameters/TraceSpan.yml: -------------------------------------------------------------------------------- 1 | in: header 2 | name: Zap-Trace-Span 3 | description: OpenTracing span context 4 | example: 5 | trace_id: "1" 6 | span_id: "1" 7 | baggage: 8 | key: value 9 | required: false 10 | schema: 11 | type: string 12 | -------------------------------------------------------------------------------- /src/common/paths/dashboards_dashboardID_members_userID.yml: -------------------------------------------------------------------------------- 1 | delete: 2 | operationId: DeleteDashboardsIDMembersID 3 | tags: 4 | - Dashboards 5 | summary: Remove a member from a dashboard 6 | parameters: 7 | - $ref: "../parameters/TraceSpan.yml" 8 | - in: path 9 | name: userID 10 | schema: 11 | type: string 12 | required: true 13 | description: The ID of the member to remove. 14 | - in: path 15 | name: dashboardID 16 | schema: 17 | type: string 18 | required: true 19 | description: The dashboard ID. 20 | responses: 21 | "204": 22 | description: Member removed 23 | default: 24 | description: Unexpected error 25 | content: 26 | application/json: 27 | schema: 28 | $ref: "../schemas/Error.yml" 29 | -------------------------------------------------------------------------------- /src/common/paths/dashboards_dashboardID_owners_userID.yml: -------------------------------------------------------------------------------- 1 | delete: 2 | operationId: DeleteDashboardsIDOwnersID 3 | tags: 4 | - Dashboards 5 | summary: Remove an owner from a dashboard 6 | parameters: 7 | - $ref: "../parameters/TraceSpan.yml" 8 | - in: path 9 | name: userID 10 | schema: 11 | type: string 12 | required: true 13 | description: The ID of the owner to remove. 14 | - in: path 15 | name: dashboardID 16 | schema: 17 | type: string 18 | required: true 19 | description: The dashboard ID. 20 | responses: 21 | "204": 22 | description: Owner removed 23 | default: 24 | description: Unexpected error 25 | content: 26 | application/json: 27 | schema: 28 | $ref: "../schemas/Error.yml" 29 | -------------------------------------------------------------------------------- /src/common/paths/me.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetMe 3 | tags: 4 | - Users 5 | summary: Retrieve the currently authenticated user 6 | parameters: 7 | - $ref: "../parameters/TraceSpan.yml" 8 | responses: 9 | "200": 10 | description: Success. The response body contains the currently authenticated user. 11 | content: 12 | application/json: 13 | schema: 14 | $ref: "../schemas/UserResponse.yml" 15 | "401": 16 | $ref: "../responses/AuthorizationError.yml" 17 | "500": 18 | $ref: "../responses/InternalServerError.yml" 19 | default: 20 | $ref: "../responses/ServerError.yml" 21 | -------------------------------------------------------------------------------- /src/common/paths/orgs_orgID_secrets_secretID.yml: -------------------------------------------------------------------------------- 1 | delete: 2 | operationId: DeleteOrgsIDSecretsID 3 | tags: 4 | - Secrets 5 | - Security and access endpoints 6 | summary: Delete a secret from an organization 7 | parameters: 8 | - $ref: '../parameters/TraceSpan.yml' 9 | - in: path 10 | name: orgID 11 | schema: 12 | type: string 13 | required: true 14 | description: The organization ID. 15 | - in: path 16 | name: secretID 17 | schema: 18 | type: string 19 | required: true 20 | description: The secret ID. 21 | responses: 22 | "204": 23 | description: Keys successfully deleted 24 | default: 25 | description: Unexpected error 26 | $ref: '../responses/ServerError.yml' 27 | -------------------------------------------------------------------------------- /src/common/paths/resources.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetResources 3 | tags: 4 | - Resources 5 | - System information endpoints 6 | summary: List all known resources 7 | parameters: 8 | - $ref: "../parameters/TraceSpan.yml" 9 | responses: 10 | "200": 11 | description: All resources targets 12 | content: 13 | application/json: 14 | schema: 15 | $ref: "../schemas/Resources.yml" 16 | default: 17 | description: Internal server error 18 | content: 19 | application/json: 20 | schema: 21 | $ref: "../schemas/Error.yml" 22 | -------------------------------------------------------------------------------- /src/common/paths/scrapers_scraperTargetID_members_userID.yml: -------------------------------------------------------------------------------- 1 | delete: 2 | operationId: DeleteScrapersIDMembersID 3 | tags: ["Scraper Targets"] 4 | summary: Remove a member from a scraper target 5 | parameters: 6 | - $ref: "../parameters/TraceSpan.yml" 7 | - in: path 8 | name: userID 9 | schema: 10 | type: string 11 | required: true 12 | description: The ID of member to remove. 13 | - in: path 14 | name: scraperTargetID 15 | schema: 16 | type: string 17 | required: true 18 | description: The scraper target ID. 19 | responses: 20 | "204": 21 | description: Member removed 22 | default: 23 | description: Unexpected error 24 | content: 25 | application/json: 26 | schema: 27 | $ref: "../schemas/Error.yml" 28 | -------------------------------------------------------------------------------- /src/common/paths/scrapers_scraperTargetID_owners_userID.yml: -------------------------------------------------------------------------------- 1 | delete: 2 | operationId: DeleteScrapersIDOwnersID 3 | tags: ["Scraper Targets"] 4 | summary: Remove an owner from a scraper target 5 | parameters: 6 | - $ref: "../parameters/TraceSpan.yml" 7 | - in: path 8 | name: userID 9 | schema: 10 | type: string 11 | required: true 12 | description: The ID of owner to remove. 13 | - in: path 14 | name: scraperTargetID 15 | schema: 16 | type: string 17 | required: true 18 | description: The scraper target ID. 19 | responses: 20 | "204": 21 | description: Owner removed 22 | default: 23 | description: Unexpected error 24 | content: 25 | application/json: 26 | schema: 27 | $ref: "../schemas/Error.yml" 28 | -------------------------------------------------------------------------------- /src/common/paths/stacks_stack_id_uninstall.yml: -------------------------------------------------------------------------------- 1 | post: 2 | operationId: UninstallStack 3 | tags: 4 | - Templates 5 | summary: Uninstall a stack 6 | parameters: 7 | - in: path 8 | name: stack_id 9 | required: true 10 | schema: 11 | type: string 12 | description: The identifier of the stack. 13 | responses: 14 | "200": 15 | description: Returns the uninstalled stack. 16 | content: 17 | application/json: 18 | schema: 19 | $ref: "../schemas/Stack.yml" 20 | default: 21 | description: Unexpected error 22 | content: 23 | application/json: 24 | schema: 25 | $ref: "../schemas/Error.yml" 26 | -------------------------------------------------------------------------------- /src/common/paths/telegraf_plugins.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetTelegrafPlugins 3 | tags: ["Telegraf Plugins"] 4 | summary: List all Telegraf plugins 5 | parameters: 6 | - $ref: "../parameters/TraceSpan.yml" 7 | - in: query 8 | name: type 9 | description: The type of plugin desired. 10 | schema: 11 | type: string 12 | responses: 13 | "200": 14 | description: A list of Telegraf plugins. 15 | content: 16 | application/json: 17 | schema: 18 | $ref: "../schemas/TelegrafPlugins.yml" 19 | default: 20 | description: Unexpected error 21 | content: 22 | application/json: 23 | schema: 24 | $ref: "../schemas/Error.yml" 25 | -------------------------------------------------------------------------------- /src/common/paths/telegrafs_telegrafID_members_userID.yml: -------------------------------------------------------------------------------- 1 | delete: 2 | operationId: DeleteTelegrafsIDMembersID 3 | tags: 4 | - Telegrafs 5 | summary: Remove a member from a Telegraf config 6 | parameters: 7 | - $ref: "../parameters/TraceSpan.yml" 8 | - in: path 9 | name: userID 10 | schema: 11 | type: string 12 | required: true 13 | description: The ID of the member to remove. 14 | - in: path 15 | name: telegrafID 16 | schema: 17 | type: string 18 | required: true 19 | description: The Telegraf config ID. 20 | responses: 21 | "204": 22 | description: Member removed 23 | default: 24 | description: Unexpected error 25 | content: 26 | application/json: 27 | schema: 28 | $ref: "../schemas/Error.yml" 29 | -------------------------------------------------------------------------------- /src/common/paths/telegrafs_telegrafID_owners_userID.yml: -------------------------------------------------------------------------------- 1 | delete: 2 | operationId: DeleteTelegrafsIDOwnersID 3 | tags: 4 | - Telegrafs 5 | summary: Remove an owner from a Telegraf config 6 | parameters: 7 | - $ref: "../parameters/TraceSpan.yml" 8 | - in: path 9 | name: userID 10 | schema: 11 | type: string 12 | required: true 13 | description: The ID of the owner to remove. 14 | - in: path 15 | name: telegrafID 16 | schema: 17 | type: string 18 | required: true 19 | description: The Telegraf config ID. 20 | responses: 21 | "204": 22 | description: Owner removed 23 | default: 24 | description: Unexpected error 25 | content: 26 | application/json: 27 | schema: 28 | $ref: "../schemas/Error.yml" 29 | -------------------------------------------------------------------------------- /src/common/responses/AuthorizationError.yml: -------------------------------------------------------------------------------- 1 | # This represents the body of a 401 error from the server. 2 | description: | 3 | Unauthorized. The error may indicate one of the following: 4 | 5 | * The `Authorization: Token` header is missing or malformed. 6 | * The API token value is missing from the header. 7 | * The token doesn't have sufficient permissions to write to this organization and bucket. 8 | content: 9 | application/json: 10 | schema: 11 | $ref: "../../common/schemas/UnauthorizedRequestError.yml" 12 | examples: 13 | tokenNotAuthorized: 14 | summary: Token is not authorized to access a resource 15 | value: {"code":"unauthorized", "message":"unauthorized access"} 16 | -------------------------------------------------------------------------------- /src/common/responses/BadRequestError.yml: -------------------------------------------------------------------------------- 1 | # This represents the body of a 400 error from the server. 2 | description: | 3 | Bad request. 4 | The response body contains detail about the error. 5 | 6 | #### InfluxDB OSS 7 | 8 | - Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter. 9 | content: 10 | application/json: 11 | schema: 12 | $ref: "../schemas/Error.yml" 13 | examples: 14 | orgProvidedNotFound: 15 | summary: The org or orgID passed doesn't own the token passed in the header 16 | value: 17 | { 18 | "code":"invalid", 19 | "message":"failed to decode request body: organization not found" 20 | } 21 | -------------------------------------------------------------------------------- /src/common/responses/InternalServerError.yml: -------------------------------------------------------------------------------- 1 | # This represents the body of an 500 error. 2 | description: | 3 | Internal server error. 4 | The server encountered an unexpected situation. 5 | content: 6 | application/json: 7 | schema: 8 | $ref: "../schemas/Error.yml" 9 | -------------------------------------------------------------------------------- /src/common/responses/NoContent.yml: -------------------------------------------------------------------------------- 1 | description: No content 2 | -------------------------------------------------------------------------------- /src/common/responses/ServerError.yml: -------------------------------------------------------------------------------- 1 | # This represents the body of any non 2XX level response from the server. 2 | description: Non 2XX error response from server. 3 | content: 4 | application/json: 5 | schema: 6 | $ref: "../schemas/Error.yml" 7 | -------------------------------------------------------------------------------- /src/common/responses/example-responses/GetBucketsIDLabelsSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "links": { 4 | "self": "/api/v2/labels" 5 | }, 6 | "labels": [ 7 | { 8 | "id": "09cbd068e7ebb000", 9 | "orgID": INFLUX_ORG_ID, 10 | "name": "production_buckets" 11 | } 12 | ] 13 | } 14 | -------------------------------------------------------------------------------- /src/common/responses/example-responses/GetBucketsIDMembersSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "links": { 4 | "self": "/api/v2/buckets/37407e232b3911d8/members" 5 | }, 6 | "users": [ 7 | { 8 | "role": "member", 9 | "links": { 10 | "self": "/api/v2/users/791df274afd48a83" 11 | }, 12 | "id": "791df274afd48a83", 13 | "name": "example_user_1", 14 | "status": "active" 15 | }, 16 | { 17 | "role": "owner", 18 | "links": { 19 | "self": "/api/v2/users/09cfb87051cbe000" 20 | }, 21 | "id": "09cfb87051cbe000", 22 | "name": "example_user_2", 23 | "status": "active" 24 | } 25 | ] 26 | } 27 | -------------------------------------------------------------------------------- /src/common/responses/example-responses/GetBucketsIDOwnersSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "links": { 4 | "self": "/api/v2/buckets/BUCKET_ID/owners" 5 | }, 6 | "users": [ 7 | { 8 | "role": "owner", 9 | "links": { 10 | "self": "/api/v2/users/d88d182d91b0950f" 11 | }, 12 | "id": "d88d182d91b0950f", 13 | "name": "example-owner", 14 | "status": "active" 15 | } 16 | ] 17 | } 18 | -------------------------------------------------------------------------------- /src/common/responses/example-responses/GetDBRPsIDSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "content": { 4 | "id": "0a3cbb5dd526a000", 5 | "database": "example_database_1", 6 | "retention_policy": "autogen", 7 | "default": true, 8 | "orgID": "bea7ea952287f70d", 9 | "bucketID": "4d4d9d5b61dee751" 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /src/common/responses/example-responses/GetDBRPsSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "content": [ 4 | { 5 | "id": "0a3cbb5dd526a000", 6 | "database": "example_database_1", 7 | "retention_policy": "autogen", 8 | "default": true, 9 | "orgID": "bea7ea952287f70d", 10 | "bucketID": "4d4d9d5b61dee751" 11 | }, 12 | { 13 | "id": "0a3cbcde20e38000", 14 | "database": "example_database_2", 15 | "retention_policy": "example_retention_policy", 16 | "default": false, 17 | "orgID": "bea7ea952287f70d", 18 | "bucketID": "4d4d9d5b61dee751" 19 | } 20 | ] 21 | } 22 | -------------------------------------------------------------------------------- /src/common/responses/example-responses/GetOrgsIDMembersSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "links": { 4 | "self": "/api/v2/orgs/055aa4783aa38398/members" 5 | }, 6 | "users": [ 7 | { 8 | "role": "member", 9 | "links": { 10 | "self": "/api/v2/users/791df274afd48a83" 11 | }, 12 | "id": "791df274afd48a83", 13 | "name": "example_user_1", 14 | "status": "active" 15 | }, 16 | { 17 | "role": "owner", 18 | "links": { 19 | "self": "/api/v2/users/09cfb87051cbe000" 20 | }, 21 | "id": "09cfb87051cbe000", 22 | "name": "example_user_2", 23 | "status": "active" 24 | } 25 | ] 26 | } 27 | -------------------------------------------------------------------------------- /src/common/responses/example-responses/GetOrgsIDOwnersSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "links": { 4 | "self": "/api/v2/orgs/055aa4783aa38398/owners" 5 | }, 6 | "users": [ 7 | { 8 | "role": "owner", 9 | "links": { 10 | "self": "/api/v2/users/09cfb87051cbe000" 11 | }, 12 | "id": "09cfb87051cbe000", 13 | "name": "example_user_2", 14 | "status": "active" 15 | } 16 | ] 17 | } 18 | -------------------------------------------------------------------------------- /src/common/responses/example-responses/PatchDBRPIDSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "content": { 4 | "id": "0a3cbb5dd526a000", 5 | "database": "example_database", 6 | "retention_policy": "example_retention_policy", 7 | "default": false, 8 | "orgID": "bea7ea952287f70d", 9 | "bucketID": "4d4d9d5b61dee751" 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /src/common/responses/example-responses/PostBucketsIDLabelsSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "links": { 4 | "self": "/api/v2/labels" 5 | }, 6 | "label": { 7 | "id": "09cbd068e7ebb000", 8 | "orgID": INFLUX_ORG_ID, 9 | "name": "production_buckets" 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /src/common/responses/example-responses/PostBucketsIDMembersSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "role": "member", 4 | "links": { 5 | "self": "/api/v2/users/09cfb87051cbe000" 6 | }, 7 | "id": "09cfb87051cbe000", 8 | "name": "example_user_1", 9 | "status": "active" 10 | } 11 | -------------------------------------------------------------------------------- /src/common/responses/example-responses/PostBucketsIDOwnersSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "role": "owner", 4 | "links": { 5 | "self": "/api/v2/users/d88d182d91b0950f" 6 | }, 7 | "id": "d88d182d91b0950f", 8 | "name": "example-user", 9 | "status": "active" 10 | } 11 | -------------------------------------------------------------------------------- /src/common/responses/example-responses/PostDBRPSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "id": "0a3cbb5dd526a000", 4 | "database": "example_database", 5 | "retention_policy": "autogen", 6 | "default": true, 7 | "orgID": "bea7ea952287f70d", 8 | "bucketID": "4d4d9d5b61dee751" 9 | } 10 | -------------------------------------------------------------------------------- /src/common/responses/example-responses/PostOrgsIDMembersSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "role": "member", 4 | "links": { 5 | "self": "/api/v2/users/09cfb87051cbe000" 6 | }, 7 | "id": "09cfb87051cbe000", 8 | "name": "example_user_1", 9 | "status": "active" 10 | } 11 | -------------------------------------------------------------------------------- /src/common/responses/example-responses/PostOrgsIDOwnersSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "role": "owner", 4 | "links": { 5 | "self": "/api/v2/users/09cfb87051cbe000" 6 | }, 7 | "id": "09cfb87051cbe000", 8 | "name": "example_user_1", 9 | "status": "active" 10 | } 11 | -------------------------------------------------------------------------------- /src/common/schemas/ASTResponse.yml: -------------------------------------------------------------------------------- 1 | description: Contains the AST for the supplied Flux query 2 | type: object 3 | properties: 4 | ast: 5 | $ref: "./Package.yml" 6 | -------------------------------------------------------------------------------- /src/common/schemas/AddResourceMemberRequestBody.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: string 5 | description: | 6 | The ID of the user to add to the resource. 7 | name: 8 | type: string 9 | description: | 10 | The name of the user to add to the resource. 11 | required: 12 | - id 13 | -------------------------------------------------------------------------------- /src/common/schemas/AnalyzeQueryResponse.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | errors: 4 | type: array 5 | items: 6 | type: object 7 | properties: 8 | line: 9 | type: integer 10 | column: 11 | type: integer 12 | character: 13 | type: integer 14 | message: 15 | type: string 16 | -------------------------------------------------------------------------------- /src/common/schemas/ArrayExpression.yml: -------------------------------------------------------------------------------- 1 | description: Used to create and directly specify the elements of an array object 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | elements: 7 | description: Elements of the array 8 | type: array 9 | items: 10 | $ref: "./Expression.yml" 11 | -------------------------------------------------------------------------------- /src/common/schemas/AuthorizationUpdateRequest.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | status: 3 | description: Status of the token. If `inactive`, InfluxDB rejects requests that use the token. 4 | default: active 5 | type: string 6 | enum: 7 | - active 8 | - inactive 9 | description: 10 | type: string 11 | description: A description of the token. 12 | -------------------------------------------------------------------------------- /src/common/schemas/Authorizations.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | links: 4 | readOnly: true 5 | $ref: "./Links.yml" 6 | authorizations: 7 | type: array 8 | items: 9 | $ref: "./Authorization.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/Axes.yml: -------------------------------------------------------------------------------- 1 | description: The viewport for a View's visualizations 2 | type: object 3 | required: ["x", "y"] 4 | properties: 5 | x: 6 | $ref: "./Axis.yml" 7 | "y": # Quoted to prevent YAML parser from interpreting y as shorthand for true. 8 | $ref: "./Axis.yml" 9 | -------------------------------------------------------------------------------- /src/common/schemas/AxisScale.yml: -------------------------------------------------------------------------------- 1 | description: 'Scale is the axis formatting scale. Supported: "log", "linear"' 2 | type: string 3 | enum: ["log", "linear"] 4 | -------------------------------------------------------------------------------- /src/common/schemas/BadStatement.yml: -------------------------------------------------------------------------------- 1 | description: A placeholder for statements for which no correct statement nodes can be created 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | text: 7 | description: Raw source text 8 | type: string 9 | -------------------------------------------------------------------------------- /src/common/schemas/BinaryExpression.yml: -------------------------------------------------------------------------------- 1 | description: uses binary operators to act on two operands in an expression 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | operator: 7 | type: string 8 | left: 9 | $ref: "./Expression.yml" 10 | right: 11 | $ref: "./Expression.yml" 12 | -------------------------------------------------------------------------------- /src/common/schemas/Block.yml: -------------------------------------------------------------------------------- 1 | description: A set of statements 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | body: 7 | description: Block body 8 | type: array 9 | items: 10 | $ref: "./Statement.yml" 11 | -------------------------------------------------------------------------------- /src/common/schemas/BooleanLiteral.yml: -------------------------------------------------------------------------------- 1 | description: Represents boolean values 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | value: 7 | type: boolean 8 | -------------------------------------------------------------------------------- /src/common/schemas/Buckets.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | links: 4 | readOnly: true 5 | $ref: "./Links.yml" 6 | buckets: 7 | type: array 8 | items: 9 | $ref: "./Bucket.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/BuilderAggregateFunctionType.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | enum: ["filter", "group"] 3 | -------------------------------------------------------------------------------- /src/common/schemas/BuilderConfig.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | buckets: 4 | type: array 5 | items: 6 | type: string 7 | tags: 8 | type: array 9 | items: 10 | $ref: "./BuilderTagsType.yml" 11 | functions: 12 | type: array 13 | items: 14 | $ref: "./BuilderFunctionsType.yml" 15 | aggregateWindow: 16 | type: object 17 | properties: 18 | period: 19 | type: string 20 | fillValues: 21 | type: boolean 22 | -------------------------------------------------------------------------------- /src/common/schemas/BuilderFunctionsType.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | -------------------------------------------------------------------------------- /src/common/schemas/BuilderTagsType.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | key: 4 | type: string 5 | values: 6 | type: array 7 | items: 8 | type: string 9 | aggregateFunctionType: 10 | $ref: "./BuilderAggregateFunctionType.yml" 11 | -------------------------------------------------------------------------------- /src/common/schemas/BuiltinStatement.yml: -------------------------------------------------------------------------------- 1 | description: Declares a builtin identifier and its type 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | id: 7 | $ref: "./Identifier.yml" 8 | -------------------------------------------------------------------------------- /src/common/schemas/CallExpression.yml: -------------------------------------------------------------------------------- 1 | description: Represents a function call 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | callee: 7 | $ref: "./Expression.yml" 8 | arguments: 9 | description: Function arguments 10 | type: array 11 | items: 12 | $ref: "./Expression.yml" 13 | -------------------------------------------------------------------------------- /src/common/schemas/Cell.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: string 5 | links: 6 | type: object 7 | properties: 8 | self: 9 | type: string 10 | view: 11 | type: string 12 | x: 13 | type: integer 14 | format: int32 15 | "y": # Quoted to prevent YAML parser from interpreting y as shorthand for true. 16 | type: integer 17 | format: int32 18 | w: 19 | type: integer 20 | format: int32 21 | h: 22 | type: integer 23 | format: int32 24 | viewID: 25 | type: string 26 | description: The reference to a view from the views API. 27 | -------------------------------------------------------------------------------- /src/common/schemas/CellUpdate.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | x: 4 | type: integer 5 | format: int32 6 | "y": # Quoted to prevent YAML parser from interpreting y as shorthand for true. 7 | type: integer 8 | format: int32 9 | w: 10 | type: integer 11 | format: int32 12 | h: 13 | type: integer 14 | format: int32 15 | -------------------------------------------------------------------------------- /src/common/schemas/CellWithViewProperties.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | allOf: 3 | - $ref: "./Cell.yml" 4 | - type: object 5 | properties: 6 | name: 7 | type: string 8 | properties: 9 | $ref: "./ViewProperties.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/Cells.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "./Cell.yml" 4 | -------------------------------------------------------------------------------- /src/common/schemas/CellsWithViewProperties.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "./CellWithViewProperties.yml" 4 | -------------------------------------------------------------------------------- /src/common/schemas/Check.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./CheckDiscriminator.yml" 3 | -------------------------------------------------------------------------------- /src/common/schemas/CheckDiscriminator.yml: -------------------------------------------------------------------------------- 1 | oneOf: 2 | - $ref: "./DeadmanCheck.yml" 3 | - $ref: "./ThresholdCheck.yml" 4 | - $ref: "./CustomCheck.yml" 5 | discriminator: 6 | propertyName: type 7 | mapping: 8 | deadman: "#/components/schemas/DeadmanCheck" 9 | threshold: "#/components/schemas/ThresholdCheck" 10 | custom: "#/components/schemas/CustomCheck" 11 | -------------------------------------------------------------------------------- /src/common/schemas/CheckPatch.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | description: 6 | type: string 7 | status: 8 | type: string 9 | enum: 10 | - active 11 | - inactive 12 | -------------------------------------------------------------------------------- /src/common/schemas/CheckStatusLevel.yml: -------------------------------------------------------------------------------- 1 | description: The state to record if check matches a criteria. 2 | type: string 3 | enum: ["UNKNOWN", "OK", "INFO", "CRIT", "WARN"] 4 | -------------------------------------------------------------------------------- /src/common/schemas/Checks.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | checks: 3 | type: array 4 | items: 5 | $ref: "./Check.yml" 6 | links: 7 | $ref: "./Links.yml" 8 | -------------------------------------------------------------------------------- /src/common/schemas/ColorMapping.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads. 3 | additionalProperties: 4 | type: string 5 | example: 6 | series_id_1: "#edf529" 7 | series_id_2: "#edf529" 8 | measurement_birdmigration_europe: "#663cd0" 9 | configcat_deployments-autopromotionblocker: "#663cd0" 10 | -------------------------------------------------------------------------------- /src/common/schemas/ConditionalExpression.yml: -------------------------------------------------------------------------------- 1 | description: Selects one of two expressions, `Alternate` or `Consequent`, depending on a third boolean expression, `Test` 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | test: 7 | $ref: "./Expression.yml" 8 | alternate: 9 | $ref: "./Expression.yml" 10 | consequent: 11 | $ref: "./Expression.yml" 12 | -------------------------------------------------------------------------------- /src/common/schemas/ConstantVariableProperties.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | type: 3 | type: string 4 | enum: [constant] 5 | values: 6 | type: array 7 | items: 8 | type: string 9 | -------------------------------------------------------------------------------- /src/common/schemas/CreateCell.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | x: 6 | type: integer 7 | format: int32 8 | "y": # Quoted to prevent YAML parser from interpreting y as shorthand for true. 9 | type: integer 10 | format: int32 11 | w: 12 | type: integer 13 | format: int32 14 | h: 15 | type: integer 16 | format: int32 17 | usingView: 18 | type: string 19 | description: Makes a copy of the provided view. 20 | -------------------------------------------------------------------------------- /src/common/schemas/CreateDashboardRequest.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | orgID: 3 | type: string 4 | description: The ID of the organization that owns the dashboard. 5 | name: 6 | type: string 7 | description: The user-facing name of the dashboard. 8 | description: 9 | type: string 10 | description: The user-facing description of the dashboard. 11 | required: 12 | - orgID 13 | - name 14 | -------------------------------------------------------------------------------- /src/common/schemas/CustomCheck.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./CheckBase.yml" 3 | - type: object 4 | properties: 5 | type: 6 | type: string 7 | enum: [custom] 8 | required: [type] 9 | -------------------------------------------------------------------------------- /src/common/schemas/DBRPGet.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | content: 4 | $ref: "./DBRP.yml" 5 | required: true 6 | -------------------------------------------------------------------------------- /src/common/schemas/DBRPUpdate.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | retention_policy: 3 | type: string 4 | description: | 5 | A [retention policy](https://docs.influxdata.com/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. 6 | Identifies the InfluxDB v1 retention policy mapping. 7 | default: 8 | type: boolean 9 | description: | 10 | Set to `true` to use this DBRP mapping as the default retention policy 11 | for the database (specified by the `database` property's value). 12 | To remove the default mapping, set to `false`. 13 | -------------------------------------------------------------------------------- /src/common/schemas/DBRPs.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | content: 3 | type: array 4 | items: 5 | $ref: "./DBRP.yml" 6 | -------------------------------------------------------------------------------- /src/common/schemas/DashboardQuery.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | text: 4 | type: string 5 | description: The text of the Flux query. 6 | editMode: 7 | $ref: "./QueryEditMode.yml" 8 | name: 9 | type: string 10 | builderConfig: 11 | $ref: "./BuilderConfig.yml" 12 | -------------------------------------------------------------------------------- /src/common/schemas/Dashboards.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | links: 4 | $ref: "./Links.yml" 5 | dashboards: 6 | type: array 7 | items: 8 | $ref: "./Dashboard.yml" 9 | -------------------------------------------------------------------------------- /src/common/schemas/DateTimeLiteral.yml: -------------------------------------------------------------------------------- 1 | description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#rfc3339nano-timestamp). 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | value: 7 | type: string 8 | format: date-time 9 | -------------------------------------------------------------------------------- /src/common/schemas/DecimalPlaces.yml: -------------------------------------------------------------------------------- 1 | description: Indicates whether decimal places should be enforced, and how many digits it should show. 2 | type: object 3 | properties: 4 | isEnforced: 5 | description: Indicates whether decimal point setting should be enforced 6 | type: boolean 7 | digits: 8 | description: The number of digits after decimal to display 9 | type: integer 10 | format: int32 11 | -------------------------------------------------------------------------------- /src/common/schemas/DictExpression.yml: -------------------------------------------------------------------------------- 1 | description: Used to create and directly specify the elements of a dictionary 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | elements: 7 | description: Elements of the dictionary 8 | type: array 9 | items: 10 | $ref: "./DictItem.yml" 11 | -------------------------------------------------------------------------------- /src/common/schemas/DictItem.yml: -------------------------------------------------------------------------------- 1 | description: A key-value pair in a dictionary. 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | key: 7 | $ref: "./Expression.yml" 8 | val: 9 | $ref: "./Expression.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/Duration.yml: -------------------------------------------------------------------------------- 1 | description: A pair consisting of length of time and the unit of time measured. It is the atomic unit from which all duration literals are composed. 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | magnitude: 7 | type: integer 8 | unit: 9 | type: string 10 | -------------------------------------------------------------------------------- /src/common/schemas/DurationLiteral.yml: -------------------------------------------------------------------------------- 1 | description: Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang's time.Duration 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | values: 7 | description: Duration values 8 | type: array 9 | items: 10 | $ref: "./Duration.yml" 11 | -------------------------------------------------------------------------------- /src/common/schemas/Error.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | code: 3 | $ref: "./ErrorCode.yml" 4 | message: 5 | readOnly: true 6 | description: Human-readable message. 7 | type: string 8 | op: 9 | readOnly: true 10 | description: Describes the logical code operation when the error occurred. Useful for debugging. 11 | type: string 12 | err: 13 | readOnly: true 14 | description: Stack of errors that occurred during processing of the request. Useful for debugging. 15 | type: string 16 | required: 17 | - code 18 | -------------------------------------------------------------------------------- /src/common/schemas/ErrorCode.yml: -------------------------------------------------------------------------------- 1 | description: code is the machine-readable error code. 2 | readOnly: true 3 | type: string 4 | # This set of enumerations must remain in sync with the constants defined in errors.go 5 | enum: 6 | - internal error 7 | - not implemented 8 | - not found 9 | - conflict 10 | - invalid 11 | - unprocessable entity 12 | - empty value 13 | - unavailable 14 | - forbidden 15 | - too many requests 16 | - unauthorized 17 | - method not allowed 18 | - request too large 19 | - unsupported media type 20 | -------------------------------------------------------------------------------- /src/common/schemas/ExpressionStatement.yml: -------------------------------------------------------------------------------- 1 | description: May consist of an expression that doesn't return a value and is executed solely for its side-effects 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | expression: 7 | $ref: "./Expression.yml" 8 | -------------------------------------------------------------------------------- /src/common/schemas/File.yml: -------------------------------------------------------------------------------- 1 | description: Represents a source from a single file 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | name: 7 | description: The name of the file. 8 | type: string 9 | package: 10 | $ref: "./PackageClause.yml" 11 | imports: 12 | description: A list of package imports 13 | type: array 14 | items: 15 | $ref: "./ImportDeclaration.yml" 16 | body: 17 | description: List of Flux statements 18 | type: array 19 | items: 20 | $ref: "./Statement.yml" 21 | -------------------------------------------------------------------------------- /src/common/schemas/Flags.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | additionalProperties: true 3 | -------------------------------------------------------------------------------- /src/common/schemas/FloatLiteral.yml: -------------------------------------------------------------------------------- 1 | description: Represents floating point numbers according to the double representations defined by the IEEE-754-1985 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | value: 7 | type: number 8 | -------------------------------------------------------------------------------- /src/common/schemas/FluxResponse.yml: -------------------------------------------------------------------------------- 1 | description: Rendered flux that backs the check or notification. 2 | properties: 3 | flux: 4 | type: string 5 | -------------------------------------------------------------------------------- /src/common/schemas/FluxSuggestion.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | params: 6 | type: object 7 | additionalProperties: 8 | type: string 9 | -------------------------------------------------------------------------------- /src/common/schemas/FluxSuggestions.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | funcs: 4 | type: array 5 | items: 6 | $ref: "./FluxSuggestion.yml" 7 | -------------------------------------------------------------------------------- /src/common/schemas/FunctionExpression.yml: -------------------------------------------------------------------------------- 1 | description: Function expression 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | params: 7 | description: Function parameters 8 | type: array 9 | items: 10 | $ref: "./Property.yml" 11 | body: 12 | $ref: "./Node.yml" 13 | -------------------------------------------------------------------------------- /src/common/schemas/GeoHeatMapViewLayer.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./GeoViewLayerProperties.yml" 3 | - type: object 4 | required: [intensityField, intensityDimension, radius, blur, colors] 5 | properties: 6 | intensityField: 7 | type: string 8 | description: Intensity field 9 | intensityDimension: 10 | $ref: './Axis.yml' 11 | radius: 12 | description: Radius size in pixels 13 | type: integer 14 | blur: 15 | description: Blur for heatmap points 16 | type: integer 17 | colors: 18 | description: Colors define color encoding of data into a visualization 19 | type: array 20 | items: 21 | $ref: "./DashboardColor.yml" 22 | -------------------------------------------------------------------------------- /src/common/schemas/GeoTrackMapViewLayer.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./GeoViewLayerProperties.yml" 3 | - type: object 4 | required: [trackWidth, speed, randomColors, trackPointVisualization] 5 | properties: 6 | trackWidth: 7 | description: Width of the track 8 | type: integer 9 | speed: 10 | description: Speed of the track animation 11 | type: integer 12 | randomColors: 13 | description: Assign different colors to different tracks 14 | type: boolean 15 | colors: 16 | description: Colors define color encoding of data into a visualization 17 | type: array 18 | items: 19 | $ref: "./DashboardColor.yml" 20 | -------------------------------------------------------------------------------- /src/common/schemas/GeoViewLayer.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | oneOf: 3 | - $ref: "./GeoCircleViewLayer.yml" 4 | - $ref: "./GeoHeatMapViewLayer.yml" 5 | - $ref: "./GeoPointMapViewLayer.yml" 6 | - $ref: "./GeoTrackMapViewLayer.yml" 7 | -------------------------------------------------------------------------------- /src/common/schemas/GeoViewLayerProperties.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: [type] 3 | properties: 4 | type: 5 | type: string 6 | enum: [heatmap, circleMap, pointMap, trackMap] 7 | -------------------------------------------------------------------------------- /src/common/schemas/GreaterThreshold.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./ThresholdBase.yml" 3 | - type: object 4 | required: [type, value] 5 | properties: 6 | type: 7 | type: string 8 | enum: [greater] 9 | value: 10 | type: number 11 | format: float 12 | -------------------------------------------------------------------------------- /src/common/schemas/HTTPNotificationEndpoint.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | allOf: 3 | - $ref: "./NotificationEndpointBase.yml" 4 | - type: object 5 | required: [url, authMethod, method] 6 | properties: 7 | url: 8 | type: string 9 | username: 10 | type: string 11 | password: 12 | type: string 13 | token: 14 | type: string 15 | method: 16 | type: string 17 | enum: ["POST", "GET", "PUT"] 18 | authMethod: 19 | type: string 20 | enum: ["none", "basic", "bearer"] 21 | contentTemplate: 22 | type: string 23 | headers: 24 | type: object 25 | description: Customized headers. 26 | additionalProperties: 27 | type: string 28 | -------------------------------------------------------------------------------- /src/common/schemas/HTTPNotificationRule.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./NotificationRuleBase.yml" 3 | - $ref: "./HTTPNotificationRuleBase.yml" 4 | -------------------------------------------------------------------------------- /src/common/schemas/HTTPNotificationRuleBase.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: [type] 3 | properties: 4 | type: 5 | type: string 6 | enum: [http] 7 | url: 8 | type: string 9 | -------------------------------------------------------------------------------- /src/common/schemas/HealthCheck.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - name 4 | - status 5 | properties: 6 | name: 7 | type: string 8 | message: 9 | type: string 10 | checks: 11 | type: array 12 | items: 13 | $ref: "./HealthCheck.yml" 14 | status: 15 | $ref: "./HealthCheckStatus.yml" 16 | version: 17 | type: string 18 | commit: 19 | type: string 20 | -------------------------------------------------------------------------------- /src/common/schemas/HealthCheckStatus.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | enum: 3 | - pass 4 | - fail 5 | -------------------------------------------------------------------------------- /src/common/schemas/Identifier.yml: -------------------------------------------------------------------------------- 1 | description: A valid Flux identifier 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | name: 7 | type: string 8 | -------------------------------------------------------------------------------- /src/common/schemas/ImportDeclaration.yml: -------------------------------------------------------------------------------- 1 | description: Declares a package import 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | as: 7 | $ref: "./Identifier.yml" 8 | path: 9 | $ref: "./StringLiteral.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/IndexExpression.yml: -------------------------------------------------------------------------------- 1 | description: Represents indexing into an array 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | array: 7 | $ref: "./Expression.yml" 8 | index: 9 | $ref: "./Expression.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/InfluxQLQuery.yml: -------------------------------------------------------------------------------- 1 | description: Query influx using the InfluxQL language 2 | type: object 3 | required: 4 | - query 5 | properties: 6 | query: 7 | description: InfluxQL query execute. 8 | type: string 9 | type: 10 | description: The type of query. Must be "influxql". 11 | type: string 12 | enum: 13 | - influxql 14 | bucket: 15 | description: Bucket is to be used instead of the database and retention policy specified in the InfluxQL query. 16 | type: string 17 | -------------------------------------------------------------------------------- /src/common/schemas/IntegerLiteral.yml: -------------------------------------------------------------------------------- 1 | description: Represents integer numbers 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | value: 7 | type: string 8 | -------------------------------------------------------------------------------- /src/common/schemas/IsOnboarding.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | allowed: 4 | description: | 5 | If `true`, the InfluxDB instance hasn't had initial setup; 6 | `false` otherwise. 7 | type: boolean 8 | -------------------------------------------------------------------------------- /src/common/schemas/Label.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | readOnly: true 5 | type: string 6 | orgID: 7 | readOnly: true 8 | type: string 9 | name: 10 | type: string 11 | properties: 12 | type: object 13 | additionalProperties: 14 | type: string 15 | description: | 16 | Key-value pairs associated with this label. 17 | To remove a property, send an update with an empty value (`""`) for the key. 18 | example: { "color": "ffb3b3", "description": "this is a description" } 19 | -------------------------------------------------------------------------------- /src/common/schemas/LabelCreateRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: [orgID, name] 3 | properties: 4 | orgID: 5 | type: string 6 | name: 7 | type: string 8 | properties: 9 | type: object 10 | additionalProperties: 11 | type: string 12 | description: | 13 | Key-value pairs associated with this label. 14 | 15 | To remove a property, send an update with an empty value (`""`) for the key. 16 | example: { "color": "ffb3b3", "description": "this is a description" } 17 | -------------------------------------------------------------------------------- /src/common/schemas/LabelMapping.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: A _label mapping_ contains a `label` ID to attach to a resource. 3 | properties: 4 | labelID: 5 | description: | 6 | A label ID. 7 | Specifies the label to attach. 8 | type: string 9 | required: 10 | - labelID 11 | -------------------------------------------------------------------------------- /src/common/schemas/LabelResponse.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | label: 4 | $ref: "./Label.yml" 5 | links: 6 | $ref: "./Links.yml" 7 | -------------------------------------------------------------------------------- /src/common/schemas/LabelUpdate.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | properties: 6 | type: object 7 | additionalProperties: 8 | type: string 9 | description: | 10 | Key-value pairs associated with this label. 11 | 12 | To remove a property, send an update with an empty value (`""`) for the key. 13 | example: { "color": "ffb3b3", "description": "this is a description" } 14 | -------------------------------------------------------------------------------- /src/common/schemas/Labels.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "./Label.yml" 4 | -------------------------------------------------------------------------------- /src/common/schemas/LabelsResponse.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | labels: 4 | $ref: "./Labels.yml" 5 | links: 6 | $ref: "./Links.yml" 7 | -------------------------------------------------------------------------------- /src/common/schemas/LanguageRequest.yml: -------------------------------------------------------------------------------- 1 | description: Flux query to be analyzed. 2 | type: object 3 | required: 4 | - query 5 | properties: 6 | query: 7 | description: | 8 | The Flux query script to be analyzed. 9 | type: string 10 | -------------------------------------------------------------------------------- /src/common/schemas/LatLonColumn.yml: -------------------------------------------------------------------------------- 1 | description: Object type for key and column definitions 2 | type: object 3 | required: [key, column] 4 | properties: 5 | key: 6 | description: Key to determine whether the column is tag/field 7 | type: string 8 | column: 9 | description: Column to look up Lat/Lon 10 | type: string 11 | -------------------------------------------------------------------------------- /src/common/schemas/LatLonColumns.yml: -------------------------------------------------------------------------------- 1 | description: Object type to define lat/lon columns 2 | type: object 3 | required: [lat, lon] 4 | properties: 5 | lat: 6 | $ref: './LatLonColumn.yml' 7 | lon: 8 | $ref: './LatLonColumn.yml' 9 | -------------------------------------------------------------------------------- /src/common/schemas/LesserThreshold.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./ThresholdBase.yml" 3 | - type: object 4 | required: [type, value] 5 | properties: 6 | type: 7 | type: string 8 | enum: [lesser] 9 | value: 10 | type: number 11 | format: float 12 | -------------------------------------------------------------------------------- /src/common/schemas/LineProtocolError.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | code: 3 | $ref: "./LineProtocolErrorCode.yml" 4 | message: 5 | readOnly: true 6 | description: Human-readable message. 7 | type: string 8 | op: 9 | readOnly: true 10 | description: Describes the logical code operation when the error occurred. Useful for debugging. 11 | type: string 12 | err: 13 | readOnly: true 14 | description: Stack of errors that occurred during processing of the request. Useful for debugging. 15 | type: string 16 | line: 17 | readOnly: true 18 | description: First line in the request body that contains malformed data. 19 | type: integer 20 | format: int32 21 | required: 22 | - code 23 | -------------------------------------------------------------------------------- /src/common/schemas/LineProtocolErrorCode.yml: -------------------------------------------------------------------------------- 1 | description: Code is the machine-readable error code. 2 | readOnly: true 3 | type: string 4 | enum: 5 | - internal error 6 | - not found 7 | - conflict 8 | - invalid 9 | - empty value 10 | - unavailable 11 | -------------------------------------------------------------------------------- /src/common/schemas/LineProtocolLengthError.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | code: 3 | $ref: "./LineProtocolLengthErrorCode.yml" 4 | message: 5 | readOnly: true 6 | description: Human-readable message. 7 | type: string 8 | required: 9 | - code 10 | - message 11 | -------------------------------------------------------------------------------- /src/common/schemas/LineProtocolLengthErrorCode.yml: -------------------------------------------------------------------------------- 1 | description: Code is the machine-readable error code. 2 | readOnly: true 3 | type: string 4 | enum: 5 | - invalid 6 | -------------------------------------------------------------------------------- /src/common/schemas/Link.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | format: uri 3 | readOnly: true 4 | description: URI of resource. 5 | -------------------------------------------------------------------------------- /src/common/schemas/Links.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: | 3 | URI pointers for additional paged results. 4 | properties: 5 | next: 6 | $ref: "./Link.yml" 7 | self: 8 | $ref: "./Link.yml" 9 | prev: 10 | $ref: "./Link.yml" 11 | required: [self] 12 | -------------------------------------------------------------------------------- /src/common/schemas/LogEvent.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | time: 4 | readOnly: true 5 | description: The time ([RFC3339Nano date/time format]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. 6 | type: string 7 | format: date-time 8 | example: "2006-01-02T15:04:05.999999999Z07:00" 9 | message: 10 | readOnly: true 11 | description: A description of the event that occurred. 12 | type: string 13 | example: Halt and catch fire 14 | runID: 15 | readOnly: true 16 | description: The ID of the task run that generated the event. 17 | type: string 18 | -------------------------------------------------------------------------------- /src/common/schemas/LogicalExpression.yml: -------------------------------------------------------------------------------- 1 | description: Represents the rule conditions that collectively evaluate to either true or false 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | operator: 7 | type: string 8 | left: 9 | $ref: "./Expression.yml" 10 | right: 11 | $ref: "./Expression.yml" 12 | -------------------------------------------------------------------------------- /src/common/schemas/Logs.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | events: 4 | readOnly: true 5 | type: array 6 | items: 7 | $ref: "./LogEvent.yml" 8 | -------------------------------------------------------------------------------- /src/common/schemas/MapVariableProperties.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | type: 3 | type: string 4 | enum: [map] 5 | values: 6 | type: object 7 | additionalProperties: 8 | type: string 9 | -------------------------------------------------------------------------------- /src/common/schemas/MarkdownViewProperties.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - type 4 | - shape 5 | - note 6 | properties: 7 | type: 8 | type: string 9 | enum: [markdown] 10 | shape: 11 | type: string 12 | enum: ["chronograf-v2"] 13 | note: 14 | type: string 15 | -------------------------------------------------------------------------------- /src/common/schemas/MemberAssignment.yml: -------------------------------------------------------------------------------- 1 | description: Object property assignment 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | member: 7 | $ref: "./MemberExpression.yml" 8 | init: 9 | $ref: "./Expression.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/MemberExpression.yml: -------------------------------------------------------------------------------- 1 | description: Represents accessing a property of an object 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | object: 7 | $ref: "./Expression.yml" 8 | property: 9 | $ref: "./PropertyKey.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/MovedPermanently.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | body: 3 | readOnly: true 4 | description: Response message with URL of requested resource. 5 | type: string 6 | -------------------------------------------------------------------------------- /src/common/schemas/Node.yml: -------------------------------------------------------------------------------- 1 | oneOf: 2 | - $ref: "./Expression.yml" 3 | - $ref: "./Block.yml" 4 | -------------------------------------------------------------------------------- /src/common/schemas/NodeType.yml: -------------------------------------------------------------------------------- 1 | description: Type of AST node 2 | type: string 3 | -------------------------------------------------------------------------------- /src/common/schemas/NotificationEndpoint.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./NotificationEndpointDiscriminator.yml" 3 | -------------------------------------------------------------------------------- /src/common/schemas/NotificationEndpointDiscriminator.yml: -------------------------------------------------------------------------------- 1 | oneOf: 2 | - $ref: "./SlackNotificationEndpoint.yml" 3 | - $ref: "./PagerDutyNotificationEndpoint.yml" 4 | - $ref: "./HTTPNotificationEndpoint.yml" 5 | - $ref: "./TelegramNotificationEndpoint.yml" 6 | discriminator: 7 | propertyName: type 8 | mapping: 9 | slack: "#/components/schemas/SlackNotificationEndpoint" 10 | pagerduty: "#/components/schemas/PagerDutyNotificationEndpoint" 11 | http: "#/components/schemas/HTTPNotificationEndpoint" 12 | telegram: "#/components/schemas/TelegramNotificationEndpoint" 13 | -------------------------------------------------------------------------------- /src/common/schemas/NotificationEndpointType.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | enum: ["slack", "pagerduty", "http", "telegram"] 3 | -------------------------------------------------------------------------------- /src/common/schemas/NotificationEndpointUpdate.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | description: 6 | type: string 7 | status: 8 | type: string 9 | enum: 10 | - active 11 | - inactive 12 | -------------------------------------------------------------------------------- /src/common/schemas/NotificationEndpoints.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | notificationEndpoints: 3 | type: array 4 | items: 5 | $ref: "./NotificationEndpoint.yml" 6 | links: 7 | $ref: "./Links.yml" 8 | -------------------------------------------------------------------------------- /src/common/schemas/NotificationRule.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./NotificationRuleDiscriminator.yml" 3 | -------------------------------------------------------------------------------- /src/common/schemas/NotificationRuleDiscriminator.yml: -------------------------------------------------------------------------------- 1 | oneOf: 2 | - $ref: "./SlackNotificationRule.yml" 3 | - $ref: "./SMTPNotificationRule.yml" 4 | - $ref: "./PagerDutyNotificationRule.yml" 5 | - $ref: "./HTTPNotificationRule.yml" 6 | - $ref: "./TelegramNotificationRule.yml" 7 | discriminator: 8 | propertyName: type 9 | mapping: 10 | slack: "#/components/schemas/SlackNotificationRule" 11 | smtp: "#/components/schemas/SMTPNotificationRule" 12 | pagerduty: "#/components/schemas/PagerDutyNotificationRule" 13 | http: "#/components/schemas/HTTPNotificationRule" 14 | telegram: "#/components/schemas/TelegramNotificationRule" 15 | -------------------------------------------------------------------------------- /src/common/schemas/NotificationRuleUpdate.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | description: 6 | type: string 7 | status: 8 | type: string 9 | enum: 10 | - active 11 | - inactive 12 | -------------------------------------------------------------------------------- /src/common/schemas/NotificationRules.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | notificationRules: 3 | type: array 4 | items: 5 | $ref: "./NotificationRule.yml" 6 | links: 7 | $ref: "./Links.yml" 8 | -------------------------------------------------------------------------------- /src/common/schemas/ObjectExpression.yml: -------------------------------------------------------------------------------- 1 | description: Allows the declaration of an anonymous object within a declaration 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | properties: 7 | description: Object properties 8 | type: array 9 | items: 10 | $ref: "./Property.yml" 11 | -------------------------------------------------------------------------------- /src/common/schemas/OnboardingResponse.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | user: 4 | $ref: "./UserResponse.yml" 5 | org: 6 | $ref: "./Organization.yml" 7 | bucket: 8 | $ref: "./Bucket.yml" 9 | auth: 10 | $ref: "./Authorization.yml" 11 | -------------------------------------------------------------------------------- /src/common/schemas/OptionStatement.yml: -------------------------------------------------------------------------------- 1 | description: A single variable declaration 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | assignment: 7 | $ref: "./VariableOrMemberAssignment.yml" 8 | -------------------------------------------------------------------------------- /src/common/schemas/Organizations.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | links: 4 | $ref: "./Links.yml" 5 | orgs: 6 | type: array 7 | items: 8 | $ref: "./Organization.yml" 9 | -------------------------------------------------------------------------------- /src/common/schemas/Package.yml: -------------------------------------------------------------------------------- 1 | description: Represents a complete package source tree. 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | path: 7 | description: Package import path 8 | type: string 9 | package: 10 | description: Package name 11 | type: string 12 | files: 13 | description: Package files 14 | type: array 15 | items: 16 | $ref: "./File.yml" 17 | -------------------------------------------------------------------------------- /src/common/schemas/PackageClause.yml: -------------------------------------------------------------------------------- 1 | description: Defines a package identifier 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | name: 7 | $ref: "./Identifier.yml" 8 | -------------------------------------------------------------------------------- /src/common/schemas/PagerDutyNotificationEndpoint.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | allOf: 3 | - $ref: "./NotificationEndpointBase.yml" 4 | - type: object 5 | required: [routingKey] 6 | properties: 7 | clientURL: 8 | type: string 9 | routingKey: 10 | type: string 11 | -------------------------------------------------------------------------------- /src/common/schemas/PagerDutyNotificationRule.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./NotificationRuleBase.yml" 3 | - $ref: "./PagerDutyNotificationRuleBase.yml" 4 | -------------------------------------------------------------------------------- /src/common/schemas/PagerDutyNotificationRuleBase.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: [type, messageTemplate] 3 | properties: 4 | type: 5 | type: string 6 | enum: [pagerduty] 7 | messageTemplate: 8 | type: string 9 | -------------------------------------------------------------------------------- /src/common/schemas/ParenExpression.yml: -------------------------------------------------------------------------------- 1 | description: Represents an expression wrapped in parenthesis 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | expression: 7 | $ref: "./Expression.yml" 8 | -------------------------------------------------------------------------------- /src/common/schemas/PasswordResetBody.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | password: 3 | type: string 4 | required: 5 | - password 6 | -------------------------------------------------------------------------------- /src/common/schemas/PatchBucketRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: | 3 | An object that contains updated bucket properties to apply. 4 | properties: 5 | name: 6 | type: string 7 | description: | 8 | The name of the bucket. 9 | description: 10 | description: | 11 | A description of the bucket. 12 | type: string 13 | retentionRules: 14 | $ref: "./PatchRetentionRules.yml" 15 | -------------------------------------------------------------------------------- /src/common/schemas/PatchOrganizationRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: | 3 | An object that contains updated organization properties to apply. 4 | properties: 5 | name: 6 | type: string 7 | description: | 8 | The name of the organization. 9 | description: 10 | type: string 11 | description: | 12 | The description of the organization. 13 | -------------------------------------------------------------------------------- /src/common/schemas/PatchRetentionRules.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | description: Updates to rules to expire or retain data. No rules means no updates. 3 | items: 4 | $ref: "./PatchRetentionRule.yml" 5 | -------------------------------------------------------------------------------- /src/common/schemas/Permission.yml: -------------------------------------------------------------------------------- 1 | required: [action, resource] 2 | properties: 3 | action: 4 | type: string 5 | enum: 6 | - read 7 | - write 8 | resource: 9 | $ref: "./Resource.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/PipeExpression.yml: -------------------------------------------------------------------------------- 1 | description: Call expression with pipe argument 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | argument: 7 | $ref: "./Expression.yml" 8 | call: 9 | $ref: "./CallExpression.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/PipeLiteral.yml: -------------------------------------------------------------------------------- 1 | description: Represents a specialized literal value, indicating the left hand value of a pipe expression 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | -------------------------------------------------------------------------------- /src/common/schemas/PostCheck.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./CheckDiscriminator.yml" 3 | -------------------------------------------------------------------------------- /src/common/schemas/PostNotificationEndpoint.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./NotificationEndpointDiscriminator.yml" 3 | -------------------------------------------------------------------------------- /src/common/schemas/PostNotificationRule.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./NotificationRuleDiscriminator.yml" 3 | -------------------------------------------------------------------------------- /src/common/schemas/PostOrganizationRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | description: | 6 | The name of the organization. 7 | description: 8 | type: string 9 | description: | 10 | The description of the organization. 11 | required: [name] 12 | -------------------------------------------------------------------------------- /src/common/schemas/Property.yml: -------------------------------------------------------------------------------- 1 | description: The value associated with a key 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | key: 7 | $ref: "./PropertyKey.yml" 8 | value: 9 | $ref: "./Expression.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/PropertyKey.yml: -------------------------------------------------------------------------------- 1 | oneOf: 2 | - $ref: "./Identifier.yml" 3 | - $ref: "./StringLiteral.yml" 4 | -------------------------------------------------------------------------------- /src/common/schemas/QueryEditMode.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | enum: ["builder", "advanced"] 3 | -------------------------------------------------------------------------------- /src/common/schemas/QuerySuggestionsNameSuccessResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "name": "sum", 4 | "params": { 5 | "column": "string", 6 | "tables": "stream" 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /src/common/schemas/QueryVariableProperties.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | type: 3 | type: string 4 | enum: [query] 5 | values: 6 | type: object 7 | properties: 8 | query: 9 | type: string 10 | language: 11 | type: string 12 | -------------------------------------------------------------------------------- /src/common/schemas/RangeThreshold.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./ThresholdBase.yml" 3 | - type: object 4 | required: [type, min, max, within] 5 | properties: 6 | type: 7 | type: string 8 | enum: [range] 9 | min: 10 | type: number 11 | format: float 12 | max: 13 | type: number 14 | format: float 15 | within: 16 | type: boolean 17 | -------------------------------------------------------------------------------- /src/common/schemas/Ready.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: string 5 | enum: 6 | - ready 7 | started: 8 | type: string 9 | format: date-time 10 | example: "2019-03-13T10:09:33.891196-04:00" 11 | up: 12 | type: string 13 | example: "14m45.911966424s" 14 | -------------------------------------------------------------------------------- /src/common/schemas/RegexpLiteral.yml: -------------------------------------------------------------------------------- 1 | description: Expressions begin and end with `/` and are regular expressions with syntax accepted by RE2 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | value: 7 | type: string 8 | -------------------------------------------------------------------------------- /src/common/schemas/RenamableField.yml: -------------------------------------------------------------------------------- 1 | description: Describes a field that can be renamed and made visible or invisible. 2 | type: object 3 | properties: 4 | internalName: 5 | description: The calculated name of a field. 6 | readOnly: true 7 | type: string 8 | displayName: 9 | description: The name that a field is renamed to by the user. 10 | type: string 11 | visible: 12 | description: Indicates whether this field should be visible on the table. 13 | type: boolean 14 | -------------------------------------------------------------------------------- /src/common/schemas/ResourceMember.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./UserResponse.yml" 3 | - type: object 4 | properties: 5 | role: 6 | type: string 7 | default: member 8 | enum: 9 | - member 10 | -------------------------------------------------------------------------------- /src/common/schemas/ResourceMembers.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | links: 4 | type: object 5 | properties: 6 | self: 7 | type: string 8 | format: uri 9 | users: 10 | type: array 11 | items: 12 | $ref: "./ResourceMember.yml" 13 | -------------------------------------------------------------------------------- /src/common/schemas/ResourceOwner.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./UserResponse.yml" 3 | - type: object 4 | properties: 5 | role: 6 | type: string 7 | default: owner 8 | enum: 9 | - owner 10 | -------------------------------------------------------------------------------- /src/common/schemas/ResourceOwners.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | links: 4 | type: object 5 | properties: 6 | self: 7 | type: string 8 | format: uri 9 | users: 10 | type: array 11 | items: 12 | $ref: "./ResourceOwner.yml" 13 | -------------------------------------------------------------------------------- /src/common/schemas/Resources.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | type: string 4 | -------------------------------------------------------------------------------- /src/common/schemas/RetentionRules.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | description: | 3 | Retention rules to expire or retain data. 4 | The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#retention-period). 5 | 6 | #### InfluxDB Cloud 7 | 8 | - `retentionRules` is required. 9 | 10 | #### InfluxDB OSS 11 | 12 | - `retentionRules` isn't required. 13 | items: 14 | $ref: "./RetentionRule.yml" 15 | -------------------------------------------------------------------------------- /src/common/schemas/ReturnStatement.yml: -------------------------------------------------------------------------------- 1 | description: Defines an expression to return 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | argument: 7 | $ref: "./Expression.yml" 8 | -------------------------------------------------------------------------------- /src/common/schemas/RuleStatusLevel.yml: -------------------------------------------------------------------------------- 1 | description: The state to record if check matches a criteria. 2 | type: string 3 | enum: ["UNKNOWN", "OK", "INFO", "CRIT", "WARN", "ANY"] 4 | -------------------------------------------------------------------------------- /src/common/schemas/RunManually.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | scheduledFor: 3 | nullable: true 4 | description: | 5 | The time [RFC3339 date/time format]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#rfc3339-timestamp) 6 | used for the run's `now` option. 7 | Default is the server _now_ time. 8 | type: string 9 | format: date-time 10 | -------------------------------------------------------------------------------- /src/common/schemas/Runs.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | links: 4 | $ref: "./Links.yml" 5 | runs: 6 | type: array 7 | items: 8 | $ref: "./Run.yml" 9 | -------------------------------------------------------------------------------- /src/common/schemas/SMTPNotificationRule.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./NotificationRuleBase.yml" 3 | - $ref: "./SMTPNotificationRuleBase.yml" 4 | -------------------------------------------------------------------------------- /src/common/schemas/SMTPNotificationRuleBase.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: [type, subjectTemplate, to] 3 | properties: 4 | type: 5 | type: string 6 | enum: [smtp] 7 | subjectTemplate: 8 | type: string 9 | bodyTemplate: 10 | type: string 11 | to: 12 | type: string 13 | -------------------------------------------------------------------------------- /src/common/schemas/SchemaType.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | enum: 3 | - implicit 4 | - explicit 5 | -------------------------------------------------------------------------------- /src/common/schemas/ScraperTargetRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | description: The name of the scraper target. 6 | type: 7 | type: string 8 | description: The type of the metrics to be parsed. 9 | enum: [prometheus] 10 | url: 11 | type: string 12 | description: The URL of the metrics endpoint. 13 | example: http://localhost:9090/metrics 14 | orgID: 15 | type: string 16 | description: The organization ID. 17 | bucketID: 18 | type: string 19 | description: The ID of the bucket to write to. 20 | allowInsecure: 21 | type: boolean 22 | description: Skip TLS verification on endpoint. 23 | default: false 24 | -------------------------------------------------------------------------------- /src/common/schemas/ScraperTargetResponses.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | configurations: 4 | type: array 5 | items: 6 | $ref: "./ScraperTargetResponse.yml" 7 | -------------------------------------------------------------------------------- /src/common/schemas/SecretKeys.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | secrets: 4 | type: array 5 | items: 6 | type: string 7 | -------------------------------------------------------------------------------- /src/common/schemas/SecretKeysResponse.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./SecretKeys.yml" 3 | - type: object 4 | properties: 5 | links: 6 | readOnly: true 7 | type: object 8 | properties: 9 | self: 10 | type: string 11 | org: 12 | type: string 13 | -------------------------------------------------------------------------------- /src/common/schemas/Secrets.yml: -------------------------------------------------------------------------------- 1 | additionalProperties: 2 | type: string 3 | example: 4 | apikey: abc123xyz 5 | -------------------------------------------------------------------------------- /src/common/schemas/SimpleTableViewProperties.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - type 4 | - showAll 5 | - queries 6 | - shape 7 | - note 8 | - showNoteWhenEmpty 9 | properties: 10 | type: 11 | type: string 12 | enum: [simple-table] 13 | showAll: 14 | type: boolean 15 | queries: 16 | type: array 17 | items: 18 | $ref: "./DashboardQuery.yml" 19 | shape: 20 | type: string 21 | enum: 22 | - chronograf-v2 23 | note: 24 | type: string 25 | showNoteWhenEmpty: 26 | description: 'If true, will display note when empty' 27 | type: boolean 28 | -------------------------------------------------------------------------------- /src/common/schemas/SlackNotificationEndpoint.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | allOf: 3 | - $ref: "./NotificationEndpointBase.yml" 4 | - type: object 5 | properties: 6 | url: 7 | description: Specifies the URL of the Slack endpoint. Specify either `URL` or `Token`. 8 | type: string 9 | token: 10 | description: Specifies the API token string. Specify either `URL` or `Token`. 11 | type: string 12 | -------------------------------------------------------------------------------- /src/common/schemas/SlackNotificationRule.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./NotificationRuleBase.yml" 3 | - $ref: "./SlackNotificationRuleBase.yml" 4 | -------------------------------------------------------------------------------- /src/common/schemas/SlackNotificationRuleBase.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: [type, messageTemplate] 3 | properties: 4 | type: 5 | type: string 6 | enum: [slack] 7 | channel: 8 | type: string 9 | messageTemplate: 10 | type: string 11 | -------------------------------------------------------------------------------- /src/common/schemas/Sources.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | links: 4 | type: object 5 | properties: 6 | self: 7 | type: string 8 | format: uri 9 | sources: 10 | type: array 11 | items: 12 | $ref: "./Source.yml" 13 | -------------------------------------------------------------------------------- /src/common/schemas/Statement.yml: -------------------------------------------------------------------------------- 1 | oneOf: 2 | - $ref: "./BadStatement.yml" 3 | - $ref: "./VariableAssignment.yml" 4 | - $ref: "./MemberAssignment.yml" 5 | - $ref: "./ExpressionStatement.yml" 6 | - $ref: "./ReturnStatement.yml" 7 | - $ref: "./OptionStatement.yml" 8 | - $ref: "./BuiltinStatement.yml" 9 | - $ref: "./TestStatement.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/StaticLegend.yml: -------------------------------------------------------------------------------- 1 | description: StaticLegend represents the options specific to the static legend 2 | type: object 3 | properties: 4 | colorizeRows: 5 | type: boolean 6 | heightRatio: 7 | type: number 8 | format: float 9 | show: 10 | type: boolean 11 | opacity: 12 | type: number 13 | format: float 14 | orientationThreshold: 15 | type: integer 16 | valueAxis: 17 | type: string 18 | widthRatio: 19 | type: number 20 | format: float 21 | -------------------------------------------------------------------------------- /src/common/schemas/StatusRule.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | currentLevel: 4 | $ref: "./RuleStatusLevel.yml" 5 | previousLevel: 6 | $ref: "./RuleStatusLevel.yml" 7 | count: 8 | type: integer 9 | period: 10 | type: string 11 | -------------------------------------------------------------------------------- /src/common/schemas/StringLiteral.yml: -------------------------------------------------------------------------------- 1 | description: Expressions begin and end with double quote marks 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | value: 7 | type: string 8 | -------------------------------------------------------------------------------- /src/common/schemas/TagRule.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | key: 4 | type: string 5 | value: 6 | type: string 7 | operator: 8 | type: string 9 | enum: ["equal", "notequal", "equalregex", "notequalregex"] 10 | -------------------------------------------------------------------------------- /src/common/schemas/TaskCreateRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | orgID: 4 | description: The ID of the organization that owns this Task. 5 | type: string 6 | org: 7 | description: The name of the organization that owns this Task. 8 | type: string 9 | status: 10 | $ref: "./TaskStatusType.yml" 11 | flux: 12 | description: The Flux script to run for this task. 13 | type: string 14 | description: 15 | description: An optional description of the task. 16 | type: string 17 | 18 | required: [flux] 19 | -------------------------------------------------------------------------------- /src/common/schemas/TaskStatusType.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | enum: [active, inactive] 3 | description: | 4 | `inactive` cancels scheduled runs and prevents manual runs of the task. 5 | -------------------------------------------------------------------------------- /src/common/schemas/TaskUpdateRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | $ref: "./TaskStatusType.yml" 5 | flux: 6 | description: The Flux script that the task runs. 7 | type: string 8 | name: 9 | description: Update the 'name' option in the flux script. 10 | type: string 11 | every: 12 | description: Update the 'every' option in the flux script. 13 | type: string 14 | cron: 15 | description: Update the 'cron' option in the flux script. 16 | type: string 17 | offset: 18 | description: Update the 'offset' option in the flux script. 19 | type: string 20 | description: 21 | description: Update the description of the task. 22 | type: string 23 | -------------------------------------------------------------------------------- /src/common/schemas/Tasks.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | links: 4 | readOnly: true 5 | $ref: "./Links.yml" 6 | tasks: 7 | type: array 8 | items: 9 | $ref: "./Task.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/TelegrafPlugin.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | type: 4 | type: string 5 | name: 6 | type: string 7 | description: 8 | type: string 9 | config: 10 | type: string 11 | -------------------------------------------------------------------------------- /src/common/schemas/TelegrafPluginRequest.yml: -------------------------------------------------------------------------------- 1 | # This defines the 'legacy' `TelegrafConfigDecode` type in the api. 2 | type: object 3 | properties: 4 | name: 5 | type: string 6 | description: 7 | type: string 8 | plugins: 9 | type: array 10 | items: 11 | type: object 12 | properties: 13 | type: 14 | type: string 15 | name: 16 | type: string 17 | alias: 18 | type: string 19 | description: 20 | type: string 21 | config: 22 | type: string 23 | metadata: 24 | type: object 25 | properties: 26 | buckets: 27 | type: array 28 | items: 29 | type: string 30 | config: 31 | type: string 32 | orgID: 33 | type: string 34 | -------------------------------------------------------------------------------- /src/common/schemas/TelegrafPlugins.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | version: 4 | type: string 5 | os: 6 | type: string 7 | plugins: 8 | type: array 9 | items: 10 | $ref: "./TelegrafPlugin.yml" 11 | -------------------------------------------------------------------------------- /src/common/schemas/TelegrafRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | description: 6 | type: string 7 | metadata: 8 | type: object 9 | properties: 10 | buckets: 11 | type: array 12 | items: 13 | type: string 14 | config: 15 | type: string 16 | orgID: 17 | type: string 18 | -------------------------------------------------------------------------------- /src/common/schemas/Telegrafs.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | configurations: 4 | type: array 5 | items: 6 | $ref: "./Telegraf.yml" 7 | -------------------------------------------------------------------------------- /src/common/schemas/TelegramNotificationEndpoint.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | allOf: 3 | - $ref: "./NotificationEndpointBase.yml" 4 | - type: object 5 | required: [token, channel] 6 | properties: 7 | token: 8 | description: Specifies the Telegram bot token. See https://core.telegram.org/bots#creating-a-new-bot . 9 | type: string 10 | channel: 11 | description: The ID of the telegram channel; a chat_id in https://core.telegram.org/bots/api#sendmessage . 12 | type: string 13 | -------------------------------------------------------------------------------- /src/common/schemas/TelegramNotificationRule.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./NotificationRuleBase.yml" 3 | - $ref: "./TelegramNotificationRuleBase.yml" 4 | -------------------------------------------------------------------------------- /src/common/schemas/Template.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "./TemplateEntry.yml" 4 | -------------------------------------------------------------------------------- /src/common/schemas/TemplateChart.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | xPos: 4 | type: integer 5 | yPos: 6 | type: integer 7 | height: 8 | type: integer 9 | width: 10 | type: integer 11 | properties: # field name is properties 12 | $ref: "./ViewProperties.yml" 13 | -------------------------------------------------------------------------------- /src/common/schemas/TemplateKind.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | enum: 3 | - Bucket 4 | - Check 5 | - CheckDeadman 6 | - CheckThreshold 7 | - Dashboard 8 | - Label 9 | - NotificationEndpoint 10 | - NotificationEndpointHTTP 11 | - NotificationEndpointPagerDuty 12 | - NotificationEndpointSlack 13 | - NotificationRule 14 | - Task 15 | - Telegraf 16 | - Variable 17 | -------------------------------------------------------------------------------- /src/common/schemas/TemplateSummaryError.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./TemplateSummary.yml" 3 | - type: object 4 | required: [message, code] 5 | properties: 6 | message: 7 | type: string 8 | code: 9 | type: string 10 | -------------------------------------------------------------------------------- /src/common/schemas/TemplateSummaryLabel.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: string 5 | orgID: 6 | type: string 7 | kind: 8 | $ref: "./TemplateKind.yml" 9 | templateMetaName: 10 | type: string 11 | name: 12 | type: string 13 | properties: 14 | type: object 15 | properties: 16 | color: 17 | type: string 18 | description: 19 | type: string 20 | envReferences: 21 | $ref: "./TemplateEnvReferences.yml" 22 | -------------------------------------------------------------------------------- /src/common/schemas/TestStatement.yml: -------------------------------------------------------------------------------- 1 | description: Declares a Flux test case 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | assignment: 7 | $ref: "./VariableAssignment.yml" 8 | -------------------------------------------------------------------------------- /src/common/schemas/Threshold.yml: -------------------------------------------------------------------------------- 1 | oneOf: 2 | - $ref: "./GreaterThreshold.yml" 3 | - $ref: "./LesserThreshold.yml" 4 | - $ref: "./RangeThreshold.yml" 5 | discriminator: 6 | propertyName: type 7 | mapping: 8 | greater: "#/components/schemas/GreaterThreshold" 9 | lesser: "#/components/schemas/LesserThreshold" 10 | range: "#/components/schemas/RangeThreshold" 11 | -------------------------------------------------------------------------------- /src/common/schemas/ThresholdBase.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | level: 3 | $ref: "./CheckStatusLevel.yml" 4 | allValues: 5 | description: If true, only alert if all values meet threshold. 6 | type: boolean 7 | -------------------------------------------------------------------------------- /src/common/schemas/UnaryExpression.yml: -------------------------------------------------------------------------------- 1 | description: Uses operators to act on a single operand in an expression 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | operator: 7 | type: string 8 | argument: 9 | $ref: "./Expression.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/UnauthorizedRequestError.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | code: 3 | description: | 4 | The HTTP status code description. Default is `unauthorized`. 5 | readOnly: true 6 | type: string 7 | enum: 8 | - unauthorized 9 | message: 10 | readOnly: true 11 | description: A human-readable message that may contain detail about the error. 12 | type: string 13 | -------------------------------------------------------------------------------- /src/common/schemas/UnsignedIntegerLiteral.yml: -------------------------------------------------------------------------------- 1 | description: Represents integer numbers 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | value: 7 | type: string 8 | -------------------------------------------------------------------------------- /src/common/schemas/User.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | readOnly: true 4 | type: string 5 | description: The user ID. 6 | name: 7 | type: string 8 | description: The user name. 9 | status: 10 | description: | 11 | If `inactive`, the user is inactive. 12 | Default is `active`. 13 | default: active 14 | type: string 15 | enum: 16 | - active 17 | - inactive 18 | required: [name] 19 | -------------------------------------------------------------------------------- /src/common/schemas/UserResponse.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | readOnly: true 4 | type: string 5 | description: | 6 | The user ID. 7 | name: 8 | type: string 9 | description: | 10 | The user name. 11 | status: 12 | description: | 13 | The status of a user. 14 | An inactive user can't read or write resources. 15 | default: active 16 | type: string 17 | enum: 18 | - active 19 | - inactive 20 | links: 21 | type: object 22 | readOnly: true 23 | example: 24 | self: "/api/v2/users/1" 25 | properties: 26 | self: 27 | type: string 28 | format: uri 29 | required: [name] 30 | -------------------------------------------------------------------------------- /src/common/schemas/Users.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | links: 4 | type: object 5 | properties: 6 | self: 7 | type: string 8 | format: uri 9 | users: 10 | type: array 11 | items: 12 | $ref: "./UserResponse.yml" 13 | -------------------------------------------------------------------------------- /src/common/schemas/VariableAssignment.yml: -------------------------------------------------------------------------------- 1 | description: Represents the declaration of a variable 2 | type: object 3 | properties: 4 | type: 5 | $ref: "./NodeType.yml" 6 | id: 7 | $ref: "./Identifier.yml" 8 | init: 9 | $ref: "./Expression.yml" 10 | -------------------------------------------------------------------------------- /src/common/schemas/VariableOrMemberAssignment.yml: -------------------------------------------------------------------------------- 1 | oneOf: 2 | - $ref: "./VariableAssignment.yml" 3 | - $ref: "./MemberAssignment.yml" 4 | -------------------------------------------------------------------------------- /src/common/schemas/VariableProperties.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | oneOf: 3 | - $ref: "./QueryVariableProperties.yml" 4 | - $ref: "./ConstantVariableProperties.yml" 5 | - $ref: "./MapVariableProperties.yml" 6 | -------------------------------------------------------------------------------- /src/common/schemas/View.yml: -------------------------------------------------------------------------------- 1 | required: 2 | - name 3 | - properties 4 | properties: 5 | links: 6 | type: object 7 | readOnly: true 8 | properties: 9 | self: 10 | type: string 11 | id: 12 | readOnly: true 13 | type: string 14 | name: 15 | type: string 16 | properties: 17 | $ref: "./ViewProperties.yml" 18 | -------------------------------------------------------------------------------- /src/common/schemas/ViewProperties.yml: -------------------------------------------------------------------------------- 1 | oneOf: 2 | - $ref: "./LinePlusSingleStatProperties.yml" 3 | - $ref: "./XYViewProperties.yml" 4 | - $ref: "./SingleStatViewProperties.yml" 5 | - $ref: "./HistogramViewProperties.yml" 6 | - $ref: "./GaugeViewProperties.yml" 7 | - $ref: "./TableViewProperties.yml" 8 | - $ref: "./SimpleTableViewProperties.yml" 9 | - $ref: "./MarkdownViewProperties.yml" 10 | - $ref: "./CheckViewProperties.yml" 11 | - $ref: "./ScatterViewProperties.yml" 12 | - $ref: "./HeatmapViewProperties.yml" 13 | - $ref: "./MosaicViewProperties.yml" 14 | - $ref: "./BandViewProperties.yml" 15 | - $ref: "./GeoViewProperties.yml" 16 | -------------------------------------------------------------------------------- /src/common/schemas/Views.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | links: 4 | type: object 5 | properties: 6 | self: 7 | type: string 8 | views: 9 | type: array 10 | items: 11 | $ref: "./View.yml" 12 | -------------------------------------------------------------------------------- /src/common/schemas/WritePrecision.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | enum: 3 | - ms 4 | - s 5 | - us 6 | - ns 7 | -------------------------------------------------------------------------------- /src/common/schemas/XYGeom.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | enum: [line, step, stacked, bar, monotoneX, stepBefore, stepAfter] 3 | -------------------------------------------------------------------------------- /src/legacy/schemas/InfluxqlCsvResponse.yml: -------------------------------------------------------------------------------- 1 | description: CSV Response to InfluxQL Query 2 | type: string 3 | example: > 4 | name,tags,time,test_field,test_tag 5 | test_measurement,,1603740794286107366,1,tag_value 6 | test_measurement,,1603740870053205649,2,tag_value 7 | test_measurement,,1603741221085428881,3,tag_value 8 | -------------------------------------------------------------------------------- /src/oss/paths/debug_pprof_cmdline.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetDebugPprofCmdline 3 | tags: 4 | - Debug 5 | - System information endpoints 6 | summary: Retrieve the command line invocation 7 | description: | 8 | Returns the command line that invoked InfluxDB. 9 | servers: 10 | - url: '' 11 | parameters: 12 | - $ref: "../../common/parameters/TraceSpan.yml" 13 | responses: 14 | "200": 15 | description: Command line invocation. 16 | content: 17 | text/plain: 18 | schema: 19 | type: string 20 | format: "Command line" 21 | default: 22 | description: Unexpected error 23 | $ref: '../../common/responses/ServerError.yml' 24 | -------------------------------------------------------------------------------- /src/oss/paths/ready.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetReady 3 | tags: 4 | - Ready 5 | - System information endpoints 6 | summary: Get the readiness of an instance at startup 7 | servers: 8 | - url: '' 9 | parameters: 10 | - $ref: "../../common/parameters/TraceSpan.yml" 11 | responses: 12 | "200": 13 | description: The instance is ready 14 | content: 15 | application/json: 16 | schema: 17 | $ref: "../../common/schemas/Ready.yml" 18 | default: 19 | description: Unexpected error 20 | $ref: '../../common/responses/ServerError.yml' 21 | -------------------------------------------------------------------------------- /src/oss/paths/replications_replicationID_validate.yml: -------------------------------------------------------------------------------- 1 | post: 2 | operationId: PostValidateReplicationByID 3 | tags: 4 | - Replications 5 | summary: Validate a replication 6 | parameters: 7 | - $ref: "../../common/parameters/TraceSpan.yml" 8 | - in: path 9 | name: replicationID 10 | schema: 11 | type: string 12 | required: true 13 | responses: 14 | "204": 15 | description: Replication is valid 16 | "400": 17 | description: Replication failed validation 18 | $ref: "../../common/responses/ServerError.yml" 19 | default: 20 | $ref: "../../common/responses/ServerError.yml" 21 | -------------------------------------------------------------------------------- /src/oss/schemas/BucketMetadataManifest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | # 2.x metadata / API fields 4 | organizationID: 5 | type: string 6 | organizationName: 7 | type: string 8 | bucketID: 9 | type: string 10 | bucketName: 11 | type: string 12 | description: 13 | type: string 14 | 15 | # 1.x / storage-engine fields 16 | defaultRetentionPolicy: 17 | type: string 18 | retentionPolicies: 19 | $ref: "./RetentionPolicyManifests.yml" 20 | required: 21 | - organizationID 22 | - organizationName 23 | - bucketID 24 | - bucketName 25 | - defaultRetentionPolicy 26 | - retentionPolicies 27 | -------------------------------------------------------------------------------- /src/oss/schemas/BucketMetadataManifests.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "./BucketMetadataManifest.yml" 4 | -------------------------------------------------------------------------------- /src/oss/schemas/BucketShardMapping.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | oldId: 4 | type: integer 5 | format: int64 6 | newId: 7 | type: integer 8 | format: int64 9 | required: [oldId, newId] 10 | -------------------------------------------------------------------------------- /src/oss/schemas/BucketShardMappings.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "./BucketShardMapping.yml" 4 | -------------------------------------------------------------------------------- /src/oss/schemas/Config.yml: -------------------------------------------------------------------------------- 1 | # Ideally this would include a full list of config flags, but since these all 2 | # contain dashes and Oats doesn't work with parameters that have dashes, we 3 | # need to leave it as a generic object. See: https://github.com/influxdata/oats/issues/19 4 | type: object 5 | properties: 6 | config: 7 | type: object 8 | -------------------------------------------------------------------------------- /src/oss/schemas/MetadataBackup.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | kv: 4 | type: string 5 | format: binary 6 | sql: 7 | type: string 8 | format: binary 9 | buckets: 10 | $ref: "./BucketMetadataManifests.yml" 11 | required: [kv, sql, buckets] 12 | -------------------------------------------------------------------------------- /src/oss/schemas/PostRestoreKVResponse.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | token: 4 | description: token is the root token for the instance after restore (this is overwritten during the restore) 5 | type: string 6 | -------------------------------------------------------------------------------- /src/oss/schemas/RemoteConnection.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: string 5 | name: 6 | type: string 7 | orgID: 8 | type: string 9 | description: 10 | type: string 11 | remoteURL: 12 | type: string 13 | format: uri 14 | remoteOrgID: 15 | type: string 16 | allowInsecureTLS: 17 | type: boolean 18 | default: false 19 | required: 20 | - id 21 | - name 22 | - orgID 23 | - remoteURL 24 | - allowInsecureTLS 25 | -------------------------------------------------------------------------------- /src/oss/schemas/RemoteConnectionCreationRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | description: 6 | type: string 7 | orgID: 8 | type: string 9 | remoteURL: 10 | type: string 11 | format: uri 12 | remoteAPIToken: 13 | type: string 14 | remoteOrgID: 15 | type: string 16 | allowInsecureTLS: 17 | type: boolean 18 | default: false 19 | required: 20 | - name 21 | - orgID 22 | - remoteURL 23 | - remoteAPIToken 24 | - allowInsecureTLS 25 | -------------------------------------------------------------------------------- /src/oss/schemas/RemoteConnectionUpdateRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | description: 6 | type: string 7 | remoteURL: 8 | type: string 9 | format: uri 10 | remoteAPIToken: 11 | type: string 12 | remoteOrgID: 13 | type: string 14 | allowInsecureTLS: 15 | type: boolean 16 | default: false 17 | -------------------------------------------------------------------------------- /src/oss/schemas/RemoteConnections.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | # TODO(danmoran): Add pagination / links? 4 | remotes: 5 | type: array 6 | items: 7 | $ref: "./RemoteConnection.yml" 8 | -------------------------------------------------------------------------------- /src/oss/schemas/ReplicationCreationRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | description: 6 | type: string 7 | orgID: 8 | type: string 9 | remoteID: 10 | type: string 11 | localBucketID: 12 | type: string 13 | remoteBucketID: 14 | type: string 15 | remoteBucketName: 16 | type: string 17 | maxQueueSizeBytes: 18 | type: integer 19 | format: int64 20 | minimum: 33554430 # 32 MiB 21 | default: 67108860 # 64 MiB 22 | dropNonRetryableData: 23 | type: boolean 24 | default: false 25 | maxAgeSeconds: 26 | type: integer 27 | format: int64 28 | minimum: 0 29 | default: 604800 # 1 week in seconds 30 | required: 31 | - name 32 | - orgID 33 | - remoteID 34 | - localBucketID 35 | - maxQueueSizeBytes 36 | - maxAgeSeconds 37 | -------------------------------------------------------------------------------- /src/oss/schemas/ReplicationUpdateRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | description: 6 | type: string 7 | remoteID: 8 | type: string 9 | remoteBucketID: 10 | type: string 11 | remoteBucketName: 12 | type: string 13 | maxQueueSizeBytes: 14 | type: integer 15 | format: int64 16 | minimum: 33554430 # 32 MiB 17 | dropNonRetryableData: 18 | type: boolean 19 | maxAgeSeconds: 20 | type: integer 21 | format: int64 22 | minimum: 0 23 | -------------------------------------------------------------------------------- /src/oss/schemas/Replications.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | replications: 4 | type: array 5 | items: 6 | $ref: "./Replication.yml" 7 | -------------------------------------------------------------------------------- /src/oss/schemas/RestoredBucketMappings.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | description: New ID of the restored bucket 5 | type: string 6 | name: 7 | type: string 8 | shardMappings: 9 | $ref: "./BucketShardMappings.yml" 10 | required: [id, name, shardMappings] 11 | -------------------------------------------------------------------------------- /src/oss/schemas/RetentionPolicyManifest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | replicaN: 6 | type: integer 7 | duration: 8 | type: integer 9 | format: int64 10 | shardGroupDuration: 11 | type: integer 12 | format: int64 13 | shardGroups: 14 | $ref: "./ShardGroupManifests.yml" 15 | subscriptions: 16 | $ref: "./SubscriptionManifests.yml" 17 | required: [name, replicaN, duration, shardGroupDuration, shardGroups, subscriptions] 18 | -------------------------------------------------------------------------------- /src/oss/schemas/RetentionPolicyManifests.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "./RetentionPolicyManifest.yml" 4 | -------------------------------------------------------------------------------- /src/oss/schemas/ShardGroupManifest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: integer 5 | format: int64 6 | startTime: 7 | type: string 8 | format: date-time 9 | endTime: 10 | type: string 11 | format: date-time 12 | deletedAt: 13 | type: string 14 | format: date-time 15 | truncatedAt: 16 | type: string 17 | format: date-time 18 | shards: 19 | $ref: "./ShardManifests.yml" 20 | required: [id, startTime, endTime, shards] 21 | -------------------------------------------------------------------------------- /src/oss/schemas/ShardGroupManifests.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "./ShardGroupManifest.yml" 4 | -------------------------------------------------------------------------------- /src/oss/schemas/ShardManifest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: integer 5 | format: int64 6 | shardOwners: 7 | $ref: "./ShardOwners.yml" 8 | required: [id, shardOwners] 9 | -------------------------------------------------------------------------------- /src/oss/schemas/ShardManifests.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "./ShardManifest.yml" 4 | -------------------------------------------------------------------------------- /src/oss/schemas/ShardOwner.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | nodeID: 4 | type: integer 5 | format: int64 6 | description: The ID of the node that owns the shard. 7 | required: [nodeID] 8 | -------------------------------------------------------------------------------- /src/oss/schemas/ShardOwners.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "./ShardOwner.yml" 4 | -------------------------------------------------------------------------------- /src/oss/schemas/SubscriptionManifest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | mode: 6 | type: string 7 | destinations: 8 | type: array 9 | items: 10 | type: string 11 | required: [name, mode, destinations] 12 | -------------------------------------------------------------------------------- /src/oss/schemas/SubscriptionManifests.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "./SubscriptionManifest.yml" 4 | -------------------------------------------------------------------------------- /src/oss/tag-groups.yml: -------------------------------------------------------------------------------- 1 | x-tagGroups: 2 | - name: Overview 3 | tags: 4 | - Quick start 5 | - Authentication 6 | - Supported operations 7 | - Headers 8 | - Common parameters 9 | - Pagination 10 | - Response codes 11 | - name: Popular endpoints 12 | tags: 13 | - Data I/O endpoints 14 | - Security and access endpoints 15 | - System information endpoints 16 | - name: All endpoints 17 | tags: [] 18 | 19 | -------------------------------------------------------------------------------- /src/quartz/schemas/BucketLimits.yml: -------------------------------------------------------------------------------- 1 | description: Bucket limits 2 | type: object 3 | properties: 4 | maxBuckets: 5 | example: 2 6 | description: Number of buckets allowed 7 | oneOf: 8 | - $ref: "./RestrictedLimit.yml" 9 | - $ref: "./Unlimited.yml" 10 | - $ref: "./Limit.yml" 11 | maxRetentionDuration: 12 | description: Retention duration limits in nanoseconds 13 | example: 2592000000000000 14 | oneOf: 15 | - $ref: "./RestrictedLimit.yml" 16 | - $ref: "./Unlimited.yml" 17 | - $ref: "./Limit.yml" 18 | -------------------------------------------------------------------------------- /src/quartz/schemas/CheckLimits.yml: -------------------------------------------------------------------------------- 1 | description: Check limits 2 | type: object 3 | properties: 4 | maxChecks: 5 | description: Number of checks allowed 6 | example: 2 7 | oneOf: 8 | - $ref: "./RestrictedLimit.yml" 9 | - $ref: "./Unlimited.yml" 10 | - $ref: "./Limit.yml" 11 | -------------------------------------------------------------------------------- /src/quartz/schemas/DashboardLimits.yml: -------------------------------------------------------------------------------- 1 | description: Dashboard limits 2 | type: object 3 | properties: 4 | maxDashboards: 5 | description: Number of dashboards allowed 6 | example: 5 7 | oneOf: 8 | - $ref: "./RestrictedLimit.yml" 9 | - $ref: "./Unlimited.yml" 10 | - $ref: "./Limit.yml" 11 | -------------------------------------------------------------------------------- /src/quartz/schemas/IOxQueryLimits.yml: -------------------------------------------------------------------------------- 1 | description: IOx query limits 2 | type: object 3 | properties: 4 | partitions: 5 | description: Number of partitions allowed in a single query. 6 | $ref: "./Limit.yml" 7 | parquetFiles: 8 | description: Number of parquet files allowed in a single query. 9 | $ref: "./Limit.yml" 10 | -------------------------------------------------------------------------------- /src/quartz/schemas/Limit.yml: -------------------------------------------------------------------------------- 1 | description: Limit of at least 1 2 | type: integer 3 | minimum: 1 4 | -------------------------------------------------------------------------------- /src/quartz/schemas/NotificationEndpointLimits.yml: -------------------------------------------------------------------------------- 1 | description: Notification endpoint limits 2 | type: object 3 | properties: 4 | blockedNotificationEndpoints: 5 | description: Notification endpoints not allowed CSV 6 | example: "http,pagerduty" 7 | type: string 8 | -------------------------------------------------------------------------------- /src/quartz/schemas/NotificationRuleLimits.yml: -------------------------------------------------------------------------------- 1 | description: Notification rule limits 2 | type: object 3 | properties: 4 | maxNotifications: 5 | description: Number of notifications allowed 6 | example: 2 7 | oneOf: 8 | - $ref: "./RestrictedLimit.yml" 9 | - $ref: "./Unlimited.yml" 10 | - $ref: "./Limit.yml" 11 | blockedNotificationRules: 12 | description: Notification rules not allowed CSV 13 | example: "http,pagerduty" 14 | type: string 15 | -------------------------------------------------------------------------------- /src/quartz/schemas/OEMInvitedEmail.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | description: Email of successfully invited user for an OEM organization 3 | -------------------------------------------------------------------------------- /src/quartz/schemas/OEMInvitedError.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | description: Conflict or Validation error message for failed invites to an OEM organization 3 | -------------------------------------------------------------------------------- /src/quartz/schemas/OEMInvitedResponse.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | emails: 4 | type: array 5 | items: 6 | $ref: "./OEMInvitedEmail.yml" 7 | errors: 8 | type: array 9 | items: 10 | $ref: "./OEMInvitedError.yml" 11 | -------------------------------------------------------------------------------- /src/quartz/schemas/Organization.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | description: the IDPE organization ID 5 | readOnly: true 6 | type: string 7 | apiUrl: 8 | description: URL for talking to a specific cluster 9 | readOnly: true 10 | type: string 11 | name: 12 | description: name of the organization 13 | type: string 14 | region: 15 | description: name of the region within the cloud provider 16 | type: string 17 | provider: 18 | description: name of the cloud provider 19 | type: string 20 | enum: 21 | - AWS 22 | - GCP 23 | - Azure 24 | -------------------------------------------------------------------------------- /src/quartz/schemas/OrganizationRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | orgName: 4 | description: name of the organization 5 | type: string 6 | provider: 7 | description: name of the cloud provider 8 | type: string 9 | enum: 10 | - AWS 11 | - GCP 12 | - Azure 13 | region: 14 | description: name of the region within the cloud provider 15 | type: string 16 | rateLimits: 17 | $ref: "./OrgLimits.yml" 18 | -------------------------------------------------------------------------------- /src/quartz/schemas/OrganizationWithToken.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./Organization.yml" 3 | - type: object 4 | properties: 5 | token: 6 | description: Authentication token to manage the organization and its resources in IDPE 7 | readOnly: true 8 | type: string 9 | links: 10 | description: Links to the IDPE resources for this organization 11 | readOnly: true 12 | type: object 13 | example: { "resource": "path/to/resource" } 14 | -------------------------------------------------------------------------------- /src/quartz/schemas/Organizations.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "./Organization.yml" 4 | -------------------------------------------------------------------------------- /src/quartz/schemas/RateLimits.yml: -------------------------------------------------------------------------------- 1 | description: Usage rate limits 2 | type: object 3 | properties: 4 | readKBs: 5 | description: KB of data query'd per second 6 | example: 1000 7 | oneOf: 8 | - $ref: "./RestrictedLimit.yml" 9 | - $ref: "./Limit.yml" 10 | maximum: 10000 11 | writeKBs: 12 | description: KB of data written per second 13 | example: 17 14 | oneOf: 15 | - $ref: "./RestrictedLimit.yml" 16 | - $ref: "./Limit.yml" 17 | maximum: 10000 18 | cardinality: 19 | description: Max cardinality of data 20 | example: 10000 21 | oneOf: 22 | - $ref: "./RestrictedLimit.yml" 23 | - $ref: "./Limit.yml" 24 | maximum: 1000000 25 | -------------------------------------------------------------------------------- /src/quartz/schemas/RestrictedLimit.yml: -------------------------------------------------------------------------------- 1 | description: Restrict access entirely 2 | type: integer 3 | enum: [-1] 4 | -------------------------------------------------------------------------------- /src/quartz/schemas/StackLimits.yml: -------------------------------------------------------------------------------- 1 | description: Stack limits 2 | type: object 3 | properties: 4 | enabled: 5 | example: true 6 | type: boolean 7 | -------------------------------------------------------------------------------- /src/quartz/schemas/TaskLimits.yml: -------------------------------------------------------------------------------- 1 | description: Task limits 2 | type: object 3 | properties: 4 | maxTasks: 5 | description: Number of tasks allowed 6 | example: 5 7 | oneOf: 8 | - $ref: "./RestrictedLimit.yml" 9 | - $ref: "./Unlimited.yml" 10 | - $ref: "./Limit.yml" 11 | -------------------------------------------------------------------------------- /src/quartz/schemas/TimeoutLimits.yml: -------------------------------------------------------------------------------- 1 | description: Timeout limits 2 | type: object 3 | properties: 4 | queryUnconditionalTimeoutSeconds: 5 | example: 10 6 | oneOf: 7 | - $ref: "./RestrictedLimit.yml" 8 | - $ref: "./Unlimited.yml" 9 | - $ref: "./Limit.yml" 10 | queryidleWriteTimeoutSeconds: 11 | example: 10 12 | oneOf: 13 | - $ref: "./RestrictedLimit.yml" 14 | - $ref: "./Unlimited.yml" 15 | - $ref: "./Limit.yml" 16 | -------------------------------------------------------------------------------- /src/quartz/schemas/Unlimited.yml: -------------------------------------------------------------------------------- 1 | description: Unbounded limit 2 | type: integer 3 | enum: [0] 4 | -------------------------------------------------------------------------------- /src/quartz/schemas/User.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | email: 3 | type: string 4 | description: user's email 5 | firstName: 6 | type: string 7 | description: user's first name 8 | id: 9 | type: string 10 | description: user's id in idpe 11 | lastName: 12 | type: string 13 | description: user's last name 14 | required: [email, firstName, id, lastName] 15 | -------------------------------------------------------------------------------- /src/quartz/schemas/Users.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './User.yml' 4 | -------------------------------------------------------------------------------- /src/svc-mapsd.yml: -------------------------------------------------------------------------------- 1 | openapi: "3.0.0" 2 | info: 3 | title: Maps service 4 | version: 0.1.0 5 | license: 6 | name: MIT 7 | url: 'https://opensource.org/licenses/MIT' 8 | servers: 9 | - url: /api/v1 10 | paths: 11 | /mapToken: 12 | $ref: "./svc/mapsd/paths/mapToken.yml" 13 | components: 14 | schemas: 15 | Token: 16 | $ref: "./svc/mapsd/schemas/Token.yml" 17 | Error: 18 | $ref: "./common/schemas/Error.yml" 19 | responses: 20 | ServerError: 21 | $ref: "./common/responses/ServerError.yml" 22 | -------------------------------------------------------------------------------- /src/svc/annotationd/parameters/AnnotationDeleteFilter.yml: -------------------------------------------------------------------------------- 1 | in: query 2 | name: AnnotationDeleteFilter 3 | required: true 4 | description: Annotations to delete 5 | schema: 6 | $ref: "../schemas/AnnotationDeleteFilter.yml" 7 | -------------------------------------------------------------------------------- /src/svc/annotationd/parameters/AnnotationListFilter.yml: -------------------------------------------------------------------------------- 1 | in: query 2 | name: AnnotationListFilter 3 | required: false 4 | description: Filter for returned annotations 5 | schema: 6 | $ref: "../schemas/AnnotationListFilter.yml" 7 | -------------------------------------------------------------------------------- /src/svc/annotationd/parameters/StreamDeleteFilter.yml: -------------------------------------------------------------------------------- 1 | in: query 2 | name: StreamDeleteFilter 3 | required: true 4 | description: Stream to delete 5 | schema: 6 | $ref: "../schemas/StreamDeleteFilter.yml" 7 | -------------------------------------------------------------------------------- /src/svc/annotationd/parameters/StreamListFilter.yml: -------------------------------------------------------------------------------- 1 | in: query 2 | name: StreamListFilter 3 | required: false 4 | description: Filter for returned streams 5 | schema: 6 | $ref: "../schemas/StreamListFilter.yml" 7 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/Annotation.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | summary: 4 | type: string 5 | message: 6 | type: string 7 | stickers: 8 | type: object 9 | additionalProperties: 10 | type: string 11 | startTime: 12 | type: string 13 | format: date-time 14 | endTime: 15 | type: string 16 | format: date-time 17 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/AnnotationCreate.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "../schemas/Annotation.yml" 3 | - type: object 4 | properties: 5 | stream: 6 | type: string 7 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/AnnotationCreateList.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "../schemas/AnnotationCreate.yml" 4 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/AnnotationDeleteFilter.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - stream 4 | - startTime 5 | - endTime 6 | properties: 7 | stickers: 8 | type: object 9 | additionalProperties: 10 | type: string 11 | stream: 12 | type: string 13 | streamID: 14 | type: string 15 | startTime: 16 | type: string 17 | format: date-time 18 | endTime: 19 | type: string 20 | format: date-time 21 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/AnnotationEvent.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "../schemas/Annotation.yml" 3 | - type: object 4 | properties: 5 | stream: 6 | type: string 7 | id: 8 | type: string 9 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/AnnotationEventList.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "../schemas/AnnotationEvent.yml" 4 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/AnnotationList.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | type: object 4 | properties: 5 | stream: 6 | type: string 7 | annotations: 8 | type: array 9 | items: 10 | $ref: "../schemas/AnnotationResponse.yml" 11 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/AnnotationListFilter.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "../schemas/BasicFilter.yml" 3 | - type: object 4 | properties: 5 | stickerIncludes: 6 | type: object 7 | additionalProperties: 8 | type: string 9 | streamIncludes: 10 | type: array 11 | items: 12 | type: string 13 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/AnnotationResponse.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: string 5 | summary: 6 | type: string 7 | message: 8 | type: string 9 | stickers: 10 | type: object 11 | additionalProperties: 12 | type: string 13 | startTime: 14 | type: string 15 | format: date-time 16 | endTime: 17 | type: string 18 | format: date-time 19 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/BasicFilter.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | startTime: 4 | type: string 5 | format: date-time 6 | endTime: 7 | type: string 8 | format: date-time 9 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/ReadStream.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: string 5 | stream: 6 | type: string 7 | description: 8 | type: string 9 | createdAt: 10 | type: string 11 | format: date-time 12 | updatedAt: 13 | type: string 14 | format: date-time 15 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/Stream.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | stream: 4 | type: string 5 | description: 6 | type: string 7 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/StreamDeleteFilter.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | stream: 4 | type: string 5 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/StreamList.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "../schemas/ReadStream.yml" 4 | -------------------------------------------------------------------------------- /src/svc/annotationd/schemas/StreamListFilter.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "../schemas/BasicFilter.yml" 3 | - type: object 4 | properties: 5 | streamIncludes: 6 | type: array 7 | items: 8 | type: string 9 | allStreams: 10 | type: boolean 11 | -------------------------------------------------------------------------------- /src/svc/fluxdocsd/paths/fluxdocs.yml: -------------------------------------------------------------------------------- 1 | get: 2 | summary: get all records 3 | operationId: getAllFluxdocs 4 | responses: 5 | '200': 6 | description: all records 7 | content: 8 | application/json: 9 | schema: 10 | $ref: '../schemas/fluxdocsArray.yml' 11 | '401': 12 | $ref: '../../../common/responses/ServerError.yml' 13 | '500': 14 | $ref: '../../../common/responses/ServerError.yml' 15 | -------------------------------------------------------------------------------- /src/svc/fluxdocsd/paths/fluxdocs_id.yml: -------------------------------------------------------------------------------- 1 | get: 2 | summary: get single record by its ID 3 | operationId: getFluxdoc 4 | parameters: 5 | - name: id 6 | in: path 7 | schema: 8 | type: string 9 | required: true 10 | responses: 11 | '200': 12 | description: returns the record 13 | content: 14 | application/json: 15 | schema: 16 | $ref: '../schemas/fluxdocs.yml' 17 | '400': 18 | $ref: '../../../common/responses/ServerError.yml' 19 | '401': 20 | $ref: '../../../common/responses/ServerError.yml' 21 | '500': 22 | $ref: '../../../common/responses/ServerError.yml' 23 | -------------------------------------------------------------------------------- /src/svc/fluxdocsd/paths/fluxdocs_search_searchTerm.yml: -------------------------------------------------------------------------------- 1 | get: 2 | summary: get all records that contain name 3 | operationId: getFluxdocsSearch 4 | parameters: 5 | - name: searchTerm 6 | in: path 7 | schema: 8 | type: string 9 | required: true 10 | - name: field 11 | in: query 12 | schema: 13 | type: string 14 | required: false 15 | responses: 16 | '200': 17 | description: returns all matching records 18 | content: 19 | application/json: 20 | schema: 21 | $ref: '../schemas/fluxdocsArray.yml' 22 | '400': 23 | $ref: '../../../common/responses/ServerError.yml' 24 | '401': 25 | $ref: '../../../common/responses/ServerError.yml' 26 | '500': 27 | $ref: '../../../common/responses/ServerError.yml' 28 | -------------------------------------------------------------------------------- /src/svc/fluxdocsd/requestBodies/FluxdocsParams.yml: -------------------------------------------------------------------------------- 1 | description: Fluxdocs record 2 | required: true 3 | content: 4 | application/json: 5 | schema: 6 | $ref: '../schemas/fluxdocs.yml' 7 | -------------------------------------------------------------------------------- /src/svc/fluxdocsd/schemas/fluxdocs.yml: -------------------------------------------------------------------------------- 1 | required: 2 | - path 3 | - package 4 | - name 5 | - kind 6 | - headline 7 | - fluxType 8 | properties: 9 | path: 10 | type: string 11 | package: 12 | type: string 13 | name: 14 | type: string 15 | kind: 16 | type: string 17 | headline: 18 | type: string 19 | fluxType: 20 | type: string 21 | description: 22 | type: string 23 | fluxParameters: 24 | type: array 25 | items: 26 | $ref: './fluxdocsParameters.yml' 27 | -------------------------------------------------------------------------------- /src/svc/fluxdocsd/schemas/fluxdocsArray.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './fluxdocs.yml' 4 | -------------------------------------------------------------------------------- /src/svc/fluxdocsd/schemas/fluxdocsParameters.yml: -------------------------------------------------------------------------------- 1 | required: 2 | - headline 3 | - name 4 | - required 5 | properties: 6 | description: 7 | type: string 8 | headline: 9 | type: string 10 | name: 11 | type: string 12 | required: 13 | type: boolean 14 | -------------------------------------------------------------------------------- /src/svc/invocable-scripts/schemas/Params.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | params: 4 | type: object 5 | additionalProperties: 6 | type: string 7 | enum: ["any", "bool", "duration", "float", "int", "string", "time", "uint"] 8 | description: | 9 | The `params` keys and value type defined in the script. 10 | -------------------------------------------------------------------------------- /src/svc/invocable-scripts/schemas/Script.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | readOnly: true 4 | type: string 5 | name: 6 | type: string 7 | description: 8 | type: string 9 | orgID: 10 | type: string 11 | script: 12 | description: The script to execute. 13 | type: string 14 | language: 15 | $ref: './ScriptLanguage.yml' 16 | url: 17 | type: string 18 | description: The invocation endpoint address. 19 | createdAt: 20 | type: string 21 | format: date-time 22 | readOnly: true 23 | updatedAt: 24 | type: string 25 | format: date-time 26 | readOnly: true 27 | required: [name, orgID, script] 28 | -------------------------------------------------------------------------------- /src/svc/invocable-scripts/schemas/ScriptCreateRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | description: Script name. The name must be unique within the organization. 5 | type: string 6 | description: 7 | description: Script description. A description of the script. 8 | type: string 9 | script: 10 | description: The script to execute. 11 | type: string 12 | language: 13 | $ref: './ScriptLanguage.yml' 14 | required: [name, script, language, description] 15 | 16 | -------------------------------------------------------------------------------- /src/svc/invocable-scripts/schemas/ScriptCreateResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "id":"09afa23ff13e4000", 4 | "orgID":"bea7ea952287f70d", 5 | "name":"getLastPoint", 6 | "script":"from(bucket: params.mybucket) |> range(start: -7d) |> limit(n:1)", 7 | "description":"getLastPoint finds the last point in a bucket", 8 | "language":"flux", 9 | "createdAt":"2022-07-17T23:43:26.660308Z", 10 | "updatedAt":"2022-07-17T23:43:26.660308Z" 11 | } 12 | -------------------------------------------------------------------------------- /src/svc/invocable-scripts/schemas/ScriptGetResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "id":"09afa3b220fe4000", 4 | "orgID":"bea7ea952287f70d", 5 | "name":"getLastPoint", 6 | "script":"from(bucket: my-bucket) |> range(start: -7d) |> limit(n:1)", 7 | "description":"getLastPoint finds the last point in a bucket", 8 | "language":"flux", 9 | "createdAt":"2022-07-17T23:49:45.731237Z", 10 | "updatedAt":"2022-07-17T23:49:45.731237Z" 11 | } 12 | -------------------------------------------------------------------------------- /src/svc/invocable-scripts/schemas/ScriptHTTPResponseData.yml: -------------------------------------------------------------------------------- 1 | description: | 2 | The response body contains the results of the executed script. 3 | The response is user-defined and dynamic. 4 | type: string 5 | format: binary 6 | -------------------------------------------------------------------------------- /src/svc/invocable-scripts/schemas/ScriptInvocationParams.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | params: 4 | type: object 5 | additionalProperties: true 6 | description: | 7 | The script parameters. 8 | `params` contains key-value pairs that map values to the **params.keys** 9 | in a script. 10 | When you invoke a script with `params`, InfluxDB passes the values as 11 | invocation parameters to the script. 12 | -------------------------------------------------------------------------------- /src/svc/invocable-scripts/schemas/ScriptInvokeResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: | 3 | ,result,table,_start,_stop,_time,_value,_field,_measurement,host 4 | ,_result,0,2019-10-30T01:28:02.52716421Z,2022-07-26T01:28:02.52716421Z,2020-01-01T00:00:00Z,72.01,used_percent,mem,host2 5 | -------------------------------------------------------------------------------- /src/svc/invocable-scripts/schemas/ScriptLanguage.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | enum: [flux, sql, influxql] 3 | -------------------------------------------------------------------------------- /src/svc/invocable-scripts/schemas/ScriptParamsResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "params": { 4 | "mybucket": "string" 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /src/svc/invocable-scripts/schemas/ScriptUpdateRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | description: 4 | description: A description of the script. 5 | type: string 6 | script: 7 | description: The script to execute. 8 | type: string 9 | -------------------------------------------------------------------------------- /src/svc/invocable-scripts/schemas/ScriptUpdateResponse.yml: -------------------------------------------------------------------------------- 1 | successResponse: 2 | value: { 3 | "id":"09afa3b220fe4000", 4 | "orgID":"bea7ea952287f70d", 5 | "name":"getLastPoint", 6 | "script":"from(bucket: newBucket) |> range(start: -7d) |> limit(n:1)", 7 | "description":"get last point from new bucket", 8 | "language":"flux", 9 | "createdAt":"2022-07-17T23:49:45.731237Z", 10 | "updatedAt":"2022-07-19T22:27:23.185436Z" 11 | } 12 | -------------------------------------------------------------------------------- /src/svc/invocable-scripts/schemas/Scripts.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | scripts: 4 | type: array 5 | items: 6 | $ref: './Script.yml' 7 | -------------------------------------------------------------------------------- /src/svc/mapsd/paths/mapToken.yml: -------------------------------------------------------------------------------- 1 | get: 2 | summary: Get a mapbox token 3 | operationId: getMapboxToken 4 | responses: 5 | '200': 6 | description: Temporary token for Mapbox. 7 | content: 8 | application/json: 9 | schema: 10 | $ref: "../schemas/Token.yml" 11 | '401': 12 | $ref: "../../../common/responses/ServerError.yml" 13 | '500': 14 | $ref: "../../../common/responses/ServerError.yml" 15 | default: 16 | $ref: "../../../common/responses/ServerError.yml" 17 | -------------------------------------------------------------------------------- /src/svc/mapsd/schemas/Token.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | token: 4 | type: string 5 | -------------------------------------------------------------------------------- /src/svc/nifid/paths/broker_subs_status.yml: -------------------------------------------------------------------------------- 1 | get: 2 | summary: get Status of all Subscription records in org 3 | operationId: getAllSubscriptionsStatus 4 | tags: 5 | - Subscriptions Status 6 | responses: 7 | '200': 8 | description: returns Status of all Subscription records in org 9 | content: 10 | application/json: 11 | schema: 12 | $ref: '../schemas/SubscriptionStatusArray.yml' 13 | '401': 14 | $ref: '../../../common/responses/ServerError.yml' 15 | '500': 16 | $ref: '../../../common/responses/ServerError.yml' 17 | -------------------------------------------------------------------------------- /src/svc/nifid/requestBodies/SubscriptionParams.yml: -------------------------------------------------------------------------------- 1 | description: Subscription record 2 | required: true 3 | content: 4 | application/json: 5 | schema: 6 | $ref: "../schemas/SubscriptionParams.yml" 7 | -------------------------------------------------------------------------------- /src/svc/nifid/requestBodies/SubscriptionRunStatus.yml: -------------------------------------------------------------------------------- 1 | description: Subscription run status 2 | required: true 3 | content: 4 | application/json: 5 | schema: 6 | $ref: "../schemas/SubscriptionRunStatus.yml" 7 | -------------------------------------------------------------------------------- /src/svc/nifid/schemas/JsonSpec.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | path: 4 | type: string 5 | name: 6 | type: string 7 | type: 8 | type: string 9 | -------------------------------------------------------------------------------- /src/svc/nifid/schemas/StringObject.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | pattern: 4 | type: string 5 | name: 6 | type: string 7 | -------------------------------------------------------------------------------- /src/svc/nifid/schemas/SubscriptionArray.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: "./Subscription.yml" 4 | -------------------------------------------------------------------------------- /src/svc/nifid/schemas/SubscriptionRunStatus.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | isActive: 3 | type: boolean 4 | -------------------------------------------------------------------------------- /src/svc/nifid/schemas/SubscriptionStatus.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | isActive: 3 | type: boolean 4 | processors: 5 | type: object 6 | processGroupID: 7 | type: string 8 | id: 9 | type: string 10 | required: 11 | - id 12 | -------------------------------------------------------------------------------- /src/svc/nifid/schemas/SubscriptionStatusArray.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | subscriptions: 3 | type: array 4 | items: 5 | $ref: "./SubscriptionStatus.yml" 6 | -------------------------------------------------------------------------------- /src/svc/nifid/schemas/Subscriptions.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | subscriptions: 3 | type: array 4 | items: 5 | $ref: "./Subscription.yml" 6 | -------------------------------------------------------------------------------- /src/svc/notebooksd/paths/api_share_id.yml: -------------------------------------------------------------------------------- 1 | get: 2 | summary: get a notebook by an accessID 3 | operationId: getSharedNotebook 4 | tags: 5 | - Unauthenticated 6 | parameters: 7 | - name: id 8 | in: path 9 | schema: 10 | type: string 11 | required: true 12 | responses: 13 | '200': 14 | description: returns the shared Notebook record 15 | content: 16 | application/json: 17 | schema: 18 | $ref: '../schemas/Notebook.yml' 19 | '400': 20 | $ref: '../../../common/responses/ServerError.yml' 21 | '401': 22 | $ref: '../../../common/responses/ServerError.yml' 23 | '500': 24 | $ref: '../../../common/responses/ServerError.yml' 25 | -------------------------------------------------------------------------------- /src/svc/notebooksd/paths/notebooks_share_id.yml: -------------------------------------------------------------------------------- 1 | delete: 2 | summary: deletes a single Share by its ID 3 | operationId: deleteShare 4 | tags: 5 | - Share 6 | parameters: 7 | - name: id 8 | in: path 9 | schema: 10 | type: string 11 | required: true 12 | responses: 13 | '204': 14 | $ref: '../../../common/responses/ServerError.yml' 15 | '400': 16 | $ref: '../../../common/responses/ServerError.yml' 17 | '401': 18 | $ref: '../../../common/responses/ServerError.yml' 19 | '404': 20 | $ref: '../../../common/responses/ServerError.yml' 21 | '500': 22 | $ref: '../../../common/responses/ServerError.yml' 23 | -------------------------------------------------------------------------------- /src/svc/notebooksd/requestBodies/NotebookParams.yml: -------------------------------------------------------------------------------- 1 | description: Notebook record 2 | required: true 3 | content: 4 | application/json: 5 | schema: 6 | $ref: '../schemas/NotebookParams.yml' 7 | -------------------------------------------------------------------------------- /src/svc/notebooksd/requestBodies/ShareParams.yml: -------------------------------------------------------------------------------- 1 | description: Share record 2 | required: true 3 | content: 4 | application/json: 5 | schema: 6 | $ref: '../schemas/ShareParams.yml' 7 | -------------------------------------------------------------------------------- /src/svc/notebooksd/schemas/Notebook.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | type: string 4 | isDirty: 5 | type: boolean 6 | description: flag set to determine whether a notebook has been published or not? 7 | name: 8 | type: string 9 | orgID: 10 | type: string 11 | spec: 12 | type: object 13 | createdAt: 14 | type: string 15 | format: date-time 16 | createdBy: 17 | type: string 18 | updatedAt: 19 | type: string 20 | format: date-time 21 | -------------------------------------------------------------------------------- /src/svc/notebooksd/schemas/NotebookArray.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './Notebook.yml' 4 | -------------------------------------------------------------------------------- /src/svc/notebooksd/schemas/NotebookParams.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | name: 3 | type: string 4 | orgID: 5 | type: string 6 | spec: 7 | type: object 8 | -------------------------------------------------------------------------------- /src/svc/notebooksd/schemas/NotebookVersion.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | notebookVersion: 3 | $ref: "./Notebook.yml" 4 | -------------------------------------------------------------------------------- /src/svc/notebooksd/schemas/Notebooks.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | flows: 3 | type: array 4 | items: 5 | $ref: './Notebook.yml' 6 | -------------------------------------------------------------------------------- /src/svc/notebooksd/schemas/Share.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | type: string 4 | orgID: 5 | type: string 6 | notebookID: 7 | type: string 8 | accessID: 9 | type: string 10 | region: 11 | type: string 12 | createdAt: 13 | type: string 14 | format: date-time 15 | updatedAt: 16 | type: string 17 | format: date-time 18 | -------------------------------------------------------------------------------- /src/svc/notebooksd/schemas/ShareParams.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | notebookID: 3 | type: string 4 | orgID: 5 | type: string 6 | region: 7 | type: string 8 | -------------------------------------------------------------------------------- /src/svc/notebooksd/schemas/Shares.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './Share.yml' 4 | -------------------------------------------------------------------------------- /src/svc/notebooksd/schemas/VersionHistories.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './VersionHistory.yml' 4 | -------------------------------------------------------------------------------- /src/svc/notebooksd/schemas/VersionHistory.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | type: string 4 | description: the ID of the published version 5 | publishedAt: 6 | type: string 7 | format: date-time 8 | description: the time the data was published 9 | publishedBy: 10 | type: string 11 | description: the name of the person that published the notebook 12 | required: 13 | - id 14 | - publishedAt 15 | - publishedBy 16 | -------------------------------------------------------------------------------- /src/svc/uiproxyd/paths/mapToken.yml: -------------------------------------------------------------------------------- 1 | get: 2 | summary: Get a mapbox token 3 | operationId: getMapboxToken 4 | responses: 5 | '200': 6 | description: Used to get a 1 hour temp token for Mapbox using secret token 7 | content: 8 | application/json: 9 | schema: 10 | $ref: "../schemas/Token.yml" 11 | '401': 12 | $ref: "../../../common/responses/ServerError.yml" 13 | '500': 14 | $ref: "../../../common/responses/ServerError.yml" 15 | default: 16 | $ref: "../../../common/responses/ServerError.yml" 17 | -------------------------------------------------------------------------------- /src/svc/uiproxyd/paths/quartzLoginUrl.yml: -------------------------------------------------------------------------------- 1 | get: 2 | summary: Retrieves the value of the Quartz Login URL 3 | operationId: getQuartzLoginUrl 4 | responses: 5 | '200': 6 | description: Returns the login URL for the current environment 7 | '401': 8 | $ref: '../../../common/responses/AuthorizationError.yml' 9 | '500': 10 | $ref: '../../../common/responses/InternalServerError.yml' 11 | -------------------------------------------------------------------------------- /src/svc/uiproxyd/paths/sfdcSupport.yml: -------------------------------------------------------------------------------- 1 | post: 2 | summary: Creates a new issue in the SFDC support queue 3 | operationId: postSFDCSupport 4 | requestBody: 5 | required: true 6 | $ref: '../requestBodies/SFDCSupportParams.yml' 7 | responses: 8 | '204': 9 | description: Success. The support request was created by SalesForce 10 | '401': 11 | $ref: '../../../common/responses/AuthorizationError.yml' 12 | '500': 13 | $ref: '../../../common/responses/InternalServerError.yml' 14 | -------------------------------------------------------------------------------- /src/svc/uiproxyd/requestBodies/SFDCSupportParams.yml: -------------------------------------------------------------------------------- 1 | description: User input to create an SFDC Support Ticket 2 | required: true 3 | content: 4 | application/json: 5 | schema: 6 | $ref: '../schemas/SFDCSupport.yml' 7 | -------------------------------------------------------------------------------- /src/svc/uiproxyd/schemas/SFDCSupport.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | description: 3 | type: string 4 | email: 5 | type: string 6 | severity: 7 | type: string 8 | subject: 9 | type: string 10 | -------------------------------------------------------------------------------- /src/svc/uiproxyd/schemas/Token.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | token: 4 | type: string 5 | -------------------------------------------------------------------------------- /src/unity/paths/account.yml: -------------------------------------------------------------------------------- 1 | delete: 2 | operationId: DeleteAccount 3 | summary: Self-delete account 4 | requestBody: 5 | content: 6 | application/json; charset=utf-8: 7 | schema: 8 | type: object 9 | responses: 10 | '204': 11 | description: Account deleted 12 | '401': 13 | description: Unauthorized/Account doesn't exist 14 | $ref: '../../common/responses/ServerError.yml' 15 | '403': 16 | description: Account is not deletable 17 | $ref: '../../common/responses/ServerError.yml' 18 | default: 19 | description: Unexpected error 20 | $ref: '../../common/responses/ServerError.yml' 21 | -------------------------------------------------------------------------------- /src/unity/paths/accounts.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetAccounts 3 | tags: 4 | - Accounts 5 | summary: Get the list of accounts for the current user 6 | responses: 7 | '200': 8 | description: Accounts 9 | content: 10 | application/json: 11 | schema: 12 | $ref: '../schemas/UserAccounts.yml' 13 | '401': 14 | description: Unauthorized 15 | $ref: '../../common/responses/ServerError.yml' 16 | default: 17 | description: Unexpected error 18 | $ref: '../../common/responses/ServerError.yml' 19 | -------------------------------------------------------------------------------- /src/unity/paths/accounts_default.yml: -------------------------------------------------------------------------------- 1 | put: 2 | operationId: PutDefaultAccount 3 | tags: 4 | - Accounts 5 | requestBody: 6 | description: The account to set as the user's default account 7 | required: true 8 | content: 9 | application/json: 10 | schema: 11 | $ref: '../schemas/AccountsDefaultRequest.yml' 12 | responses: 13 | '204': 14 | description: default account set 15 | default: 16 | description: Unexpected error 17 | $ref: '../../common/responses/ServerError.yml' 18 | -------------------------------------------------------------------------------- /src/unity/paths/allowances_org_create.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetAllowancesOrgsCreate 3 | tags: 4 | - Allowances 5 | - Organizations 6 | summary: Return whether a new Organization can be created. 7 | parameters: 8 | - $ref: "../../common/parameters/TraceSpan.yml" 9 | responses: 10 | "200": 11 | description: The Allowance 12 | content: 13 | application/json: 14 | schema: 15 | $ref: "../schemas/Allowance.yml" 16 | -------------------------------------------------------------------------------- /src/unity/paths/billing.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetBilling 3 | tags: 4 | - Billing 5 | responses: 6 | '200': 7 | description: Billing information for account 8 | content: 9 | application/json: 10 | schema: 11 | $ref: '../schemas/BillingInfo.yml' 12 | default: 13 | description: Unexpected error 14 | $ref: '../../common/responses/ServerError.yml' 15 | -------------------------------------------------------------------------------- /src/unity/paths/billing_contact.yml: -------------------------------------------------------------------------------- 1 | put: 2 | operationId: PutBillingContact 3 | tags: 4 | - Billing 5 | requestBody: 6 | description: BillingContact to update 7 | required: true 8 | content: 9 | application/json: 10 | schema: 11 | $ref: '../schemas/BillingContact.yml' 12 | responses: 13 | '200': 14 | description: billing contact updated 15 | content: 16 | application/json: 17 | schema: 18 | $ref: '../schemas/BillingContact.yml' 19 | default: 20 | description: Unexpected error 21 | $ref: '../../common/responses/ServerError.yml' 22 | -------------------------------------------------------------------------------- /src/unity/paths/billing_invoices.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetInvoices 3 | tags: 4 | - Billing 5 | responses: 6 | '200': 7 | description: A list of invoices 8 | content: 9 | application/json: 10 | schema: 11 | $ref: '../schemas/Invoices.yml' 12 | '401': 13 | description: Unauthorized 14 | $ref: '../../common/responses/ServerError.yml' 15 | default: 16 | description: Unexpected error 17 | $ref: '../../common/responses/ServerError.yml' 18 | -------------------------------------------------------------------------------- /src/unity/paths/billing_payment_method.yml: -------------------------------------------------------------------------------- 1 | put: 2 | operationId: PutPaymentMethod 3 | tags: 4 | - Billing 5 | requestBody: 6 | description: PaymentMethod to update 7 | required: true 8 | content: 9 | application/json: 10 | schema: 11 | $ref: '../schemas/PaymentMethodPut.yml' 12 | responses: 13 | '200': 14 | description: Payment method updated 15 | content: 16 | application/json: 17 | schema: 18 | $ref: '../schemas/PaymentMethod.yml' 19 | default: 20 | description: Unexpected error 21 | $ref: '../../common/responses/ServerError.yml' 22 | -------------------------------------------------------------------------------- /src/unity/paths/billing_start_date.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetBillingStartDate 3 | tags: 4 | - Billing 5 | responses: 6 | '200': 7 | description: Start of the current billing period for the Account 8 | content: 9 | application/json: 10 | schema: 11 | $ref: '../schemas/BillingDate.yml' 12 | default: 13 | description: Unexpected error 14 | $ref: '../../common/responses/ServerError.yml' 15 | -------------------------------------------------------------------------------- /src/unity/paths/cancel.yml: -------------------------------------------------------------------------------- 1 | post: 2 | operationId: PostCancel 3 | description: Cancel an account 4 | requestBody: 5 | content: 6 | application/json; charset=utf-8: 7 | schema: 8 | type: object 9 | tags: 10 | - Accounts 11 | responses: 12 | '204': 13 | description: Account cancelled 14 | default: 15 | description: Unexpected error 16 | $ref: '../../common/responses/ServerError.yml' 17 | -------------------------------------------------------------------------------- /src/unity/paths/clusters.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetClusters 3 | tags: 4 | - Clusters 5 | summary: Get the list of clusters 6 | responses: 7 | '200': 8 | description: Clusters 9 | content: 10 | application/json: 11 | schema: 12 | $ref: '../schemas/Clusters.yml' 13 | '401': 14 | description: Unauthorized 15 | $ref: '../../common/responses/ServerError.yml' 16 | default: 17 | description: Unexpected error 18 | $ref: '../../common/responses/ServerError.yml' 19 | -------------------------------------------------------------------------------- /src/unity/paths/identity.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetIdentity 3 | tags: 4 | - Identity 5 | - User 6 | - Account 7 | - Organization 8 | responses: 9 | '200': 10 | description: identity represented by the active user, account, and org 11 | content: 12 | application/json: 13 | schema: 14 | $ref: '../schemas/Identity.yml' 15 | '401': 16 | description: Unauthorized 17 | $ref: '../../common/responses/ServerError.yml' 18 | default: 19 | description: Unexpected error 20 | $ref: '../../common/responses/ServerError.yml' 21 | -------------------------------------------------------------------------------- /src/unity/paths/marketplace.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetMarketplace 3 | tags: 4 | - Marketplace 5 | responses: 6 | '200': 7 | description: Marketplace information for account 8 | content: 9 | application/json: 10 | schema: 11 | $ref: '../schemas/Marketplace.yml' 12 | '401': 13 | description: Not Authorized or Invalid Session 14 | $ref: '../../common/responses/ServerError.yml' 15 | '404': 16 | description: Marketplace not found 17 | $ref: '../../common/responses/ServerError.yml' 18 | default: 19 | description: Unexpected error 20 | $ref: '../../common/responses/ServerError.yml' 21 | -------------------------------------------------------------------------------- /src/unity/paths/operator_providers.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetProvidersInfo 3 | tags: 4 | - Operators 5 | - Regions 6 | - Providers 7 | summary: Get a list of providers and their regions 8 | responses: 9 | '200': 10 | description: Provider and Region Info 11 | content: 12 | application/json: 13 | schema: 14 | $ref: '../schemas/OperatorProvidersResponse.yml' 15 | '401': 16 | description: Unauthorized 17 | $ref: '../../common/responses/ServerError.yml' 18 | default: 19 | description: Unexpected error 20 | $ref: '../../common/responses/ServerError.yml' 21 | -------------------------------------------------------------------------------- /src/unity/paths/sso.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetConnection 3 | tags: 4 | - Connection 5 | parameters: 6 | - $ref: '../../common/parameters/TraceSpan.yml' 7 | - in: query 8 | name: email 9 | schema: 10 | type: string 11 | format: email 12 | required: true 13 | description: The email to get connection for. 14 | responses: 15 | "200": 16 | content: 17 | application/json: 18 | schema: 19 | type: string 20 | example: connection 21 | description: Connection name as string 22 | "204": 23 | description: No connection for the specified email 24 | default: 25 | description: Unexpected error 26 | $ref: '../../common/responses/ServerError.yml' 27 | summary: Get connection for the specified email 28 | -------------------------------------------------------------------------------- /src/unity/paths/usage_vectors.yml: -------------------------------------------------------------------------------- 1 | get: 2 | operationId: GetUsageVectors 3 | tags: 4 | - Usage 5 | responses: 6 | '200': 7 | description: List of usage vectors for the account 8 | content: 9 | application/json: 10 | schema: 11 | $ref: '../schemas/UsageVectors.yml' 12 | '401': 13 | description: Unauthorized 14 | $ref: '../../common/responses/ServerError.yml' 15 | '404': 16 | description: Pricing version not 4 or User/Org not found 17 | $ref: '../../common/responses/ServerError.yml' 18 | default: 19 | description: Unexpected error 20 | $ref: '../../common/responses/ServerError.yml' 21 | -------------------------------------------------------------------------------- /src/unity/schemas/Account.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | type: number 4 | description: account id in quartz 5 | name: 6 | type: string 7 | description: name of the account 8 | type: 9 | type: string 10 | enum: [contract, free, pay_as_you_go] 11 | description: the type of the account 12 | billingProvider: 13 | type: string 14 | nullable: true 15 | enum: [aws, azure, gcm, zuora] 16 | description: the billing provider of the account. null if a free account 17 | isDeletable: 18 | type: boolean 19 | description: determines if the account can be deleted 20 | required: 21 | - id 22 | - name 23 | -------------------------------------------------------------------------------- /src/unity/schemas/AccountType.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | description: type of the account 3 | enum: 4 | - cancelled 5 | - contract 6 | - free 7 | - pay_as_you_go 8 | -------------------------------------------------------------------------------- /src/unity/schemas/AccountUpdate.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | name: 3 | type: string 4 | description: name of the account 5 | required: 6 | - name 7 | -------------------------------------------------------------------------------- /src/unity/schemas/AccountsDefaultRequest.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | type: number 4 | description: account id in quartz 5 | required: 6 | [id] 7 | -------------------------------------------------------------------------------- /src/unity/schemas/Allowance.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | allowed: 3 | type: boolean 4 | description: is the operation allowed? 5 | availableUpgrade: 6 | $ref: './UpgradeOption.yml' 7 | description: what upgrade option is available for this allowance? 8 | required: 9 | - allowed 10 | - availableUpgrade 11 | -------------------------------------------------------------------------------- /src/unity/schemas/BillingDate.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | dateTime: 3 | type: string 4 | description: UTC datetime representing the start of the billing period for the account 5 | required: [dateTime] 6 | -------------------------------------------------------------------------------- /src/unity/schemas/BillingInfo.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | balance: 3 | type: number 4 | description: account balance 5 | paymentMethod: 6 | $ref: './PaymentMethod.yml' 7 | balanceUpdatedAt: 8 | type: string 9 | description: date of last update to account 10 | contact: 11 | $ref: './BillingContact.yml' 12 | required: [balance, balanceUpdatedAt, contact] 13 | -------------------------------------------------------------------------------- /src/unity/schemas/BillingNotifySettings.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | isNotify: 3 | description: opt in to threshold notifications 4 | type: boolean 5 | balanceThreshold: 6 | type: number 7 | description: threshold that when passed will trigger a notification 8 | notifyEmail: 9 | type: string 10 | description: email to send notification 11 | required: [isNotify, balanceThreshold, notifyEmail] 12 | -------------------------------------------------------------------------------- /src/unity/schemas/Clusters.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './Cluster.yml' 4 | -------------------------------------------------------------------------------- /src/unity/schemas/Entitlements.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './Entitlement.yml' 4 | -------------------------------------------------------------------------------- /src/unity/schemas/Identity.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | user: 3 | $ref: './IdentityUser.yml' 4 | account: 5 | $ref: './IdentityAccount.yml' 6 | org: 7 | $ref: './IdentityOrganization.yml' 8 | required: 9 | - user 10 | - account 11 | - org 12 | -------------------------------------------------------------------------------- /src/unity/schemas/IdentityOrganization.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | type: string 4 | description: idpe ID of the org 5 | name: 6 | type: string 7 | description: name of the org 8 | clusterHost: 9 | type: string 10 | description: the url of the current cluster 11 | required: 12 | - id 13 | - name 14 | - clusterHost 15 | -------------------------------------------------------------------------------- /src/unity/schemas/Invite.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | description: the quartz id of the invite 4 | readOnly: true 5 | type: number 6 | email: 7 | type: string 8 | role: 9 | $ref: './Role.yml' 10 | expiresAt: 11 | description: when the invite will expire 12 | readOnly: true 13 | format: date-time 14 | type: string 15 | required: [email, role] 16 | -------------------------------------------------------------------------------- /src/unity/schemas/Invites.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './Invite.yml' 4 | -------------------------------------------------------------------------------- /src/unity/schemas/Invoice.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | description: id of the invoice 4 | type: string 5 | status: 6 | description: status of the invoice 7 | readOnly: true 8 | type: string 9 | amount: 10 | description: amount of invoice in dollars 11 | type: number 12 | readOnly: true 13 | targetDate: 14 | description: date of invoice 15 | readOnly: true 16 | type: string 17 | required: [id, status, amount, targetDate] 18 | -------------------------------------------------------------------------------- /src/unity/schemas/Invoices.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './Invoice.yml' 4 | -------------------------------------------------------------------------------- /src/unity/schemas/Marketplace.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | name: 3 | description: full name of the marketplace 4 | type: string 5 | example: Google Cloud Marketplace 6 | shortName: 7 | description: marketplace acronyms 8 | $ref: './MarketplaceType.yml' 9 | example: gcm 10 | url: 11 | description: link to marketplace 12 | type: string 13 | required: [name, shortName, url] 14 | -------------------------------------------------------------------------------- /src/unity/schemas/MarketplaceSubscription.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | marketplace: 3 | $ref: './MarketplaceType.yml' 4 | status: 5 | type: string 6 | enum: 7 | - pending 8 | - subscribed 9 | - unsubscribed 10 | - failed 11 | description: status of the marketplace 12 | subscriberId: 13 | type: string 14 | required: [marketplace, status, subscriberId] 15 | -------------------------------------------------------------------------------- /src/unity/schemas/MarketplaceType.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | description: marketplace acronym or name 3 | enum: 4 | - aws 5 | - gcm 6 | - azure 7 | -------------------------------------------------------------------------------- /src/unity/schemas/OperatorAccountConvertRequest.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | contractStartDate: 3 | type: string 4 | format: date-time 5 | description: the date the contract starts (YYYY-MM-DD) 6 | required: 7 | [contractStartDate] 8 | -------------------------------------------------------------------------------- /src/unity/schemas/OperatorAccounts.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './OperatorAccount.yml' 4 | -------------------------------------------------------------------------------- /src/unity/schemas/OperatorOrganizations.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './OperatorOrganization.yml' 4 | -------------------------------------------------------------------------------- /src/unity/schemas/OperatorProvider.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | provider: 4 | type: string 5 | description: name of the provider 6 | title: 7 | type: string 8 | description: title of the provider 9 | isAvailable: 10 | type: boolean 11 | description: the availability of the provider 12 | required: [provider, title, isAvailable] 13 | -------------------------------------------------------------------------------- /src/unity/schemas/OperatorProviders.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './OperatorProvider.yml' 4 | -------------------------------------------------------------------------------- /src/unity/schemas/OperatorProvidersResponse.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | providers: 4 | $ref: './OperatorProviders.yml' 5 | regions: 6 | $ref: './OperatorRegionInfo.yml' 7 | required: [providers, regions] 8 | -------------------------------------------------------------------------------- /src/unity/schemas/OperatorRegion.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | region: 4 | type: string 5 | description: the name of the region 6 | title: 7 | type: string 8 | description: the title of the region 9 | provider: 10 | type: string 11 | description: the provider the region belong to 12 | priority: 13 | type: integer 14 | description: the order priority of the region 15 | isAvailable: 16 | type: boolean 17 | description: the availability of the provider 18 | isPrivate: 19 | type: boolean 20 | description: determines if the region is a private region 21 | required: [region, title, provider, priority, isAvailable, isPrivate] 22 | -------------------------------------------------------------------------------- /src/unity/schemas/OperatorRegionInfo.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | Azure: 4 | $ref: './OperatorRegions.yml' 5 | AWS: 6 | $ref: './OperatorRegions.yml' 7 | GCM: 8 | $ref: './OperatorRegions.yml' 9 | -------------------------------------------------------------------------------- /src/unity/schemas/OperatorRegions.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './OperatorRegion.yml' 4 | -------------------------------------------------------------------------------- /src/unity/schemas/OperatorUser.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | email: 3 | type: string 4 | description: user's email 5 | firstName: 6 | type: string 7 | description: user's first name 8 | id: 9 | type: string 10 | description: user's id in quartz 11 | idpeId: 12 | type: string 13 | description: user's id in idpe 14 | lastName: 15 | type: string 16 | description: user's last name 17 | operator: 18 | type: boolean 19 | description: whether or not the user is an operator 20 | sfdcContactId: 21 | type: string 22 | description: the contact id of the user in salesforce 23 | required: [firstName, id, idpeId, lastName] 24 | -------------------------------------------------------------------------------- /src/unity/schemas/OperatorUsers.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './OperatorUser.yml' 4 | -------------------------------------------------------------------------------- /src/unity/schemas/OrgUser.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | description: the idpe id of the user 4 | readOnly: true 5 | type: string 6 | firstName: 7 | type: string 8 | lastName: 9 | type: string 10 | email: 11 | type: string 12 | role: 13 | $ref: './Role.yml' 14 | required: [id, firstName, lastName, email, role] 15 | -------------------------------------------------------------------------------- /src/unity/schemas/OrgUsers.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './OrgUser.yml' 4 | -------------------------------------------------------------------------------- /src/unity/schemas/OrganizationCreateRequest.yml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | orgName: 4 | description: name of the organization 5 | type: string 6 | provider: 7 | description: name of the cloud provider 8 | type: string 9 | enum: 10 | - AWS 11 | - GCP 12 | - Azure 13 | region: 14 | description: name of the region within the cloud provider 15 | type: string 16 | required: [orgName, provider, region] 17 | -------------------------------------------------------------------------------- /src/unity/schemas/OrganizationDefaultRequest.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | type: string 4 | description: IDPE id of the organization 5 | required: 6 | [id] 7 | -------------------------------------------------------------------------------- /src/unity/schemas/OrganizationState.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | description: State of an organization 3 | enum: 4 | - pending 5 | - provisioned 6 | - suspended 7 | -------------------------------------------------------------------------------- /src/unity/schemas/OrganizationSummaries.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './OrganizationSummary.yml' 4 | -------------------------------------------------------------------------------- /src/unity/schemas/OrganizationUpdate.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | name: 3 | type: string 4 | description: The name of the organization. 5 | description: 6 | type: string 7 | description: The description of the organization. 8 | -------------------------------------------------------------------------------- /src/unity/schemas/OrganizationWithToken.yml: -------------------------------------------------------------------------------- 1 | allOf: 2 | - $ref: "./Organization.yml" 3 | - type: object 4 | properties: 5 | token: 6 | description: Authentication token to manage the organization and its resources in IDPE 7 | readOnly: true 8 | type: string 9 | links: 10 | description: Links to the IDPE resources for this organization 11 | readOnly: true 12 | type: object 13 | example: { "resource": "path/to/resource" } 14 | -------------------------------------------------------------------------------- /src/unity/schemas/PaymentFormType.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | description: The name of the PaymentForm to query. 3 | example: 'checkout' 4 | enum: 5 | - checkout 6 | - billing 7 | -------------------------------------------------------------------------------- /src/unity/schemas/PaymentMethod.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | cardType: 3 | description: name of credit card vendor 4 | type: string 5 | cardNumber: 6 | description: masked credit card number 7 | type: string 8 | expirationMonth: 9 | description: month of expiration 10 | type: string 11 | expirationYear: 12 | description: year of expiration 13 | type: string 14 | defaultPaymentMethod: 15 | description: this the default payment method 16 | type: boolean 17 | required: [cardType, cardNumber, expirationMonth, expirationYear] 18 | -------------------------------------------------------------------------------- /src/unity/schemas/PaymentMethodPut.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | paymentMethodId: 3 | type: string 4 | description: ref id from Zuora 5 | readOnly: true 6 | -------------------------------------------------------------------------------- /src/unity/schemas/Region.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | title: 3 | type: string 4 | description: title of the region 5 | required: [title] 6 | -------------------------------------------------------------------------------- /src/unity/schemas/RelatedAccount.yml: -------------------------------------------------------------------------------- 1 | description: Subset of Account data related to the organization 2 | type: object 3 | properties: 4 | id: 5 | type: number 6 | description: account id in quartz 7 | type: 8 | $ref: './AccountType.yml' 9 | balance: 10 | type: number 11 | description: remaining balance on the account, nil if none 12 | billingContact: 13 | $ref: './BillingContact.yml' 14 | description: billing contact for the account 15 | updatedAt: 16 | type: string 17 | description: date of last update to account 18 | required: [id, balance, type, updatedAt] 19 | -------------------------------------------------------------------------------- /src/unity/schemas/Role.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | description: Role of the User 3 | enum: 4 | - owner 5 | - member 6 | -------------------------------------------------------------------------------- /src/unity/schemas/StorageType.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | description: Storage type of an organization 3 | enum: 4 | - tsm 5 | - iox 6 | -------------------------------------------------------------------------------- /src/unity/schemas/TimeRange.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | description: The timerange options for usage information 3 | enum: 4 | - 24h 5 | - 1d 6 | - 2d 7 | - 3d 8 | - 4d 9 | - 5d 10 | - 6d 11 | - 7d 12 | - 8d 13 | - 9d 14 | - 10d 15 | - 11d 16 | - 12d 17 | - 13d 18 | - 14d 19 | - 15d 20 | - 16d 21 | - 17d 22 | - 18d 23 | - 19d 24 | - 20d 25 | - 21d 26 | - 22d 27 | - 23d 28 | - 24d 29 | - 25d 30 | - 26d 31 | - 27d 32 | - 28d 33 | - 29d 34 | - 30d 35 | default: 24h 36 | -------------------------------------------------------------------------------- /src/unity/schemas/UpgradeOption.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | description: Type of account upgrade available 3 | enum: 4 | - contract 5 | - none 6 | - pay_as_you_go 7 | -------------------------------------------------------------------------------- /src/unity/schemas/UsageVector.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | name: 3 | description: name of usage vector 4 | type: string 5 | example: 'storage' 6 | unit: 7 | description: unit for usage vector 8 | type: string 9 | example: 'GB-hr' 10 | fluxKey: 11 | description: key in flux response 12 | type: string 13 | example: 'storage_gb' 14 | required: [name, unit, fluxKey] 15 | -------------------------------------------------------------------------------- /src/unity/schemas/UsageVectors.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './UsageVector.yml' 4 | -------------------------------------------------------------------------------- /src/unity/schemas/User.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | email: 3 | type: string 4 | description: user's email 5 | firstName: 6 | type: string 7 | description: user's first name 8 | id: 9 | type: string 10 | description: user's id in idpe 11 | lastName: 12 | type: string 13 | description: user's last name 14 | required: [firstName, id, idpeId, lastName] 15 | -------------------------------------------------------------------------------- /src/unity/schemas/UserAccount.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | id: 3 | type: number 4 | description: account id in quartz 5 | isActive: 6 | type: boolean 7 | description: is this the currently active account in the session? 8 | isDefault: 9 | type: boolean 10 | description: is this the user's default account? 11 | name: 12 | type: string 13 | description: name of the account 14 | required: 15 | - id 16 | - isActive 17 | - isDefault 18 | - name 19 | -------------------------------------------------------------------------------- /src/unity/schemas/UserAccounts.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './UserAccount.yml' 4 | -------------------------------------------------------------------------------- /src/unity/schemas/UserPatchRequest.yml: -------------------------------------------------------------------------------- 1 | properties: 2 | firstName: 3 | type: string 4 | description: user's first name 5 | lastName: 6 | type: string 7 | description: user's last name 8 | -------------------------------------------------------------------------------- /src/unity/schemas/Users.yml: -------------------------------------------------------------------------------- 1 | type: array 2 | items: 3 | $ref: './User.yml' 4 | -------------------------------------------------------------------------------- /src/unity/schemas/VectorName.yml: -------------------------------------------------------------------------------- 1 | type: string 2 | description: The name of the usage vector. 3 | enum: 4 | - storage_gb 5 | - writes_mb 6 | - reads_gb 7 | - query_count 8 | --------------------------------------------------------------------------------