Skip to content

Instantly share code, notes, and snippets.

@thecraftman

thecraftman/swagger.yml

Created February 23, 2022 10:46
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save thecraftman/9a9f003ddddf746a768fc3ac4427d5ad to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save thecraftman/9a9f003ddddf746a768fc3ac4427d5ad to your computer and use it in GitHub Desktop.
Download ZIP
Axiom Swagger
Raw
swagger.yml
basePath: /api/v1
consumes:
- application/json
definitions:
APLRequestWithOptions:
properties:
apl:
type: string
datasetMap:
additionalProperties:
type: string
description: DatasetMap is an optional mapping used to replace dataset names
in the query.
type: object
endTime:
type: string
queryOptions:
$ref: '#/definitions/QueryOptions'
startTime:
description: |-
start and end time for the query, these must be specified as RFC3339 strings
or using relative time expressions (e.g. now-1h, now-1d, now-1w, etc)
type: string
required:
- apl
type: object
Aggregation:
properties:
alias:
type: string
argument:
type: object
field:
type: string
op:
enum:
- count
- distinct
- sum
- avg
- min
- max
- topk
- percentiles
- histogram
- stdev
- variance
type: string
required:
- op
- field
type: object
AplQuery:
properties:
apl:
type: string
datasetMap:
additionalProperties:
type: string
description: DatasetMap is an optional mapping used to replace dataset names
in the query.
type: object
endTime:
type: string
startTime:
description: |-
start and end time for the query, these must be specified as RFC3339 strings
or using relative time expressions (e.g. now-1h, now-1d, now-1w, etc)
type: string
required:
- apl
type: object
AplResult:
properties:
buckets:
$ref: '#/definitions/Timeseries'
datasetNames:
items:
type: string
type: array
matches:
items:
$ref: '#/definitions/Entry'
type: array
request:
$ref: '#/definitions/QueryRequest'
status:
$ref: '#/definitions/Status'
required:
- request
- status
- buckets
- datasetNames
type: object
BillingChange:
properties:
paymentMethodID:
type: string
targetPlan:
enum:
- free
- trial
- pro
- enterprise
- comped
type: string
required:
- targetPlan
type: object
CreateDataset:
properties:
description:
type: string
name:
type: string
required:
- name
type: object
CreateTeam:
properties:
datasets:
items:
type: string
type: array
members:
items:
type: string
type: array
name:
type: string
required:
- name
type: object
CreateToken:
properties:
description:
type: string
name:
type: string
permissions:
items:
type: string
type: array
scopes:
items:
type: string
type: array
required:
- name
type: object
CreateUserPayload:
properties:
email:
type: string
name:
type: string
role:
enum:
- owner
- admin
- user
- read-only
type: string
teams:
items:
type: string
type: array
required:
- name
- email
- role
type: object
Dashboard:
properties:
against:
type: string
againstTimestamp:
type: string
charts:
type: object
description:
type: string
layout:
type: object
name:
type: string
owner:
type: string
refreshTime:
format: int64
type: integer
schemaVersion:
format: int64
type: integer
timeWindowEnd:
type: string
timeWindowStart:
type: string
version:
description: used for detecting conflicts on update
type: string
required:
- name
- owner
- refreshTime
- schemaVersion
- timeWindowStart
- timeWindowEnd
type: object
DashboardWithId:
allOf:
- $ref: '#/definitions/Dashboard'
- properties:
id:
type: string
required:
- id
type: object
- $ref: '#/definitions/Dashboard'
- properties:
id:
type: string
required:
- id
type: object
Dataset:
properties:
created:
format: date-time
type: string
fields:
items:
$ref: '#/definitions/Field'
type: array
id:
format: uint64
type: integer
name:
type: string
required:
- id
- name
- created
type: object
DatasetCoreInfo:
properties:
compressedBytes:
format: uint64
type: integer
compressedBytesHuman:
type: string
created:
format: date-time
type: string
fields:
items:
$ref: '#/definitions/DatasetField'
type: array
inputBytes:
format: uint64
type: integer
inputBytesHuman:
type: string
integrationFilters:
$ref: '#/definitions/IntegrationDatasetFilters'
maxTime:
format: date-time
type: string
minTime:
format: date-time
type: string
name:
type: string
numBlocks:
format: uint64
type: integer
numEvents:
format: uint64
type: integer
numFields:
format: uint32
type: integer
quickQueries:
items:
$ref: '#/definitions/IntegrationQuickQuery'
type: array
who:
type: string
required:
- name
- numBlocks
- numEvents
- numFields
- inputBytes
- inputBytesHuman
- compressedBytes
- compressedBytesHuman
- created
- who
type: object
DatasetField:
properties:
description:
type: string
hidden:
type: boolean
name:
type: string
type:
type: string
unit:
type: string
required:
- name
- type
- unit
- hidden
type: object
DatasetFields:
properties:
fields:
items:
$ref: '#/definitions/Field'
type: array
type: object
DatasetInfo:
properties:
compressedBytes:
format: uint64
type: integer
compressedBytesHuman:
type: string
created:
format: date-time
type: string
fields:
items:
$ref: '#/definitions/Field'
type: array
inputBytes:
format: uint64
type: integer
inputBytesHuman:
type: string
maxTime:
format: date-time
type: string
minTime:
format: date-time
type: string
name:
type: string
numBlocks:
format: uint64
type: integer
numEvents:
format: uint64
type: integer
numFields:
format: uint32
type: integer
required:
- name
- numBlocks
- numEvents
- numFields
- inputBytes
- inputBytesHuman
- compressedBytes
- compressedBytesHuman
- created
type: object
DatasetSpec:
properties:
created:
format: date-time
type: string
description:
type: string
id:
type: string
integrationConfigs:
items:
type: string
type: array
name:
type: string
who:
type: string
required:
- id
- name
- description
- created
- who
type: object
ElasticBulkIndex:
properties:
status:
format: int64
type: integer
required:
- status
type: object
ElasticBulkItem:
properties:
index:
$ref: '#/definitions/ElasticBulkIndex'
required:
- index
type: object
ElasticBulkResponse:
properties:
errors:
type: boolean
items:
items:
$ref: '#/definitions/ElasticBulkItem'
type: array
required:
- errors
type: object
Entry:
properties:
_rowId:
type: string
_sysTime:
format: date-time
type: string
_time:
format: date-time
type: string
data:
additionalProperties:
type: object
type: object
required:
- _time
- _sysTime
- _rowId
- data
type: object
EntryGroup:
properties:
aggregations:
items:
$ref: '#/definitions/EntryGroupAgg'
type: array
group:
additionalProperties:
type: object
type: object
id:
format: uint64
type: integer
required:
- id
- group
type: object
EntryGroupAgg:
properties:
op:
type: string
value:
type: object
required:
- op
- value
type: object
Field:
properties:
name:
type: string
type:
type: string
required:
- name
- type
type: object
Filter:
properties:
caseSensitive:
description: 'Supported for these filters: starts-with, not-starts-with, ends-with,
not-ends-with, contains, not-contains, eq, ne.'
type: boolean
children:
description: 'Supported for these filters: and, or, not.'
items:
$ref: '#/definitions/Filter'
type: array
field:
type: string
op:
description: we also support '==', but we're not exporting that to swagger,
cause it can't deal with it
enum:
- and
- or
- not
- eq
- '!='
- ne
- exists
- not-exists
- '>'
- '>='
- <
- <=
- gt
- gte
- lt
- lte
- starts-with
- not-starts-with
- ends-with
- not-ends-with
- contains
- not-contains
- regexp
- not-regexp
type: string
value:
type: object
required:
- field
- op
type: object
Health:
properties:
syslogHealthState:
enum:
- Green
- Amber
- Red
type: string
required:
- syslogHealthState
type: object
Info:
properties:
datasetLimit:
format: int64
type: integer
fieldLimit:
format: int64
type: integer
forceRecover:
type: boolean
hostname:
type: string
noBufferedWrites:
type: boolean
payloadBufferLimit:
type: string
pubsubDB:
type: string
silentIngest:
type: boolean
storage:
description: Storage
type: string
storageFallback:
type: string
version:
$ref: '#/definitions/Version'
type: object
IngestFailure:
properties:
error:
type: string
timestamp:
format: date-time
type: string
required:
- error
- timestamp
type: object
IngestStatus:
properties:
blocksCreated:
format: uint32
type: integer
failed:
format: uint64
type: integer
failures:
items:
$ref: '#/definitions/IngestFailure'
type: array
ingested:
format: uint64
type: integer
processedBytes:
format: uint64
type: integer
walLength:
format: uint32
type: integer
required:
- ingested
- failed
- processedBytes
- blocksCreated
- walLength
type: object
Ingress:
properties:
dataset:
description: |-
Some ingress types do not specify a dataset in their messages
If this is the case, the dataset will be set to this value.
Syslog for example requires a dataset to be set, but Honeycomb does not.
type: string
forwardTo:
description: |-
If multiplexing is required, then this value should be set to a url with a scheme
honeycomb/http ingresses should be set to a http(s) url
syslog/tcp-udp ingresses should be set to a tcp/udp/tls url
tls urls may also set the ForwardToPem value
example: '"https://api.honeycomb.io/"'
type: string
forwardToPem:
description: |-
if the ingress ForwardTo value is a tls url then we may need a PEM file to validate the connection
with
type: string
id:
readOnly: true
type: string
scopes:
description: |-
For ingress types that do specify a dataset in their message
then this field defines the datasets that the ingress will be able to ingest into
items:
type: string
readOnly: true
type: array
serviceType:
description: The service type of the ingress, can only be set to one of our
supported service types
enum:
- syslog
- honeycomb
example: '"syslog"'
readOnly: true
type: string
target:
description: The Target urls or host that the ingress will be available on
readOnly: true
type: string
tlsSupported:
description: |-
If the ingress is a non http based ingress, for example syslog then this field becomes important
It indicates that the Target field is expecting TLS connections
readOnly: true
type: boolean
type: object
InstanceMessage:
properties:
dismissable:
type: boolean
kind:
enum:
- licence
type: string
message:
type: string
required:
- kind
type: object
IntegrationConfigFilter:
properties:
field:
type: string
intlKey:
type: string
kind:
enum:
- select
type: string
options:
items:
$ref: '#/definitions/IntegrationConfigFilterOption'
type: array
parentField:
type: string
required:
- intlKey
- kind
- field
- options
type: object
IntegrationConfigFilterOption:
properties:
id:
type: string
name:
type: string
parentValue:
description: |-
If this filter has a parentField, then this is the value to match on
if the parentField filter is set
type: string
reset:
description: |-
selecting this option would reset the filter
usually for "All", etc first options
type: boolean
sub:
type: string
required:
- id
- name
type: object
IntegrationConnectProps:
properties:
properties:
additionalProperties:
type: string
type: object
required:
- properties
type: object
IntegrationDatasetFilters:
properties:
filters:
items:
$ref: '#/definitions/IntegrationConfigFilter'
type: array
integrationName:
type: string
integrationSlug:
type: string
required:
- integrationSlug
- integrationName
- filters
type: object
IntegrationNextStep:
properties:
kind:
enum:
- redirect
type: string
properties:
additionalProperties:
type: object
type: object
required:
- kind
- properties
type: object
IntegrationQuery:
properties:
aggregations:
items:
$ref: '#/definitions/Aggregation'
type: array
continuationToken:
type: string
cursor:
type: string
endTime:
type: string
filter:
$ref: '#/definitions/Filter'
groupBy:
items:
type: string
type: array
includeCursor:
type: boolean
limit:
format: uint32
type: integer
order:
items:
$ref: '#/definitions/Order'
type: array
project:
items:
$ref: '#/definitions/Projection'
type: array
queryOptions:
$ref: '#/definitions/IntegrationQueryOptions'
resolution:
description: |-
The time resolution of the query’s graph, in seconds. Valid values are
the query’s time range /100 at maximum and /1000 at minimum or "auto".
type: string
startTime:
description: |-
start and end time for the query, these must be specified as RFC3339 strings
or using relative time expressions (e.g. now-1h, now-1d, now-1w, etc)
type: string
virtualFields:
items:
$ref: '#/definitions/VirtualColumn'
type: array
required:
- startTime
- endTime
- resolution
type: object
IntegrationQueryOptions:
properties:
integrationsFilter:
type: string
required:
- integrationsFilter
type: object
IntegrationQuickQuery:
properties:
defaultQuery:
$ref: '#/definitions/IntegrationQuery'
description:
type: string
id:
type: string
name:
type: string
shortcuts:
items:
$ref: '#/definitions/IntegrationShortcut'
type: array
required:
- id
- name
- description
- defaultQuery
- shortcuts
type: object
IntegrationShortcut:
properties:
iconName:
type: string
intlKey:
type: string
query:
$ref: '#/definitions/IntegrationQuery'
required:
- intlKey
- iconName
- query
type: object
Interval:
properties:
endTime:
format: date-time
type: string
groups:
items:
$ref: '#/definitions/EntryGroup'
type: array
startTime:
format: date-time
type: string
required:
- startTime
- endTime
type: object
Invoice:
properties:
issuedDate:
type: string
paid:
type: boolean
receipt:
type: string
total:
format: double
type: number
required:
- paid
- issuedDate
- total
- receipt
type: object
Invoices:
items:
$ref: '#/definitions/Invoice'
type: array
License:
properties:
apiRateLimit:
format: int64
type: integer
dailyIngestGb:
format: int64
type: integer
error:
description: Error returns the last error (if any) on token refresh
type: string
expiresAt:
format: date-time
type: string
id:
type: string
issuedAt:
format: date-time
type: string
issuedTo:
type: string
issuer:
type: string
maxAuditWindowSeconds:
format: int64
type: integer
maxDatasets:
format: int64
type: integer
maxQueriesPerSecond:
format: int64
type: integer
maxQueryWindowSeconds:
format: int64
type: integer
maxTeams:
format: int64
type: integer
maxUsers:
format: int64
type: integer
tier:
enum:
- free
- trial
- pro
- enterprise
- comped
type: string
validFrom:
format: date-time
type: string
withAuths:
items:
type: string
type: array
withRBAC:
type: boolean
required:
- id
- issuer
- issuedTo
- issuedAt
- validFrom
- expiresAt
- tier
- dailyIngestGb
- apiRateLimit
- maxUsers
- maxTeams
- maxDatasets
- maxQueriesPerSecond
- maxQueryWindowSeconds
- maxAuditWindowSeconds
- withRBAC
- withAuths
- error
type: object
Message:
properties:
code:
type: string
count:
format: int64
type: integer
msg:
type: string
priority:
type: string
required:
- priority
- count
- msg
type: object
Monitor:
properties:
aplQuery:
type: boolean
comparison:
enum:
- Below
- BelowOrEqual
- Above
- AboveOrEqual
type: string
dataset:
type: string
description:
type: string
disabled:
type: boolean
disabledUntil:
type: string
durationMinutes:
format: int64
type: integer
frequencyMinutes:
format: int64
type: integer
id:
type: string
lastCheckState:
additionalProperties:
type: string
type: object
lastCheckTime:
type: string
lastError:
type: string
name:
type: string
noDataCloseWaitMinutes:
format: int64
type: integer
notifiers:
items:
type: string
type: array
query:
type: object
threshold:
format: double
type: number
required:
- id
- name
- aplQuery
- query
- dataset
- threshold
- comparison
- frequencyMinutes
- durationMinutes
- disabled
type: object
NodeStatus:
properties:
status:
format: int64
type: integer
required:
- status
type: object
Notifier:
properties:
disabledUntil:
type: string
id:
type: string
metaCreated:
type: string
metaModified:
type: string
metaVersion:
format: int64
type: integer
name:
type: string
properties:
description: 'required: True'
type: object
type:
description: 'required: True'
enum:
- pagerduty
- slack
- email
- opsgenie
- webhook
type: string
required:
- id
- name
type: object
OAuthProvider:
properties:
clientId:
type: string
clientSecret:
type: string
extra:
additionalProperties:
type: string
type: object
id:
type: string
required:
- id
- clientId
type: object
Order:
properties:
desc:
type: boolean
field:
type: string
required:
- field
- desc
type: object
Org:
properties:
id:
type: string
lastUsageSync:
type: string
license:
$ref: '#/definitions/License'
metaCreated:
type: string
metaModified:
type: string
metaVersion:
type: string
name:
type: string
plan:
enum:
- free
- trial
- pro
- enterprise
type: string
planCreated:
type: string
planExpires:
type: string
previousPlan:
type: string
previousPlanCreated:
type: string
previousPlanExpired:
type: string
primaryEmail:
type: string
role:
type: string
trialed:
type: boolean
required:
- id
- name
- plan
- planCreated
- planExpires
- trialed
- previousPlan
- previousPlanCreated
- previousPlanExpired
- lastUsageSync
- role
- primaryEmail
- license
type: object
OrgSharedAccessKeys:
properties:
primary:
type: string
secondary:
type: string
required:
- primary
- secondary
type: object
OrgStatus:
properties:
dailyIngestRemainingGB:
format: double
type: number
dailyIngestUsedGB:
format: double
type: number
datasetsRemaining:
format: int64
type: integer
datasetsUsed:
format: int64
type: integer
usersRemaining:
format: int64
type: integer
usersUsed:
format: int64
type: integer
required:
- dailyIngestUsedGB
- dailyIngestRemainingGB
- datasetsUsed
- datasetsRemaining
- usersUsed
- usersRemaining
type: object
PaymentMethod:
properties:
brand:
type: string
expiryMonth:
format: int64
type: integer
expiryYear:
format: int64
type: integer
id:
type: string
last4:
type: string
required:
- last4
- brand
- id
- expiryMonth
- expiryYear
type: object
Portal:
properties:
uri:
type: string
required:
- uri
type: object
PostOrg:
properties:
name:
type: string
required:
- name
type: object
Projection:
properties:
alias:
type: string
field:
type: string
required:
- field
type: object
QueryRequest:
properties:
aggregations:
items:
$ref: '#/definitions/Aggregation'
type: array
continuationToken:
type: string
cursor:
type: string
endTime:
type: string
filter:
$ref: '#/definitions/Filter'
groupBy:
items:
type: string
type: array
includeCursor:
type: boolean
limit:
format: uint32
type: integer
order:
items:
$ref: '#/definitions/Order'
type: array
project:
items:
$ref: '#/definitions/Projection'
type: array
resolution:
description: |-
The time resolution of the query’s graph, in seconds. Valid values are
the query’s time range /100 at maximum and /1000 at minimum or "auto".
type: string
startTime:
description: |-
start and end time for the query, these must be specified as RFC3339 strings
or using relative time expressions (e.g. now-1h, now-1d, now-1w, etc)
type: string
virtualFields:
items:
$ref: '#/definitions/VirtualColumn'
type: array
required:
- startTime
- endTime
- resolution
type: object
QueryRequestWithOptions:
properties:
aggregations:
items:
$ref: '#/definitions/Aggregation'
type: array
continuationToken:
type: string
cursor:
type: string
endTime:
type: string
filter:
$ref: '#/definitions/Filter'
groupBy:
items:
type: string
type: array
includeCursor:
type: boolean
limit:
format: uint32
type: integer
order:
items:
$ref: '#/definitions/Order'
type: array
project:
items:
$ref: '#/definitions/Projection'
type: array
queryOptions:
$ref: '#/definitions/QueryOptions'
resolution:
description: |-
The time resolution of the query’s graph, in seconds. Valid values are
the query’s time range /100 at maximum and /1000 at minimum or "auto".
type: string
startTime:
description: |-
start and end time for the query, these must be specified as RFC3339 strings
or using relative time expressions (e.g. now-1h, now-1d, now-1w, etc)
type: string
virtualFields:
items:
$ref: '#/definitions/VirtualColumn'
type: array
required:
- startTime
- endTime
- resolution
type: object
QueryOptions:
properties:
against:
type: string
againstStart:
type: string
againstTimestamp:
type: string
caseSensitive:
type: string
containsTimeFilter:
type: string
datasets:
type: string
displayNull:
type: string
editorContent:
type: string
endColumn:
type: string
endLineNumber:
type: string
endTime:
type: string
integrationsFilter:
type: string
openIntervals:
type: string
quickRange:
type: string
resolution:
type: string
startColumn:
type: string
startTime:
type: string
timeSeriesView:
type: string
RawToken:
properties:
permissions:
items:
type: string
type: array
scopes:
items:
type: string
type: array
token:
type: string
required:
- token
- scopes
- permissions
type: object
Result:
properties:
buckets:
$ref: '#/definitions/Timeseries'
matches:
items:
$ref: '#/definitions/Entry'
type: array
status:
$ref: '#/definitions/Status'
required:
- status
- buckets
type: object
ServiceUser:
properties:
emails:
items:
type: string
type: array
id:
type: string
name:
type: string
type: object
Settings:
properties:
cacheBackend:
type: string
datastoreBackend:
type: string
db:
type: string
dbVersion:
type: string
emailBackend:
type: string
hostname:
type: string
queryDb:
type: string
queueBackend:
type: string
version:
type: string
required:
- hostname
- datastoreBackend
- cacheBackend
- emailBackend
- queueBackend
- db
- queryDb
- dbVersion
- version
type: object
StarredQuery:
properties:
dataset:
type: string
kind:
enum:
- analytics
- stream
- apl
type: string
metadata:
additionalProperties:
type: string
type: object
name:
type: string
query:
type: object
who:
type: string
required:
- kind
- name
- who
- query
- metadata
type: object
StarredQueryWithId:
properties:
created:
format: date-time
type: string
dataset:
type: string
id:
type: string
kind:
enum:
- analytics
- stream
- apl
type: string
metadata:
additionalProperties:
type: string
type: object
name:
type: string
query:
type: object
who:
type: string
required:
- kind
- name
- who
- query
- metadata
- id
- created
type: object
Stats:
properties:
compressedBytes:
format: uint64
type: integer
compressedBytesHuman:
type: string
datasets:
items:
$ref: '#/definitions/DatasetInfo'
type: array
inputBytes:
format: uint64
type: integer
inputBytesHuman:
type: string
numBlocks:
format: uint64
type: integer
numEvents:
format: uint64
type: integer
required:
- numBlocks
- numEvents
- inputBytes
- inputBytesHuman
- compressedBytes
- compressedBytesHuman
type: object
Status:
properties:
blocksExamined:
format: uint64
type: integer
cacheStatus:
format: uint8
type: integer
continuationToken:
type: string
elapsedTime:
format: int64
type: integer
isEstimate:
type: boolean
isPartial:
type: boolean
maxBlockTime:
format: date-time
type: string
messages:
items:
$ref: '#/definitions/Message'
type: array
minBlockTime:
format: date-time
type: string
numGroups:
format: uint32
type: integer
rowsExamined:
format: uint64
type: integer
rowsMatched:
format: uint64
type: integer
required:
- elapsedTime
- blocksExamined
- rowsExamined
- rowsMatched
- numGroups
- isPartial
- cacheStatus
- minBlockTime
- maxBlockTime
type: object
StripeSetupIntent:
properties:
clientSecret:
type: string
currentStatus:
enum:
- paid
- unpaid
- no_payment_required
type: string
required:
- clientSecret
- currentStatus
type: object
Team:
properties:
datasets:
items:
type: string
type: array
id:
type: string
members:
items:
type: string
type: array
name:
type: string
required:
- id
- name
- members
- datasets
type: object
Timeseries:
properties:
series:
items:
$ref: '#/definitions/Interval'
type: array
totals:
items:
$ref: '#/definitions/EntryGroup'
type: array
type: object
Token:
properties:
description:
type: string
id:
type: string
name:
type: string
permissions:
items:
type: string
type: array
scopes:
items:
type: string
type: array
required:
- id
- name
- scopes
- permissions
type: object
TrimOptions:
properties:
maxDuration:
type: string
required:
- maxDuration
type: object
TrimResult:
properties:
numDeleted:
format: int64
type: integer
required:
- numDeleted
type: object
UpdateDataset:
properties:
description:
type: string
type: object
Usage:
properties:
creditUsd:
format: double
type: number
lineItems:
additionalProperties:
$ref: '#/definitions/UsageItem'
type: object
periodEndDate:
type: string
periodStartDate:
type: string
subTotalUsd:
format: double
type: number
totalUsd:
format: double
type: number
required:
- periodStartDate
- periodEndDate
- subTotalUsd
- totalUsd
- creditUsd
- lineItems
type: object
UsageItem:
properties:
breakdown:
additionalProperties:
format: double
type: number
type: object
quantity:
format: double
type: number
totalUsd:
format: double
type: number
required:
- totalUsd
- quantity
- breakdown
type: object
User:
properties:
email:
type: string
id:
type: string
name:
type: string
permissions:
items:
type: string
type: array
role:
type: string
required:
- id
- name
- email
- role
- permissions
type: object
UserRole:
properties:
role:
enum:
- owner
- admin
- user
- read-only
type: string
required:
- role
type: object
UserUpdate:
properties:
name:
type: string
required:
- name
type: object
Version:
properties:
buildDate:
format: date-time
type: string
release:
type: string
revision:
type: string
type: object
VersionPayload:
properties:
currentVersion:
type: string
required:
- currentVersion
type: object
VirtualColumn:
properties:
alias:
type: string
expr:
type: string
required:
- alias
- expr
type: object
VirtualField:
properties:
dataset:
type: string
description:
type: string
expression:
type: string
name:
type: string
required:
- dataset
- name
- expression
type: object
VirtualFieldWithId:
properties:
dataset:
type: string
description:
type: string
expression:
type: string
id:
type: string
name:
type: string
required:
- dataset
- name
- expression
- id
type: object
info:
title: Axiom dash API endpoints.
version: 1.0.0
paths:
/dashboards:
get:
operationId: getDashboards
parameters:
- format: int64
in: query
name: limit
type: integer
- format: int64
in: query
name: offset
type: integer
responses:
"200":
description: DashboardWithId
schema:
items:
$ref: '#/definitions/DashboardWithId'
type: array
tags:
- dash
post:
operationId: createDashboard
parameters:
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/Dashboard'
type: object
type: object
responses:
"200":
description: DashboardWithId
schema:
$ref: '#/definitions/DashboardWithId'
tags:
- dash
/dashboards/{id}:
delete:
operationId: deleteDashboard
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"204":
description: ""
tags:
- dash
get:
operationId: getDashboard
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: DashboardWithId
schema:
$ref: '#/definitions/DashboardWithId'
tags:
- dash
put:
operationId: updateDashboard
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/Dashboard'
type: object
type: object
responses:
"200":
description: DashboardWithId
schema:
$ref: '#/definitions/DashboardWithId'
tags:
- dash
/datasets:
get:
operationId: getDatasets
responses:
"200":
description: DatasetSpec
schema:
items:
$ref: '#/definitions/DatasetSpec'
type: array
tags:
- dash
post:
operationId: createDataset
parameters:
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/CreateDataset'
type: object
type: object
responses:
"200":
description: DatasetSpec
schema:
$ref: '#/definitions/DatasetSpec'
tags:
- dash
/datasets/_apl:
post:
operationId: queryApl
parameters:
- enum:
- legacy
in: query
name: format
required: true
type: string
- in: query
name: nocache
type: boolean
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/APLRequestWithOptions'
type: object
type: object
responses:
"200":
description: AplResult
schema:
$ref: '#/definitions/AplResult'
tags:
- dash
/datasets/_history/{id}:
get:
operationId: getDatasetsHistoryQuery
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: StarredQueryWithId
schema:
$ref: '#/definitions/StarredQueryWithId'
tags:
- dash
/datasets/_info:
get:
operationId: getDatasetsInfo
responses:
"200":
description: DatasetCoreInfo
schema:
items:
$ref: '#/definitions/DatasetCoreInfo'
type: array
tags:
- dash
/datasets/_stats:
get:
operationId: getDatasetsStats
responses:
"200":
description: Stats
schema:
$ref: '#/definitions/Stats'
tags:
- dash
/datasets/{id}:
delete:
operationId: deleteDataset
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"204":
description: ""
tags:
- dash
get:
operationId: getDataset
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: DatasetSpec
schema:
$ref: '#/definitions/DatasetSpec'
tags:
- dash
put:
operationId: updateDataset
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/UpdateDataset'
type: object
type: object
responses:
"200":
description: DatasetSpec
schema:
$ref: '#/definitions/DatasetSpec'
tags:
- dash
/datasets/{id}/fields/{fieldId}:
put:
operationId: updateField
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: path
name: fieldId
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/DatasetField'
type: object
type: object
responses:
"200":
description: DatasetField
schema:
$ref: '#/definitions/DatasetField'
tags:
- dash
/datasets/{id}/info:
get:
operationId: getDatasetInfo
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: DatasetCoreInfo
schema:
$ref: '#/definitions/DatasetCoreInfo'
tags:
- dash
/datasets/{id}/query:
post:
operationId: queryDataset
parameters:
- in: query
name: saveAsKind
type: string
- in: path
name: id
required: true
schema:
type: string
type: string
- in: query
name: streaming-duration
schema:
type: string
type: string
- in: query
name: nocache
schema:
type: boolean
type: boolean
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/QueryRequestWithOptions'
type: object
type: object
responses:
"200":
description: Result
schema:
$ref: '#/definitions/Result'
tags:
- dash
/datasets/{id}/trim:
post:
operationId: trimDataset
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/TrimOptions'
type: object
type: object
responses:
"200":
description: TrimResult
schema:
$ref: '#/definitions/TrimResult'
tags:
- dash
/health:
get:
operationId: getHealth
responses:
"200":
description: Health
schema:
$ref: '#/definitions/Health'
tags:
- dash
/ingress:
get:
operationId: listAllIngress
responses:
"200":
description: Ingress
schema:
items:
$ref: '#/definitions/Ingress'
type: array
tags:
- ingress
post:
operationId: createIngress
parameters:
- description: the type of service this ingress represents, must be one of the
enum values
in: query
name: serviceType
required: true
schema:
description: the type of service this ingress represents, must be one of
the enum values
enum:
- honeycomb
- loki
- splunk
type: string
type: string
- description: set to true if TLS is required for TCP ingresses (syslog)
in: query
name: tlsenabled
schema:
description: set to true if TLS is required for TCP ingresses (syslog)
type: boolean
type: boolean
- description: a list of datasets that may be ingested into by this ingress,
* is considered all datasets
in: query
name: scopes
schema:
description: a list of datasets that may be ingested into by this ingress,
* is considered all datasets
type: string
type: string
- in: body
name: payload
schema:
$ref: '#/definitions/Ingress'
type: object
type: object
responses:
"200":
description: Ingress
schema:
$ref: '#/definitions/Ingress'
tags:
- ingress
/ingress/{id}:
delete:
operationId: deleteIngress
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"204":
description: ""
tags:
- ingress
get:
operationId: getIngress
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: Ingress
schema:
$ref: '#/definitions/Ingress'
tags:
- ingress
put:
operationId: updateIngress
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/Ingress'
type: object
type: object
responses:
"204":
description: Ingress
schema:
$ref: '#/definitions/Ingress'
tags:
- ingress
/integrations/{integrationId}/dashboard:
post:
operationId: forkIntegrationDashboard
parameters:
- in: path
name: integrationId
required: true
schema:
type: string
type: string
responses:
"200":
description: DashboardWithId
schema:
$ref: '#/definitions/DashboardWithId'
tags:
- dash
/integrations/{slug}/connect:
post:
operationId: connectIntegration
parameters:
- in: path
name: slug
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/IntegrationConnectProps'
type: object
type: object
responses:
"200":
$ref: '#/responses/ConnectNextStep'
tags:
- dash
/integrations/{slug}/new:
get:
operationId: newIntegration
parameters:
- in: path
name: slug
required: true
schema:
type: string
type: string
responses:
"200":
description: IntegrationNextStep
schema:
$ref: '#/definitions/IntegrationNextStep'
tags:
- dash
/integrations/dashboards:
get:
operationId: getIntegrationDashboards
responses:
"200":
description: DashboardWithId
schema:
items:
$ref: '#/definitions/DashboardWithId'
type: array
tags:
- dash
/messages/instance:
get:
operationId: getInstanceMessages
responses:
"200":
description: InstanceMessage
schema:
items:
$ref: '#/definitions/InstanceMessage'
type: array
tags:
- dash
/monitors:
get:
operationId: getMonitors
responses:
"200":
description: Monitor
schema:
items:
$ref: '#/definitions/Monitor'
type: array
tags:
- dash
post:
operationId: createMonitor
parameters:
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/Monitor'
type: object
type: object
responses:
"200":
description: Monitor
schema:
$ref: '#/definitions/Monitor'
tags:
- dash
/monitors/{id}:
delete:
operationId: deleteMonitor
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"204":
description: ""
tags:
- dash
get:
operationId: getMonitor
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: Monitor
schema:
$ref: '#/definitions/Monitor'
tags:
- dash
put:
operationId: updateMonitor
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/Monitor'
type: object
type: object
responses:
"200":
description: Monitor
schema:
$ref: '#/definitions/Monitor'
tags:
- dash
/notifiers:
get:
operationId: getNotifiers
responses:
"200":
description: Notifier
schema:
items:
$ref: '#/definitions/Notifier'
type: array
tags:
- dash
post:
operationId: createNotifier
parameters:
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/Notifier'
type: object
type: object
responses:
"200":
description: Notifier
schema:
$ref: '#/definitions/Notifier'
tags:
- dash
/notifiers/{id}:
delete:
operationId: delNotifier
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"204":
description: ""
tags:
- dash
get:
operationId: getNotifier
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: Notifier
schema:
$ref: '#/definitions/Notifier'
tags:
- dash
put:
operationId: updateNotifier
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/Notifier'
type: object
type: object
responses:
"200":
description: Notifier
schema:
$ref: '#/definitions/Notifier'
tags:
- dash
/orgs:
get:
operationId: getOrgs
responses:
"200":
description: Org
schema:
items:
$ref: '#/definitions/Org'
type: array
tags:
- dash
post:
operationId: createOrg
parameters:
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/PostOrg'
type: object
type: object
responses:
"200":
description: Org
schema:
$ref: '#/definitions/Org'
tags:
- dash
/orgs/{id}:
delete:
operationId: deleteOrg
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"204":
description: ""
tags:
- dash
get:
operationId: getOrg
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: Org
schema:
$ref: '#/definitions/Org'
tags:
- dash
put:
operationId: updateOrg
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/PostOrg'
type: object
type: object
responses:
"200":
description: Org
schema:
$ref: '#/definitions/Org'
tags:
- dash
/orgs/{id}/billing-intent:
get:
operationId: getStripeBillingIntent
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: StripeSetupIntent
schema:
$ref: '#/definitions/StripeSetupIntent'
tags:
- dash
/orgs/{id}/downgrade:
put:
operationId: downgradePlan
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/BillingChange'
type: object
type: object
responses:
"200":
description: Org
schema:
$ref: '#/definitions/Org'
tags:
- dash
/orgs/{id}/invoices:
get:
operationId: getInvoices
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: Invoices
schema:
$ref: '#/definitions/Invoices'
tags:
- dash
/orgs/{id}/keys:
get:
operationId: viewSharedAccessKeys
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: OrgSharedAccessKeys
schema:
$ref: '#/definitions/OrgSharedAccessKeys'
tags:
- dash
/orgs/{id}/license:
get:
operationId: getOrgLicense
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: License
schema:
$ref: '#/definitions/License'
tags:
- dash
/orgs/{id}/payment-method:
get:
operationId: getPaymentMethod
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: PaymentMethod
schema:
$ref: '#/definitions/PaymentMethod'
tags:
- dash
/orgs/{id}/portal:
get:
operationId: getStripePortal
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: Portal
schema:
$ref: '#/definitions/Portal'
tags:
- dash
/orgs/{id}/rotate-keys:
put:
operationId: rotateSharedAccessKeys
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: OrgSharedAccessKeys
schema:
$ref: '#/definitions/OrgSharedAccessKeys'
tags:
- dash
/orgs/{id}/status:
get:
operationId: getOrgStatus
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: OrgStatus
schema:
$ref: '#/definitions/OrgStatus'
tags:
- dash
/orgs/{id}/upgrade:
put:
operationId: upgradePlan
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/BillingChange'
type: object
type: object
responses:
"200":
description: Org
schema:
$ref: '#/definitions/Org'
tags:
- dash
/orgs/{id}/usage:
get:
operationId: getUsage
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: Usage
schema:
$ref: '#/definitions/Usage'
tags:
- dash
/settings:
get:
operationId: getSettings
responses:
"200":
description: Settings
schema:
$ref: '#/definitions/Settings'
tags:
- dash
/settings/oauth:
get:
operationId: getOAuthProviders
responses:
"200":
description: OAuthProvider
schema:
items:
$ref: '#/definitions/OAuthProvider'
type: array
tags:
- dash
post:
operationId: createOAuthProvider
parameters:
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/OAuthProvider'
type: object
type: object
responses:
"200":
description: OAuthProvider
schema:
$ref: '#/definitions/OAuthProvider'
tags:
- dash
/settings/oauth/{id}:
delete:
operationId: deleteOAuthProvider
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"204":
description: ""
tags:
- dash
get:
operationId: getOAuthProvider
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: OAuthProvider
schema:
$ref: '#/definitions/OAuthProvider'
tags:
- dash
put:
operationId: updateOAuthProvider
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/OAuthProvider'
type: object
type: object
responses:
"200":
description: OAuthProvider
schema:
$ref: '#/definitions/OAuthProvider'
tags:
- dash
/starred:
get:
operationId: getStarredQueries
parameters:
- format: int64
in: query
name: limit
type: integer
- format: int64
in: query
name: offset
type: integer
- in: query
name: kind
required: true
type: string
- in: query
name: dataset
type: string
- in: query
name: who
type: string
- in: query
name: qs
type: string
responses:
"200":
description: StarredQueryWithId
schema:
items:
$ref: '#/definitions/StarredQueryWithId'
type: array
tags:
- dash
post:
operationId: createStarred
parameters:
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/StarredQuery'
type: object
type: object
responses:
"200":
description: StarredQueryWithId
schema:
$ref: '#/definitions/StarredQueryWithId'
tags:
- dash
/starred/{id}:
delete:
operationId: deleteStarred
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"204":
description: ""
tags:
- dash
get:
operationId: getStarred
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: StarredQueryWithId
schema:
$ref: '#/definitions/StarredQueryWithId'
tags:
- dash
put:
operationId: updateStarred
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/StarredQuery'
type: object
type: object
responses:
"200":
description: StarredQueryWithId
schema:
$ref: '#/definitions/StarredQueryWithId'
tags:
- dash
/teams:
get:
operationId: getTeams
responses:
"200":
description: Team
schema:
items:
$ref: '#/definitions/Team'
type: array
tags:
- dash
post:
operationId: createTeam
parameters:
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/CreateTeam'
type: object
type: object
responses:
"200":
description: Team
schema:
$ref: '#/definitions/Team'
tags:
- dash
/teams/{id}:
delete:
operationId: deleteTeam
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"204":
description: ""
tags:
- dash
get:
operationId: getTeam
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: Team
schema:
$ref: '#/definitions/Team'
tags:
- dash
put:
operationId: updateTeam
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/Team'
type: object
type: object
responses:
"200":
description: Team
schema:
$ref: '#/definitions/Team'
tags:
- dash
/tokens/api:
get:
operationId: getAPITokens
responses:
"200":
description: Token
schema:
items:
$ref: '#/definitions/Token'
type: array
tags:
- dash
post:
operationId: createAPIToken
parameters:
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/CreateToken'
type: object
type: object
responses:
"200":
description: Token
schema:
$ref: '#/definitions/Token'
tags:
- dash
/tokens/api/{id}:
delete:
operationId: deleteAPIToken
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"204":
description: ""
tags:
- dash
get:
operationId: getAPIToken
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: Token
schema:
$ref: '#/definitions/Token'
tags:
- dash
put:
operationId: updateAPIToken
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/Token'
type: object
type: object
responses:
"200":
description: Token
schema:
$ref: '#/definitions/Token'
tags:
- dash
/tokens/api/{id}/token:
get:
operationId: viewAPIToken
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: RawToken
schema:
$ref: '#/definitions/RawToken'
tags:
- dash
/tokens/ingest:
get:
operationId: getIngestTokens
responses:
"200":
description: Token
schema:
items:
$ref: '#/definitions/Token'
type: array
tags:
- dash
post:
operationId: createIngestToken
parameters:
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/CreateToken'
type: object
type: object
responses:
"200":
description: Token
schema:
$ref: '#/definitions/Token'
tags:
- dash
/tokens/ingest/{id}:
delete:
operationId: deleteIngestToken
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"204":
description: ""
tags:
- dash
get:
operationId: getIngestToken
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: Token
schema:
$ref: '#/definitions/Token'
tags:
- dash
put:
operationId: updateIngestToken
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/Token'
type: object
type: object
responses:
"200":
description: Token
schema:
$ref: '#/definitions/Token'
tags:
- dash
/tokens/ingest/{id}/token:
get:
operationId: viewIngestToken
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: RawToken
schema:
$ref: '#/definitions/RawToken'
tags:
- dash
/tokens/personal:
get:
operationId: getPersonalTokens
responses:
"200":
description: Token
schema:
items:
$ref: '#/definitions/Token'
type: array
tags:
- dash
post:
operationId: createPersonalToken
parameters:
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/CreateToken'
type: object
type: object
responses:
"200":
description: Token
schema:
$ref: '#/definitions/Token'
tags:
- dash
/tokens/personal/{id}:
delete:
operationId: deletePersonalToken
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"204":
description: ""
tags:
- dash
get:
operationId: getPersonalToken
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: Token
schema:
$ref: '#/definitions/Token'
tags:
- dash
put:
operationId: updatePersonalToken
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/Token'
type: object
type: object
responses:
"200":
description: Token
schema:
$ref: '#/definitions/Token'
tags:
- dash
/tokens/personal/{id}/token:
get:
operationId: viewPersonalToken
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: RawToken
schema:
$ref: '#/definitions/RawToken'
tags:
- dash
/user:
get:
operationId: getCurrentUser
responses:
"200":
description: ServiceUser
schema:
$ref: '#/definitions/ServiceUser'
tags:
- dash
/users:
get:
operationId: getUsers
responses:
"200":
description: User
schema:
items:
$ref: '#/definitions/User'
type: array
tags:
- dash
post:
operationId: createUser
parameters:
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/User'
type: object
type: object
responses:
"200":
description: User
schema:
$ref: '#/definitions/User'
tags:
- dash
/users/{id}:
delete:
operationId: deleteUser
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"204":
description: ""
tags:
- dash
get:
operationId: getUser
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: User
schema:
$ref: '#/definitions/User'
tags:
- dash
put:
operationId: updateUser
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/UserUpdate'
type: object
type: object
responses:
"200":
description: User
schema:
$ref: '#/definitions/User'
tags:
- dash
/users/{id}/role:
put:
operationId: updateUserRole
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/UserRole'
type: object
type: object
responses:
"200":
description: User
schema:
$ref: '#/definitions/User'
tags:
- dash
/version:
get:
operationId: getVersion
responses:
"200":
description: VersionPayload
schema:
$ref: '#/definitions/VersionPayload'
tags:
- dash
/vfields:
get:
operationId: getVirtualFields
parameters:
- format: int64
in: query
name: limit
type: integer
- format: int64
in: query
name: offset
type: integer
- in: query
name: dataset
required: true
type: string
responses:
"200":
description: VirtualFieldWithId
schema:
items:
$ref: '#/definitions/VirtualFieldWithId'
type: array
tags:
- dash
post:
operationId: createVirtualField
parameters:
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/VirtualField'
type: object
type: object
responses:
"200":
description: VirtualFieldWithId
schema:
$ref: '#/definitions/VirtualFieldWithId'
tags:
- dash
/vfields/{id}:
delete:
operationId: deleteVirtualField
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"204":
description: ""
tags:
- dash
get:
operationId: getVirtualField
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
responses:
"200":
description: VirtualFieldWithId
schema:
$ref: '#/definitions/VirtualFieldWithId'
tags:
- dash
put:
operationId: updateVirtualField
parameters:
- in: path
name: id
required: true
schema:
type: string
type: string
- in: body
name: payload
required: true
schema:
$ref: '#/definitions/VirtualField'
type: object
type: object
responses:
"200":
description: VirtualFieldWithId
schema:
$ref: '#/definitions/VirtualFieldWithId'
tags:
- dash
produces:
- application/json
swagger: "2.0"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment