analytics/openapi.json at master · Rello/analytics · 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
{
  "openapi": "3.0.0",
  "info": {
    "title": "Analytics OCS API",
    "version": "1.0.0"
  },
  "paths": {
    "/ocs/v2.php/apps/analytics/createFromDataFile": {
      "post": {
        "summary": "Create analytics report from a data file",
        "operationId": "createFromDataFile",
        "tags": ["analytics"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "fileId": {
                    "type": "integer",
                    "description": "ID of the file to import"
                  }
                },
                "required": ["fileId"]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Report created",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "version": {"type": "number"},
                    "root": {
                      "type": "object",
                      "properties": {
                        "orientation": {"type": "string"},
                        "rows": {
                          "type": "array",
                          "items": {"type": "object"}
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {"description": "File not found"}
        }
      }
    }
  }
}