Code-and-Coffee-Website-Service/src/api/swagger.yaml at main · CodeandCoffeeCommunity/Code-and-Coffee-Website-Service · 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
x-stoplight:
  id: djcn4tffq45ve
info:
  title: Code and Coffee Service
  version: "1.0"
  description: This is the API endpoints for the Code and Coffee Service. This service allows us to augment our website with custom functionality built by the community. Note the API is behind a cache that will delay updates.
  contact:
    name: Brian Towne
    email: BJTowne9@gmail.com
    url: "https://www.linkedin.com/in/bjtowne/"
servers: []
paths:
  /events:
    get:
      summary: Events
      tags:
        - Events
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    eventUrl:
                      type: string
                    title:
                      type: string
                    going:
                      type: string
                    imageUrl:
                      type: string
                    venue:
                      type: object
                      properties:
                        name:
                          type: string
                        address:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                    dateTime:
                      type: string
                    group:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                    description:
                      type: string
      operationId: get-events
      description: Get the current events for Code and Coffee Nationally.
  /health:
    get:
      summary: Health Check
      tags:
        - Health
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - OK
                  timestamp:
                    type: string
      operationId: get-health
      description: A health check endpoint used to validate the health of the APIs.
components:
  schemas: {}