openapi/src/svc-invocable-scripts.yml at master · influxdata/openapi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
openapi: '3.0.0'
info:
  title: InfluxData Invokable Scripts API
  version: 0.1.0
  description: |
      Manage and execute scripts as API endpoints in InfluxDB.

      An API Invokable Script assigns your custom Flux script to a new InfluxDB API endpoint for your organization.
      Invokable scripts let you execute your script as an HTTP request to the endpoint.

      Invokable scripts accept parameters. Add parameter references in your script as `params.myparameter`.
      When you `invoke` your script, you send parameters as key-value pairs in the `params` object.
      InfluxDB executes your script with the key-value pairs as arguments and returns the result.

      For more information and examples, see [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/).
  license:
    name: MIT
    url: 'https://opensource.org/licenses/MIT'
servers:
  - url: '/'
paths:
  '/scripts':
    $ref: './svc/invocable-scripts/paths/scripts.yml'
  '/scripts/{scriptID}':
    $ref: './svc/invocable-scripts/paths/scripts_scriptID.yml'
  '/scripts/{scriptID}/invoke':
    $ref: './svc/invocable-scripts/paths/scripts_scriptID_invoke.yml'
  '/scripts/{scriptID}/params':
    $ref: './svc/invocable-scripts/paths/scripts_scriptID_params.yml'
components:
  responses:
    ServerError:
      $ref: './common/responses/ServerError.yml'
    AuthorizationError:
      $ref: './common/responses/AuthorizationError.yml'
    BadRequestError:
      $ref: './common/responses/BadRequestError.yml'
    InternalServerError:
      $ref: './common/responses/InternalServerError.yml'
  schemas:
    Error:
      $ref: './common/schemas/Error.yml'
    Params:
      $ref: './svc/invocable-scripts/schemas/Params.yml'
    Script:
      $ref: './svc/invocable-scripts/schemas/Script.yml'
    Scripts:
      $ref: './svc/invocable-scripts/schemas/Scripts.yml'
    ScriptCreateRequest:
      $ref: './svc/invocable-scripts/schemas/ScriptCreateRequest.yml'
    ScriptUpdateRequest:
      $ref: './svc/invocable-scripts/schemas/ScriptUpdateRequest.yml'
    ScriptHTTPResponseData:
      $ref: './svc/invocable-scripts/schemas/ScriptHTTPResponseData.yml'
    ScriptInvocationParams:
      $ref: './svc/invocable-scripts/schemas/ScriptInvocationParams.yml'
    ScriptLanguage:
      $ref: './svc/invocable-scripts/schemas/ScriptLanguage.yml'