Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(document/templates): remove all references #192

Merged
merged 1 commit into from
Oct 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
542 changes: 0 additions & 542 deletions contracts/cloud.json

Large diffs are not rendered by default.

341 changes: 0 additions & 341 deletions contracts/cloud.yml
Original file line number Diff line number Diff line change
Expand Up @@ -103,241 +103,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Routes'
/documents/templates:
get:
operationId: GetDocumentsTemplates
tags:
- Templates
summary: List all templates
parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: query
name: org
description: Specifies the name of the organization of the template.
schema:
type: string
- in: query
name: orgID
description: Specifies the organization ID of the template.
schema:
type: string
responses:
'200':
description: A list of template documents
content:
application/json:
schema:
$ref: '#/components/schemas/Documents'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
operationId: PostDocumentsTemplates
tags:
- Templates
summary: Create a template
parameters:
- $ref: '#/components/parameters/TraceSpan'
requestBody:
description: Template that will be created
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentCreate'
responses:
'201':
description: Template created
content:
application/json:
schema:
$ref: '#/components/schemas/Document'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'/documents/templates/{templateID}':
get:
operationId: GetDocumentsTemplatesID
tags:
- Templates
summary: Retrieve a template
parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path
name: templateID
schema:
type: string
required: true
description: The template ID.
responses:
'200':
description: The template requested
content:
application/json:
schema:
$ref: '#/components/schemas/Document'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
put:
operationId: PutDocumentsTemplatesID
tags:
- Templates
summary: Update a template
parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path
name: templateID
schema:
type: string
required: true
description: The template ID.
requestBody:
description: Template that will be updated
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentUpdate'
responses:
'200':
description: The newly updated template
content:
application/json:
schema:
$ref: '#/components/schemas/Document'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
operationId: DeleteDocumentsTemplatesID
tags:
- Templates
summary: Delete a template
parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path
name: templateID
schema:
type: string
required: true
description: The template ID.
responses:
'204':
description: Delete has been accepted
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'/documents/templates/{templateID}/labels':
get:
operationId: GetDocumentsTemplatesIDLabels
tags:
- Templates
summary: List all labels for a template
parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path
name: templateID
schema:
type: string
required: true
description: The template ID.
responses:
'200':
description: A list of all labels for a template
content:
application/json:
schema:
$ref: '#/components/schemas/LabelsResponse'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
operationId: PostDocumentsTemplatesIDLabels
tags:
- Templates
summary: Add a label to a template
parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path
name: templateID
schema:
type: string
required: true
description: The template ID.
requestBody:
description: Label to add
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LabelMapping'
responses:
'201':
description: The label added to the template
content:
application/json:
schema:
$ref: '#/components/schemas/LabelResponse'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'/documents/templates/{templateID}/labels/{labelID}':
delete:
operationId: DeleteDocumentsTemplatesIDLabelsID
tags:
- Templates
summary: Delete a label from a template
parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path
name: templateID
schema:
type: string
required: true
description: The template ID.
- in: path
name: labelID
schema:
type: string
required: true
description: The label ID.
responses:
'204':
description: Delete has been accepted
'404':
description: Template not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/dbrps:
get:
operationId: GetDBRPs
Expand Down Expand Up @@ -10157,112 +9922,6 @@ components:
type: array
items:
$ref: '#/components/schemas/Dashboard'
DocumentMeta:
type: object
properties:
name:
type: string
type:
type: string
templateID:
type: string
description:
type: string
version:
type: string
createdAt:
type: string
format: date-time
readOnly: true
updatedAt:
type: string
format: date-time
readOnly: true
required:
- name
- version
Document:
type: object
properties:
id:
type: string
readOnly: true
meta:
$ref: '#/components/schemas/DocumentMeta'
content:
type: object
labels:
$ref: '#/components/schemas/Labels'
links:
type: object
readOnly: true
example:
self: /api/v2/documents/templates/1
properties:
self:
description: The document URL.
$ref: '#/components/schemas/Link'
required:
- id
- meta
- content
DocumentCreate:
type: object
properties:
meta:
$ref: '#/components/schemas/DocumentMeta'
content:
type: object
org:
type: string
description: The organization Name. Specify either `orgID` or `org`.
orgID:
type: string
description: The organization Name. Specify either `orgID` or `org`.
labels:
type: array
description: An array of label IDs to be added as labels to the document.
items:
type: string
required:
- meta
- content
DocumentUpdate:
type: object
properties:
meta:
$ref: '#/components/schemas/DocumentMeta'
content:
type: object
DocumentListEntry:
type: object
properties:
id:
type: string
readOnly: true
meta:
$ref: '#/components/schemas/DocumentMeta'
labels:
$ref: '#/components/schemas/Labels'
links:
type: object
readOnly: true
example:
self: /api/v2/documents/templates/1
properties:
self:
description: The document URL.
$ref: '#/components/schemas/Link'
required:
- id
- meta
Documents:
type: object
properties:
documents:
type: array
items:
$ref: '#/components/schemas/DocumentListEntry'
TelegrafRequest:
type: object
properties:
Expand Down
Loading