Skip to content

Commit

Permalink
open cloudtruth openapi spec
Browse files Browse the repository at this point in the history
  • Loading branch information
@wr0ngway
wr0ngway committed Aug 2, 2021
1 parent 4a5a36e commit 6995a3e
Show file tree
Hide file tree
Showing 12 changed files with 679 additions and 577 deletions.
154 changes: 128 additions & 26 deletions openapi.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ openapi: 3.0.3
info:
title: CloudTruth Management API
version: ''
description: CloudTruth centralizes your parameters and secrets making them easier
to manage and use.
description: CloudTruth centralizes your configuration parameters and secrets making
them easier to manage and use as a team.
contact:
name: CloudTruth Support
email: support@cloudtruth.com
Expand Down Expand Up @@ -128,8 +128,6 @@ paths:
tags:
- api
security:
- JWTAuth: []
- ApiKeyAuth: []
- {}
responses:
'200':
Expand Down Expand Up @@ -190,6 +188,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: user_id
schema:
Expand Down Expand Up @@ -261,6 +265,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: parent__name
schema:
Expand Down Expand Up @@ -437,6 +447,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- integrations
security:
Expand Down Expand Up @@ -628,6 +644,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- integrations
security:
Expand Down Expand Up @@ -664,6 +686,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- integrations
security:
Expand Down Expand Up @@ -778,6 +806,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: role
schema:
Expand Down Expand Up @@ -1037,6 +1071,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: role
schema:
Expand Down Expand Up @@ -1218,6 +1258,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- organizations
security:
Expand Down Expand Up @@ -1380,6 +1426,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- projects
security:
Expand Down Expand Up @@ -1583,6 +1635,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: project_pk
schema:
Expand Down Expand Up @@ -1639,6 +1697,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: project_pk
schema:
Expand Down Expand Up @@ -1727,6 +1791,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: parameter_pk
schema:
Expand Down Expand Up @@ -2097,16 +2167,16 @@ paths:
description: While checking pre-conditions, a dynamic value was encountered
that could not be resolved.
'404':
description: The given project id could not be found, or while checking
pre-conditions, a dynamic value was encountered that could not be resolved.
'415':
description: While checking pre-conditions, a dynamic value was encountered
that could not be resolved.
that has an invalid content type.
'422':
description: 'A pre-condition to modifying the `secret` setting of the parameter
failed, for example setting `secret: false` and having a dynamic value
that resolves to a value that is a secret. In this case it would be unsafe
to allow the `secret` setting to change.'
'415':
description: While checking pre-conditions, a dynamic value was encountered
that has an invalid content type.
'507':
description: While checking pre-conditions, a dynamic value was encountered
that was too large to process.
Expand Down Expand Up @@ -2154,16 +2224,16 @@ paths:
description: While checking pre-conditions, a dynamic value was encountered
that could not be resolved.
'404':
description: The given project id could not be found, or while checking
pre-conditions, a dynamic value was encountered that could not be resolved.
'415':
description: While checking pre-conditions, a dynamic value was encountered
that could not be resolved.
that has an invalid content type.
'422':
description: 'A pre-condition to modifying the `secret` setting of the parameter
failed, for example setting `secret: false` and having a dynamic value
that resolves to a value that is a secret. In this case it would be unsafe
to allow the `secret` setting to change.'
'415':
description: While checking pre-conditions, a dynamic value was encountered
that has an invalid content type.
'507':
description: While checking pre-conditions, a dynamic value was encountered
that was too large to process.
Expand Down Expand Up @@ -2253,6 +2323,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: project_pk
schema:
Expand Down Expand Up @@ -2463,6 +2539,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- serviceaccounts
security:
Expand Down Expand Up @@ -2628,6 +2710,12 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: type
schema:
Expand Down Expand Up @@ -3633,10 +3721,6 @@ components:
type: string
format: uri
readOnly: true
uses_dynamic_values:
type: boolean
readOnly: true
description: If `true` then at least one of the values is dynamic.
values:
type: object
additionalProperties:
Expand Down Expand Up @@ -3675,7 +3759,6 @@ components:
- name
- templates
- url
- uses_dynamic_values
- values
ParameterCreate:
type: object
Expand Down Expand Up @@ -3975,10 +4058,6 @@ components:
type: string
format: uri
readOnly: true
uses_dynamic_values:
type: boolean
readOnly: true
description: If `true` then at least one of the values is dynamic.
values:
type: object
additionalProperties:
Expand Down Expand Up @@ -4163,7 +4242,7 @@ components:
nullable: true
description: This is the content to use when resolving the Value for a static
non-secret.
maxLength: 1024
maxLength: 16384
value:
type: string
nullable: true
Expand All @@ -4175,11 +4254,21 @@ components:
For values that are not `dynamic` and parameters that are `secret`, the system will retrieve the content from your organization's dedicated vault.
For values that are `dynamic`, the system will retrieve the content from the integration on-demand. If the content from the integration is `secret` and the parameter is not, or if the parameter is `secret` and the content from the integration is not, an error response will be given. If a `dynamic_filter` is present then the content will have a JMESpath query applied, and that becomes the resulting value.
For values that are `dynamic`, the system will retrieve the content from the integration on-demand. If the content from the integration is `secret` and the parameter is not, an error response will be given. If a `dynamic_filter` is present then the content will have a JMESpath query applied, and that becomes the resulting value.
If you request secret masking, no secret content will be included in the result and instead a series of asterisks will be used instead for the value. If you request wrapping, the secret content will be wrapped in an envelope that is bound to your JWT token. For more information about secret wrapping, see the docs.
Clients applying this value to a shell environment should set `<parameter_name>=<value>` even if `value` is the empty string. If `value` is `null`, the client should unset that shell environment variable.
secret:
type: boolean
nullable: true
readOnly: true
description: Indicates the value content is a secret. Normally this is
`true` when the parameter is a secret, however it is possible for a parameter
to be a secret with a dynamic value that is not a secret. It is not possible
to convert a parameter from a secret to a non-secret if any of the values
are dynamic and a secret. Clients can check this condition by leveraging
this field.
created_at:
type: string
format: date-time
Expand Down Expand Up @@ -4510,7 +4599,7 @@ components:
nullable: true
description: This is the content to use when resolving the Value for a static
non-secret.
maxLength: 1024
maxLength: 16384
value:
type: string
nullable: true
Expand All @@ -4522,11 +4611,21 @@ components:
For values that are not `dynamic` and parameters that are `secret`, the system will retrieve the content from your organization's dedicated vault.
For values that are `dynamic`, the system will retrieve the content from the integration on-demand. If the content from the integration is `secret` and the parameter is not, or if the parameter is `secret` and the content from the integration is not, an error response will be given. If a `dynamic_filter` is present then the content will have a JMESpath query applied, and that becomes the resulting value.
For values that are `dynamic`, the system will retrieve the content from the integration on-demand. If the content from the integration is `secret` and the parameter is not, an error response will be given. If a `dynamic_filter` is present then the content will have a JMESpath query applied, and that becomes the resulting value.
If you request secret masking, no secret content will be included in the result and instead a series of asterisks will be used instead for the value. If you request wrapping, the secret content will be wrapped in an envelope that is bound to your JWT token. For more information about secret wrapping, see the docs.
Clients applying this value to a shell environment should set `<parameter_name>=<value>` even if `value` is the empty string. If `value` is `null`, the client should unset that shell environment variable.
secret:
type: boolean
nullable: true
readOnly: true
description: Indicates the value content is a secret. Normally this is
`true` when the parameter is a secret, however it is possible for a parameter
to be a secret with a dynamic value that is not a secret. It is not possible
to convert a parameter from a secret to a non-secret if any of the values
are dynamic and a secret. Clients can check this condition by leveraging
this field.
created_at:
type: string
format: date-time
Expand All @@ -4541,6 +4640,7 @@ components:
- id
- modified_at
- parameter
- secret
- url
- value
ValueCreate:
Expand Down Expand Up @@ -4575,7 +4675,7 @@ components:
nullable: true
description: This is the content to use when resolving the Value for a static
non-secret.
maxLength: 1024
maxLength: 16384
required:
- environment
securitySchemes:
Expand Down Expand Up @@ -4609,3 +4709,5 @@ components:
\ the JWT, place your JWT in the Authorization header as 'Bearer JWT', where\n\
JWT is your JWT. For example:\n\n Authorization: Bearer eyJhbGciOiJIkuydfy.eyJzdWIiOiIxMjM....\n\
\ "
externalDocs:
url: https://docs.cloudtruth.com/
Loading

0 comments on commit 6995a3e

Please sign in to comment.