Skip to content
This repository was archived by the owner on Feb 18, 2023. It is now read-only.

Commit 7bd23ef

Browse files
committed
update API docs
1 parent 19d901c commit 7bd23ef

File tree

3 files changed

+219
-17
lines changed

3 files changed

+219
-17
lines changed

docs/api/blueprint/dataStructures/users.apib

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,9 @@
3535
- links
3636
- previous: `http://laravelapi.dev/api/users?page=1` (string)
3737
- next: `http://laravelapi.dev/api/users?page=2` (string)
38-
- last: `http://laravelapi.dev/api/users?page=2` (string)
38+
- last: `http://laravelapi.dev/api/users?page=2` (string)
39+
40+
## User Update Password (object)
41+
- current_password: `12345` (string, required)
42+
- password: `123456789qq` (string, required)
43+
- password_confirmation: `123456789qq` (string, required)

docs/api/blueprint/routes/profile.apib

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121

2222
+ Attributes (Error 403)
2323

24-
+ Response 404 (application/json)
24+
+ Response 422 (application/json)
2525

26-
+ Attributes (Error 404)
26+
+ Attributes (Error 422)
2727

2828
### Full update logged in user profile [PUT]
2929

@@ -48,9 +48,9 @@
4848

4949
+ Attributes (Error 403)
5050

51-
+ Response 404 (application/json)
51+
+ Response 422 (application/json)
5252

53-
+ Attributes (Error 404)
53+
+ Attributes (Error 422)
5454

5555
### Partial update logged in user profile [PATCH]
5656

@@ -75,6 +75,33 @@
7575

7676
+ Attributes (Error 403)
7777

78-
+ Response 404 (application/json)
78+
+ Response 422 (application/json)
7979

80-
+ Attributes (Error 404)
80+
+ Attributes (Error 422)
81+
82+
### Change logged in user password [PUT /api/me/password]
83+
84+
+ Request (application/vnd.api.v1+json)
85+
86+
+ Headers
87+
88+
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
89+
90+
+ Attributes (User Update Password)
91+
92+
+ Response 200 (application/json)
93+
94+
+ Attributes
95+
+ data (User Object)
96+
97+
+ Response 401 (application/json)
98+
99+
+ Attributes (Error 401)
100+
101+
+ Response 403 (application/json)
102+
103+
+ Attributes (Error 403)
104+
105+
+ Response 422 (application/json)
106+
107+
+ Attributes (Error 422)

0 commit comments

Comments
 (0)