oas3-api-test-runner/open-api-spec.json at main · bvanhorn-clear/oas3-api-test-runner · 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
{
  "openapi": "3.0.0",
  "info": {
    "version": "5.0.0.1",
    "title": "Visual Storage Intelligence",
    "license": {
      "name": "Proprietary Unlicensed - Copyright 2022 Clear Technologies, All Rights Resevered"
    }
  },
  "servers": [
    {
      "url": "http://vsi5-front-end-dev.cleartechnologies.net/api",
      "description": "The Dev server used for automated testing"
    },
    {
      "url": "http://vsi5-front-end-stage.cleartechnologies.net/api",
      "description": "The Stage server used for user acceptance testing (UAT)"
    },
    {
      "url": "https://vsi5.visualstorageintelligence.com/api",
      "description": "The VSI 5 production server"
    }
  ],
  "paths": {
    "/are_you_there": {
      "get": {
        "summary": "The UI calls this when it loads the login screen.",
        "operationId": "are_you_there",
        "tags": [
          "react-views"
        ],
        "responses": {
          "200": {
            "description": "If the back-end is up, we send back feature flag information, telemetry server address, and announcements, such as \"we'll be down for maintenance on 1/29/2020\".  If the UI doesn't get an answer, then it displays a \"down for maintenance\" screen.  The version number place-holder gets replaced by the build server with the actual build number, so don't change it in the code.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "version": {
                      "type": "string",
                      "description": "Four part build number separated by periods.  The value is filled in by the build server at the time of the build."
                    },
                    "announcements": {
                      "type": "array",
                      "description": "Array of announcements to be displayed on the login page",
                      "items": {
                        "type": "string"
                      }
                    },
                    "telemetry_socket": {
                      "type": "string",
                      "description": "the Uri used by the front-end to communicate with the telemetry server"
                    }
                  },
                  "examples": [

                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "user_info": {
        "properties": {
          "user_id": {
            "type": "integer"
          },
          "email": {
            "type": "string"
          },
          "token": {
            "type": "string"
          }
        }
      }
    }
  },
  "security": [
    {
      "BasicAuth": []
    }
  ]
}