YLP-software/docs/api/openapi/sync.yaml at main · SAPOT-System/YLP-software · 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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
openapi: 3.1.0
info:
  title: SAPOT Server — Sync
  version: 0.1.2
paths:
  /sync/pull:
    get:
      tags:
      - sync
      summary: Pull Remote Changes
      operationId: pull_remote_changes_sync_pull_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: last_pulled_at
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Last Pulled At
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 100
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '404':
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /sync/push:
    post:
      tags:
      - sync
      summary: Push Local Data
      operationId: push_local_data_sync_push_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PushSyncRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '404':
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer: []
components:
  schemas:
    GuestUserHint:
      properties:
        first_name:
          type: string
          title: First Name
        last_name:
          type: string
          title: Last Name
        username:
          type: string
          title: Username
      type: object
      required:
      - first_name
      - last_name
      - username
      title: GuestUserHint
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PushSyncRequest:
      properties:
        changes:
          additionalProperties:
            $ref: '#/components/schemas/TableChanges'
          type: object
          title: Changes
        last_pulled_at:
          type: integer
          title: Last Pulled At
        guest_users:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/GuestUserHint'
            type: object
          - type: 'null'
          title: Guest Users
      type: object
      required:
      - changes
      - last_pulled_at
      title: PushSyncRequest
    TableChanges:
      properties:
        created:
          items: {}
          type: array
          title: Created
          default: []
        updated:
          items: {}
          type: array
          title: Updated
          default: []
        deleted:
          items:
            type: string
          type: array
          title: Deleted
          default: []
      type: object
      title: TableChanges
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: auth/token