datacloud-customcode-python-sdk/sample/analyze.yaml at 8152929e2cc5a35226ae084cbc7e3674d9a0c27d · forcedotcom/datacloud-customcode-python-sdk · 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
59
60
61
62
63
openapi: 3.0.0
info:
  title: Analyze Service
  description: API generated from Python function schema
  version: 1.0.0
paths:
  /analyze:
    post:
      summary: Analyze data with filters and return grouped results
      description: Analyze data with filters and return grouped results.
      operationId: analyze
      x-sfdc:
        code-extension:
          feature: BYOC
          language: python
          namespace: salesforceOrg
          package: dataCloudPkg
          name: analyzeFn
          prototype: 'analyze(request: dict) -> dict'
          requestSchema: 'dict(dataset: str, filters: Optional[Dict[str, List[str]]],
            limit: Optional[int])'
          responseSchema: 'dict(rows: List[Dict[str, int]], total: int)'
          description: Will perform analyze operation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                dataset:
                  type: string
                filters:
                  type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
                limit:
                  type: integer
              required:
              - dataset
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  rows:
                    type: array
                    items:
                      type: object
                      additionalProperties:
                        type: integer
                  total:
                    type: integer
                required:
                - rows
                - total
        '400':
          description: Invalid input