1d6-api/openapi.yaml at main · OneDSix/1d6-api · 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
openapi: 3.0.2

info:
  title: 1D6 API
  description: The public REST API for 1D6. Found here is Accounts, Mods, Servers, etc.
  version: 1.0.0

servers:
  - url: http://localhost:8000
    description: The location the development server is hosted at, assuming you ran `cargo shuttle run`.
  - url: https://onedsix-api.shuttleapp.rs/
    description: Production environment, everyone has access to this.

tags:
  - name: user
    description: Endpoints focused around users
  - name: mods
    description: Endpoints focused around mods and addons

paths:
  /:
    get:
      summary: Returns a basic "Welcome traveler!" message, along with a link to the docs. The message string may change depending on the date.
      responses:
        "200":
          description: the request was a success
          content:
            application/json:
              schema:
                type: object
                properties:
                  api_version:
                    type: string
                    description: The preferred version of the api, say "/v1/data" or "/v3/similar_date"
                  documentation:
                    type: string
                    description: A link to the documentation
                  message:
                    type: string
                    description: A basic "Welcome traveler!" message, that gets replaced on certain holidays.
                additionalProperties: false
                required:
                  - api_version
                  - documentation
                  - message


components:
  schemas:
    BaseError:
      description: All errors coming from the API will be formatted like this.
      type: object
      properties:
        error:
          type: string
        description:
          type: string
      additionalProperties: false
      required:
        - error
        - description