split/openapi/split-admin-api-openapi.yml at main · api-evangelist/split · 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
90
91
92
93
openapi: 3.1.0
info:
  title: Split Admin API
  description: The Split Admin API is a REST API that enables programmatic management of workspaces (projects), environments, traffic types, attributes, users, groups, API keys, and change requests within the Split platform (now Harness Feature Management and Experimentation). The API uses resource-oriented URLs, returns JSON responses, and requires Admin API keys for authentication. All endpoints are prefixed with /internal/api/v2 on the api.split.io host.
  version: '2.0'
  contact:
    name: Split Support
    url: https://help.split.io
  termsOfService: https://www.split.io/terms-of-service/
servers:
- url: https://api.split.io/internal/api/v2
  description: Production Server
security:
- bearerAuth: []
tags:
- name: Admin
paths:
  /admin/ping:
    get:
      operationId: ping
      summary: Ping service
      description: Checks whether the Split Evaluator service is running. If the service is running, it responds with the text pong and HTTP status code 200.
      tags:
      - Admin
      responses:
        '200':
          description: Service is running
          content:
            text/plain:
              schema:
                type: string
                example: pong
  /admin/version:
    get:
      operationId: getVersion
      summary: Get service version
      description: Returns the current version of the Split Evaluator service.
      tags:
      - Admin
      responses:
        '200':
          description: Service version information
          content:
            application/json:
              schema:
                type: object
                properties:
                  version:
                    type: string
                    description: Version string of the running Evaluator
  /admin/healthcheck:
    get:
      operationId: healthCheck
      summary: Health check
      description: Checks that the Split Evaluator is connected to Split servers and ready to process evaluation requests. Returns 200 if everything is working as expected or 500 if there is an issue, along with a message explaining the status.
      tags:
      - Admin
      responses:
        '200':
          description: Service is healthy and ready for evaluations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
        '500':
          description: Service is unhealthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
components:
  schemas:
    HealthCheckResponse:
      type: object
      description: Health check response from the Split Evaluator
      properties:
        status:
          type: string
          description: Health status of the service
          enum:
          - ok
          - error
        message:
          type: string
          description: Detailed message about the health status
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Admin API key passed as a Bearer token in the Authorization header.
externalDocs:
  description: Split Admin API Documentation
  url: https://docs.split.io/reference/introduction