example-openapi-spec/oauth-authcode.yaml at main · SLdragon/example-openapi-spec · 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
openapi: 3.0.0
info:
  title: Repair Service
  description: A simple service to manage repairs
  version: 1.0.0
servers:
  - url: https://customcopilotapikey.azurewebsites.net
    description: The repair api server
components:
  securitySchemes:
    oAuth2AuthCode:
      type: oauth2
      description: For more information, see https://api.slack.com/docs/oauth
      flows:
        authorizationCode:
          authorizationUrl: https://slack.com/oauth/authorize
          tokenUrl: https://slack.com/api/oauth.access
          scopes:
            users:read: Read user information
            users:write: Modify user information
            im:read: Read messages
            im:write: Write messages
            im:history: Access the message archive
            search:read: Search messages, files, and so on
paths:
  /assignRepair:
    get:
      operationId: assignRepair
      summary: >-
        Assign repair to technician for the customer based on car type and
        repair type
      description: >-
        Assign repair to technician for the customer based on car type and
        repair type
      security:
        - oAuth2AuthCode: []
      parameters:
        - name: carType
          in: query
          description: Car type to repair
          schema:
            type: string
          required: true
        - name: repairType
          in: query
          description: Repair type for the car
          schema:
            type: string
          required: true
        - name: customerName
          in: query
          description: Customer name
          schema:
            type: string
          required: true
        - name: customerPhoneNumber
          in: query
          description: Customer phone number
          schema:
            type: string
          required: true
      responses:
        '200':
          description: The response that represents an appointment for the repair
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Id of the repair
                  title:
                    type: string
                    description: The short summary of the repair
                  assignedTo:
                    type: string
                    description: The engineer who is responsible for the repair
                  customerPhoneNumber:
                    type: string
                    description: The phone number of the customer
                  date:
                    type: string
                    format: date-time
                    description: >-
                      The date and time when the repair is scheduled or
                      completed
                  image:
                    type: string
                    format: uri
                    description: >-
                      The URL of the image of the item to be repaired or the
                      repair process
                  apiKey:
                    type: string
                    description: The api key from bearer token
  /findRepair:
    get:
      operationId: findRepair
      summary: Find repair by customer name
      description: Find repair by customer name
      security:
        - oAuth2AuthCode: []
      parameters:
        - name: customerName
          in: query
          description: Customer name
          schema:
            type: string
          required: true
      responses:
        '200':
          description: The response that represent an appointment for the repair
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Id of the repair
                  title:
                    type: string
                    description: The short summary of the repair
                  assignedTo:
                    type: string
                    description: The engineer who is responsible for the repair
                  customerPhoneNumber:
                    type: string
                    description: The phone number of the customer
                  customerName:
                    type: string
                    description: The customer name
                  date:
                    type: string
                    format: date-time
                    description: >-
                      The date and time when the repair is scheduled or
                      completed
                  image:
                    type: string
                    format: uri
                    description: >-
                      The URL of the image of the item to be repaired or the
                      repair process
                  apiKey:
                    type: string
                    description: The api key from bearer token