Skip to content

Commit

Permalink
latest api schema
Browse files Browse the repository at this point in the history
  • Loading branch information
@wr0ngway
wr0ngway committed Jul 15, 2021
1 parent 0b53d64 commit b76eb58
Showing 1 changed file with 86 additions and 45 deletions.
131 changes: 86 additions & 45 deletions openapi.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,11 +162,20 @@ paths:
schema:
type: string
enum:
- access
- create
- delete
- update
description: The action that was taken.
- in: query
name: earliest
schema:
type: string
format: date-time
- in: query
name: latest
schema:
type: string
format: date-time
- in: query
name: object_id
schema:
Expand All @@ -181,12 +190,6 @@ paths:
description: A page number within the paginated result set.
schema:
type: integer
- in: query
name: timestamp
schema:
type: string
format: date-time

- in: query
name: user_id
schema:
Expand Down Expand Up @@ -628,6 +631,7 @@ paths:
security:
- JWTAuth: []
- ApiKeyAuth: []
- {}
responses:
'200':
content:
Expand Down Expand Up @@ -681,10 +685,10 @@ paths:
- The user must first install the CloudTruth GitHub Application in \ntheir\
\ GitHub organization and obtain the `installation_id` of the \napplication\
\ in order to create the integration.\n\n### Initiating the GitHub Application\
\ Installation ###\n\n- Go to `https://github.com/apps/cloudtruth-local/installations/new?state=<bearer_token>`\n\
- On successful installation the browser will return to \n`https://app.localhost/app_setup/github`\
\ \nand provide the `installation_id` in the URI.\n- POST to this api to verify\
\ and establish the integration."
\ Installation ###\n\n- Go to `https://github.com/apps/GITHUB_APP_NAME/installations/new?state=<bearer_token>`\n\
- On successful installation the browser will return to \n`https://APP_URL/app_setup/github`\
\ (configured in ctops/bin/github*) \nand provide the `installation_id` in\
\ the URI.\n- POST to this api to verify and establish the integration."
summary: Establishes a GitHub Integration.
tags:
- integrations
Expand Down Expand Up @@ -3656,21 +3660,26 @@ components:
values:
type: object
additionalProperties:
$ref: '#/components/schemas/Value'
readOnly: true
description: "\n Environments inherit from a single parent to\
\ form a tree, as a result\n a single parameter may have different\
\ values present for each environment.\n When a value is not\
\ explicitly set in an environment, the parent environment\n \
\ is consulted to see if it has a value defined, and so on.\n\n \
\ The dictionary of values has an environment url as the key, and\
\ the optional\n Value record that it resolves to. If the\
\ Value.environment matches the key,\n then it is an explicit\
\ value set for that environment. If they differ, the\n value\
\ was obtained from a parent environment (directly or indirectly). If\
\ the\n value is None then no value has ever been set in any\
\ environment for this\n parameter.\n\n key: Environment\
\ url\n value: optional Value record\n "
allOf:
- $ref: '#/components/schemas/Value'
nullable: true
readOnly: true
description: "\n Each parameter has an effective value in every\
\ environment based on\n environment inheritance and which\
\ environments have had a value set.\n\n Environments inherit\
\ from a single parent to form a tree, as a result\n a single\
\ parameter may have different values present for each environment.\n\
\ When a value is not explicitly set in an environment, the\
\ parent environment\n is consulted to see if it has a value\
\ defined, and so on.\n\n The dictionary of values has an environment\
\ url as the key, and the optional\n Value record that it resolves\
\ to. If the Value.environment matches the key,\n then it\
\ is an explicit value set for that environment. If they differ, the\n\
\ value was obtained from a parent environment (directly or\
\ indirectly). If the\n value is None then no value has ever\
\ been set in any environment for this\n parameter.\n\n \
\ key: Environment url\n value: optional Value record\n\
\ "
created_at:
type: string
format: date-time
Expand Down Expand Up @@ -3993,21 +4002,26 @@ components:
values:
type: object
additionalProperties:
$ref: '#/components/schemas/Value'
readOnly: true
description: "\n Environments inherit from a single parent to\
\ form a tree, as a result\n a single parameter may have different\
\ values present for each environment.\n When a value is not\
\ explicitly set in an environment, the parent environment\n \
\ is consulted to see if it has a value defined, and so on.\n\n \
\ The dictionary of values has an environment url as the key, and\
\ the optional\n Value record that it resolves to. If the\
\ Value.environment matches the key,\n then it is an explicit\
\ value set for that environment. If they differ, the\n value\
\ was obtained from a parent environment (directly or indirectly). If\
\ the\n value is None then no value has ever been set in any\
\ environment for this\n parameter.\n\n key: Environment\
\ url\n value: optional Value record\n "
allOf:
- $ref: '#/components/schemas/Value'
nullable: true
readOnly: true
description: "\n Each parameter has an effective value in every\
\ environment based on\n environment inheritance and which\
\ environments have had a value set.\n\n Environments inherit\
\ from a single parent to form a tree, as a result\n a single\
\ parameter may have different values present for each environment.\n\
\ When a value is not explicitly set in an environment, the\
\ parent environment\n is consulted to see if it has a value\
\ defined, and so on.\n\n The dictionary of values has an environment\
\ url as the key, and the optional\n Value record that it resolves\
\ to. If the Value.environment matches the key,\n then it\
\ is an explicit value set for that environment. If they differ, the\n\
\ value was obtained from a parent environment (directly or\
\ indirectly). If the\n value is None then no value has ever\
\ been set in any environment for this\n parameter.\n\n \
\ key: Environment url\n value: optional Value record\n\
\ "
created_at:
type: string
format: date-time
Expand Down Expand Up @@ -4071,6 +4085,11 @@ components:
type: string
format: date-time
readOnly: true
last_used_at:
type: string
format: date-time
readOnly: true
description: The most recent date and time the service account was used.
PatchedTemplate:
type: object
description: A parameter template in a given project, optionally instantiated
Expand Down Expand Up @@ -4105,6 +4124,10 @@ components:
type: string
format: uri
readOnly: true
has_secret:
type: boolean
readOnly: true
description: If True, this template contains secrets.
created_at:
type: string
format: date-time
Expand Down Expand Up @@ -4267,9 +4290,15 @@ components:
type: string
format: date-time
readOnly: true
last_used_at:
type: string
format: date-time
readOnly: true
description: The most recent date and time the service account was used.
required:
- created_at
- id
- last_used_at
- modified_at
- url
- user
Expand Down Expand Up @@ -4312,6 +4341,11 @@ components:
type: string
format: date-time
readOnly: true
last_used_at:
type: string
format: date-time
readOnly: true
description: The most recent date and time the service account was used.
apikey:
type: string
readOnly: true
Expand All @@ -4320,6 +4354,7 @@ components:
- apikey
- created_at
- id
- last_used_at
- modified_at
- url
- user
Expand Down Expand Up @@ -4357,6 +4392,10 @@ components:
type: string
format: uri
readOnly: true
has_secret:
type: boolean
readOnly: true
description: If True, this template contains secrets.
created_at:
type: string
format: date-time
Expand All @@ -4367,6 +4406,7 @@ components:
readOnly: true
required:
- created_at
- has_secret
- id
- modified_at
- name
Expand Down Expand Up @@ -4564,10 +4604,11 @@ components:
name: Authorization
type: apiKey
description: "\nUse your CloudTruth API Key to authenticate to the API. You\
\ can get\nan API Key by creating a Service Account in the UI. During setup\
\ of the Service\nAccount you will generate a long-lived API key intended\
\ for use by automation\nand API clients.\n\nIf you are just trying to use\
\ the API in a normal workflow, this is likely the\nauthentication mechanism\
\ can get\nan API Key by creating a Service Account. During setup of the\
\ Service\nAccount you will generate a long-lived API key intended for use\
\ by automation\nand API clients. Access through the service account will\
\ be audited separately\nfrom any other user.\n\nIf you are just trying to\
\ use the API in a normal workflow, this is likely the\nauthentication mechanism\
\ you want to use.\n\nTo use the API Key, place your API Key in the Authorization\
\ header as 'Api-Key APIKEY', where\nAPIKEY is your CloudTruth API Key. For\
\ example:\n\n Authorization: Api-Key fskur.ghlsiudhrg84so938r5u\n \
Expand Down

0 comments on commit b76eb58

Please sign in to comment.