View | Details | Raw Unified | Return to bug 23584
Collapse All | Expand All

(-)a/api/v1/swagger/paths.json (+6 lines)
Lines 73-77 Link Here
73
  },
73
  },
74
  "/public/patrons/{patron_id}/password": {
74
  "/public/patrons/{patron_id}/password": {
75
    "$ref": "paths/public_patrons.json#/~1public~1patrons~1{patron_id}~1password"
75
    "$ref": "paths/public_patrons.json#/~1public~1patrons~1{patron_id}~1password"
76
  },
77
  "/public/patrons/{patron_id}/guarantors/can_see_charges": {
78
    "$ref": "paths/public_patrons.json#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_charges"
79
  },
80
  "/public/patrons/{patron_id}/guarantors/can_see_checkouts": {
81
    "$ref": "paths/public_patrons.json#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_checkouts"
76
  }
82
  }
77
}
83
}
(-)a/api/v1/swagger/paths/public_patrons.json (-82 / +235 lines)
Lines 1-86 Link Here
1
{
1
{
2
  "/public/patrons/{patron_id}/password": {
2
    "/public/patrons/{patron_id}/password": {
3
    "post": {
3
        "post": {
4
      "x-mojo-to": "Patrons::Password#set_public",
4
            "x-mojo-to": "Patrons::Password#set_public",
5
      "operationId": "setPatronPasswordPublic",
5
            "operationId": "setPatronPasswordPublic",
6
      "tags": [
6
            "tags": [
7
        "patron"
7
                "patron"
8
      ],
8
            ],
9
      "parameters": [
9
            "parameters": [
10
        {
10
                {
11
          "$ref": "../parameters.json#/patron_id_pp"
11
                    "$ref": "../parameters.json#/patron_id_pp"
12
        },
12
                },
13
        {
13
                {
14
          "name": "body",
14
                    "name": "body",
15
          "in": "body",
15
                    "in": "body",
16
          "description": "A JSON object containing password information",
16
                    "description": "A JSON object containing password information",
17
          "schema": {
17
                    "schema": {
18
            "type": "object",
18
                        "type": "object",
19
            "properties": {
19
                        "properties": {
20
              "password": {
20
                            "password": {
21
                "description": "New password (plain text)",
21
                                "description": "New password (plain text)",
22
                "type": "string"
22
                                "type": "string"
23
              },
23
                            },
24
              "password_repeated": {
24
                            "password_repeated": {
25
                "description": "Repeated new password (plain text)",
25
                                "description": "Repeated new password (plain text)",
26
                "type": "string"
26
                                "type": "string"
27
              },
27
                            },
28
              "old_password": {
28
                            "old_password": {
29
                "description": "Patron's original password",
29
                                "description": "Patron's original password",
30
                "type": "string"
30
                                "type": "string"
31
              }
31
                            }
32
                        },
33
                        "required": [
34
                            "password",
35
                            "password_repeated",
36
                            "old_password"
37
                        ]
38
                    }
39
                }
40
            ],
41
            "produces": [
42
                "application/json"
43
            ],
44
            "responses": {
45
                "200": {
46
                    "description": "Password changed"
47
                },
48
                "400": {
49
                    "description": "Bad request",
50
                    "schema": {
51
                        "$ref": "../definitions.json#/error"
52
                    }
53
                },
54
                "401": {
55
                    "description": "Authentication required",
56
                    "schema": {
57
                        "$ref": "../definitions.json#/error"
58
                    }
59
                },
60
                "403": {
61
                    "description": "Access forbidden",
62
                    "schema": {
63
                        "$ref": "../definitions.json#/error"
64
                    }
65
                },
66
                "404": {
67
                    "description": "Patron not found",
68
                    "schema": {
69
                        "$ref": "../definitions.json#/error"
70
                    }
71
                },
72
                "500": {
73
                    "description": "Internal server error",
74
                    "schema": {
75
                        "$ref": "../definitions.json#/error"
76
                    }
77
                },
78
                "503": {
79
                    "description": "Under maintenance",
80
                    "schema": {
81
                        "$ref": "../definitions.json#/error"
82
                    }
83
                }
32
            },
84
            },
33
            "required": ["password", "password_repeated", "old_password"]
85
            "x-koha-authorization": {
34
          }
86
                "allow-owner": true
87
            }
35
        }
88
        }
36
      ],
89
    },
37
      "produces": [
90
    "/public/patrons/{patron_id}/guarantors/can_see_charges": {
38
        "application/json"
91
        "put": {
39
      ],
92
            "x-mojo-to": "Patrons#guarantors_can_see_charges",
40
      "responses": {
93
            "operationId": "setPatronGuarantorsCanSeeCharges",
41
        "200": {
94
            "tags": [
42
          "description": "Password changed"
95
                "patron"
43
        },
96
            ],
44
        "400": {
97
            "parameters": [
45
          "description": "Bad request",
98
                {
46
          "schema": {
99
                    "$ref": "../parameters.json#/patron_id_pp"
47
            "$ref": "../definitions.json#/error"
100
                },
48
          }
101
                {
49
        },
102
                    "name": "body",
50
        "401": {
103
                    "in": "body",
51
          "description": "Authentication required",
104
                    "description": "A boolean representing if guarantors should be able to see the patron's charges",
52
          "schema": {
105
                    "required": true,
53
            "$ref": "../definitions.json#/error"
106
                    "schema": {
54
          }
107
                        "type": "object",
55
        },
108
                        "properties": {
56
        "403": {
109
                            "allowed": {
57
          "description": "Access forbidden",
110
                                "type": "boolean"
58
          "schema": {
111
                            }
59
            "$ref": "../definitions.json#/error"
112
                        }
60
          }
113
                    }
61
        },
114
                }
62
        "404": {
115
            ],
63
          "description": "Patron not found",
116
            "produces": [
64
          "schema": {
117
                "application/json"
65
            "$ref": "../definitions.json#/error"
118
            ],
66
          }
119
            "responses": {
67
        },
120
                "200": {
68
        "500": {
121
                    "description": "Charges view policy for guarantors changed"
69
          "description": "Internal server error",
122
                },
70
          "schema": {
123
                "400": {
71
            "$ref": "../definitions.json#/error"
124
                    "description": "Bad request",
72
          }
125
                    "schema": {
73
        },
126
                        "$ref": "../definitions.json#/error"
74
        "503": {
127
                    }
75
          "description": "Under maintenance",
128
                },
76
          "schema": {
129
                "401": {
77
            "$ref": "../definitions.json#/error"
130
                    "description": "Authentication required",
78
          }
131
                    "schema": {
132
                        "$ref": "../definitions.json#/error"
133
                    }
134
                },
135
                "403": {
136
                    "description": "Access forbidden",
137
                    "schema": {
138
                        "$ref": "../definitions.json#/error"
139
                    }
140
                },
141
                "404": {
142
                    "description": "Patron not found",
143
                    "schema": {
144
                        "$ref": "../definitions.json#/error"
145
                    }
146
                },
147
                "500": {
148
                    "description": "Internal server error",
149
                    "schema": {
150
                        "$ref": "../definitions.json#/error"
151
                    }
152
                },
153
                "503": {
154
                    "description": "Under maintenance",
155
                    "schema": {
156
                        "$ref": "../definitions.json#/error"
157
                    }
158
                }
159
            },
160
            "x-koha-authorization": {
161
                "allow-owner": true
162
            }
163
        }
164
    },
165
    "/public/patrons/{patron_id}/guarantors/can_see_checkouts": {
166
        "put": {
167
            "x-mojo-to": "Patrons#guarantors_can_see_checkouts",
168
            "operationId": "setPatronGuarantorsCanSeeCheckouts",
169
            "tags": [
170
                "patron"
171
            ],
172
            "parameters": [
173
                {
174
                    "$ref": "../parameters.json#/patron_id_pp"
175
                },
176
                {
177
                    "name": "body",
178
                    "in": "body",
179
                    "description": "A boolean representing if guarantors should be able to see the patron's checkouts",
180
                    "required": true,
181
                    "schema": {
182
                        "type": "object",
183
                        "properties": {
184
                            "allowed": {
185
                                "type": "boolean"
186
                            }
187
                        }
188
                    }
189
                }
190
            ],
191
            "produces": [
192
                "application/json"
193
            ],
194
            "responses": {
195
                "200": {
196
                    "description": "Check-out view policy for guarantors changed"
197
                },
198
                "400": {
199
                    "description": "Bad request",
200
                    "schema": {
201
                        "$ref": "../definitions.json#/error"
202
                    }
203
                },
204
                "401": {
205
                    "description": "Authentication required",
206
                    "schema": {
207
                        "$ref": "../definitions.json#/error"
208
                    }
209
                },
210
                "403": {
211
                    "description": "Access forbidden",
212
                    "schema": {
213
                        "$ref": "../definitions.json#/error"
214
                    }
215
                },
216
                "404": {
217
                    "description": "Patron not found",
218
                    "schema": {
219
                        "$ref": "../definitions.json#/error"
220
                    }
221
                },
222
                "500": {
223
                    "description": "Internal server error",
224
                    "schema": {
225
                        "$ref": "../definitions.json#/error"
226
                    }
227
                },
228
                "503": {
229
                    "description": "Under maintenance",
230
                    "schema": {
231
                        "$ref": "../definitions.json#/error"
232
                    }
233
                }
234
            },
235
            "x-koha-authorization": {
236
                "allow-owner": true
237
            }
79
        }
238
        }
80
      },
81
      "x-koha-authorization": {
82
        "allow-owner": true
83
      }
84
    }
239
    }
85
  }
240
}
86
}
87
- 

Return to bug 23584