🔌后端接口定义

后端接口定义文档用于定义后端服务的接口,包括接口的URL、请求方法(如GET、POST等)、请求参数、返回数据格式。

1 概述

本文档是软件后端接口定义文档,遵循Swagger2.0协议,是对Swagger自动生成的API文档的详细标注。该文档主要起到如下作用:

  • 对开发团队/第三方开发者

    • 前端可以根据本文档进行后端接口调用

    • 测试可以根据本文档进行接口测试

    • 后端可以参考该文档进行迭代开发

  • 对用户

    • 用户可以了解后端系统的可用功能

本文档由 唐锦洲 负责编写。

2 用户模块

2.1 用户注册和登录

post

用户登录获取JWT

Authorizations
AuthorizationstringRequired
Body
usernamestring · min: 1Required
passwordstring · min: 1Required
Responses
chevron-right
200

登录成功

application/json
post
/users/login/
post

创建新用户

Authorizations
AuthorizationstringRequired
Body
usernamestring · min: 1 · max: 150Required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Pattern: ^[\w.@+-]+$
passwordstring · min: 1 · max: 128Required
emailstring · email · max: 254Optional
telephonestring · max: 11Optional
nicknamestring · max: 50Optional
signaturestringOptional
avatarstring · uriRead-onlyOptional
birthdaystring · dateOptional
genderstring · enumOptionalPossible values:
followinginteger[]Optional
followerinteger[]Optional
Responses
post
/users/register/
post

Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.

Authorizations
AuthorizationstringRequired
Body
refreshstring · min: 1Required
accessstring · min: 1Read-onlyOptional
Responses
post
/users/refresh/
201Success

2.2 用户个人信息

get

获取所有用户的列表

Authorizations
AuthorizationstringRequired
Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
chevron-right
200

获取成功

application/json
get
/users/profile/
200

获取成功

get

获取指定用户的详细信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this user.

Responses
chevron-right
200

获取成功

application/json
get
/users/profile/{id}/
put

更新指定用户的详细信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this user.

Body
usernamestring · min: 1 · max: 150Required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Pattern: ^[\w.@+-]+$
passwordstring · min: 1 · max: 128Required
emailstring · email · max: 254Optional
telephonestring · max: 11Optional
nicknamestring · max: 50Optional
signaturestringOptional
avatarstring · uriRead-onlyOptional
birthdaystring · dateOptional
genderstring · enumOptionalPossible values:
followinginteger[]Optional
followerinteger[]Optional
Responses
chevron-right
200

更新成功

application/json
put
/users/profile/{id}/
delete

删除指定用户

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this user.

Responses
delete
/users/profile/{id}/
patch

部分更新指定用户的详细信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this user.

Body
usernamestring · min: 1 · max: 150Required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Pattern: ^[\w.@+-]+$
passwordstring · min: 1 · max: 128Required
emailstring · email · max: 254Optional
telephonestring · max: 11Optional
nicknamestring · max: 50Optional
signaturestringOptional
avatarstring · uriRead-onlyOptional
birthdaystring · dateOptional
genderstring · enumOptionalPossible values:
followinginteger[]Optional
followerinteger[]Optional
Responses
chevron-right
200

部分更新成功

application/json
patch
/users/profile/{id}/

2.3 绑定电动车通行证

post

绑定用户车辆通行证信息

Authorizations
AuthorizationstringRequired
Body
permit_numberstring · min: 1 · max: 100Required
issued_datestring · dateOptional
expiry_datestring · dateOptional
owner_namestring · max: 150Optional
Responses
post
/users/bind-permit/
delete

解绑用户车辆通行证信息

Authorizations
AuthorizationstringRequired
Responses
delete
/users/unbind-permit/

2.4 删除用户(需要管理员权限)

delete

删除用户

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
delete
/users/delete/{id}/

3 电动车信息模块

3.1 电动车基本信息

get

获取所有电动车的列表

Authorizations
AuthorizationstringRequired
Query parameters
brandstringOptional

brand

ratingstringOptional

rating

release_datestringOptional

release_date

min_pricestringOptional

min_price

max_pricestringOptional

max_price

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

Responses
chevron-right
200

获取成功

No content

get
/bikes/
200

获取成功

No content

post

创建新的电动车

Authorizations
AuthorizationstringRequired
Body
idintegerRead-onlyOptional
brandstring · max: 100Optional
modelstring · max: 100Optional
pricestring · decimalOptional
ratingnumberOptional
release_datestring · dateOptional
descriptionstringOptional
Responses
post
/bikes/

No content

get

获取所有电动车ID列表

Authorizations
AuthorizationstringRequired
Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
chevron-right
200

获取成功

No content

get
/bikes/id/

No content

get

获取指定电动车的详细信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this bike.

Responses
chevron-right
200

获取成功

No content

get
/bikes/{id}/

No content

put

更新指定电动车的信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this bike.

Body
idintegerRead-onlyOptional
brandstring · max: 100Optional
modelstring · max: 100Optional
pricestring · decimalOptional
ratingnumberOptional
release_datestring · dateOptional
descriptionstringOptional
Responses
chevron-right
200

更新成功

No content

put
/bikes/{id}/

No content

delete

删除指定电动车

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this bike.

Responses
delete
/bikes/{id}/

No content

patch

部分更新指定电动车的信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this bike.

Body
idintegerRead-onlyOptional
brandstring · max: 100Optional
modelstring · max: 100Optional
pricestring · decimalOptional
ratingnumberOptional
release_datestring · dateOptional
descriptionstringOptional
Responses
chevron-right
200

部分更新成功

No content

patch
/bikes/{id}/

No content

3.2 电动车图片

post

创建电动车图片

Authorizations
AuthorizationstringRequired
Body
idintegerRead-onlyOptional
bikeintegerRequired
imagestring · uriRead-onlyOptional
Responses
post
/bikes/images/

No content

delete

删除电动车图片

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this bike image.

Responses
delete
/bikes/images/{id}/

No content

3.3 电动车商家渠道

get

获取所有渠道的列表

Authorizations
AuthorizationstringRequired
Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
chevron-right
200

获取成功

No content

get
/bikes/channel/
200

获取成功

No content

post

创建新的渠道

Authorizations
AuthorizationstringRequired
Body
idintegerRead-onlyOptional
bikeintegerRequired
namestring · min: 1 · max: 100Required
urlstring · uri · min: 1 · max: 200Required
service_infostring · min: 1Required
Responses
post
/bikes/channel/

No content

get

获取所有渠道ID列表

Authorizations
AuthorizationstringRequired
Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
chevron-right
200

获取成功

No content

get
/bikes/channel/id/
200

获取成功

No content

get

获取指定渠道的详细信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this channel.

Responses
chevron-right
200

获取成功

No content

get
/bikes/channel/{id}/

No content

put

更新指定渠道的信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this channel.

Body
idintegerRead-onlyOptional
bikeintegerRequired
namestring · min: 1 · max: 100Required
urlstring · uri · min: 1 · max: 200Required
service_infostring · min: 1Required
Responses
chevron-right
200

更新成功

No content

put
/bikes/channel/{id}/

No content

delete

删除指定渠道

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this channel.

Responses
delete
/bikes/channel/{id}/

No content

patch

部分更新指定渠道的信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this channel.

Body
idintegerRead-onlyOptional
bikeintegerRequired
namestring · min: 1 · max: 100Required
urlstring · uri · min: 1 · max: 200Required
service_infostring · min: 1Required
Responses
chevron-right
200

部分更新成功

No content

patch
/bikes/channel/{id}/

No content

4 社交模块

4.1 车小圈帖子

get

获取所有车小圈帖子

Authorizations
AuthorizationstringRequired
Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
chevron-right
200

获取成功

No content

get
/social/post/

No content

post

创建车小圈帖子

Authorizations
AuthorizationstringRequired
Body
idstring · uuidRead-onlyOptional
userstringRead-onlyOptional
titlestring · min: 1 · max: 255Optional
contentstring · min: 1Optional
created_atstring · date-timeRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
locationstring · max: 255Optional
likes_countintegerOptionalDefault: 0
views_countintegerOptionalDefault: 0
commentsinteger[]Read-onlyOptional
Responses
post
/social/post/

No content

get

获取用户发布过的帖子

Authorizations
AuthorizationstringRequired
Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
chevron-right
200

获取成功

No content

get
/social/post/mine/

No content

get

获取指定的车小圈帖子

Authorizations
AuthorizationstringRequired
Path parameters
idstring · uuidRequired

A UUID string identifying this post.

Responses
chevron-right
200

获取成功

No content

get
/social/post/{id}/

No content

put

更新指定的车小圈帖子

Authorizations
AuthorizationstringRequired
Path parameters
idstring · uuidRequired

A UUID string identifying this post.

Body
idstring · uuidRead-onlyOptional
userstringRead-onlyOptional
titlestring · min: 1 · max: 255Optional
contentstring · min: 1Optional
created_atstring · date-timeRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
locationstring · max: 255Optional
likes_countintegerOptionalDefault: 0
views_countintegerOptionalDefault: 0
commentsinteger[]Read-onlyOptional
Responses
chevron-right
200

更新成功

No content

put
/social/post/{id}/

No content

delete

删除指定的车小圈帖子

Authorizations
AuthorizationstringRequired
Path parameters
idstring · uuidRequired

A UUID string identifying this post.

Responses
delete
/social/post/{id}/

No content

patch

部分更新指定的车小圈帖子

Authorizations
AuthorizationstringRequired
Path parameters
idstring · uuidRequired

A UUID string identifying this post.

Body
idstring · uuidRead-onlyOptional
userstringRead-onlyOptional
titlestring · min: 1 · max: 255Optional
contentstring · min: 1Optional
created_atstring · date-timeRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
locationstring · max: 255Optional
likes_countintegerOptionalDefault: 0
views_countintegerOptionalDefault: 0
commentsinteger[]Read-onlyOptional
Responses
chevron-right
200

部分更新成功

No content

patch
/social/post/{id}/

No content

4.2 车小圈帖子评论

get

获取所有评论

Authorizations
AuthorizationstringRequired
Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
chevron-right
200

获取成功

No content

get
/social/comment/

No content

post

为帖子创建新评论

Authorizations
AuthorizationstringRequired
Body
idintegerRead-onlyOptional
poststring · uuidRequired
contentstring · min: 1Required
created_atstring · date-timeRead-onlyOptional
likes_countintegerOptionalDefault: 0
parentintegerOptional
repliesinteger[]Read-onlyOptional
usernamestringRead-onlyOptional
post_titlestringRead-onlyOptional
Responses
post
/social/comment/

No content

get

获取指定的车小圈帖子评论

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this comment.

Responses
chevron-right
200

获取成功

No content

get
/social/comment/{id}/

No content

put

更新指定的车小圈帖子评论

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this comment.

Body
idintegerRead-onlyOptional
poststring · uuidRequired
contentstring · min: 1Required
created_atstring · date-timeRead-onlyOptional
likes_countintegerOptionalDefault: 0
parentintegerOptional
repliesinteger[]Read-onlyOptional
usernamestringRead-onlyOptional
post_titlestringRead-onlyOptional
Responses
chevron-right
200

更新成功

No content

put
/social/comment/{id}/

No content

delete

删除指定的车小圈帖子评论

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this comment.

Responses
delete
/social/comment/{id}/

No content

patch

部分更新指定的车小圈帖子评论

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this comment.

Body
idintegerRead-onlyOptional
poststring · uuidRequired
contentstring · min: 1Required
created_atstring · date-timeRead-onlyOptional
likes_countintegerOptionalDefault: 0
parentintegerOptional
repliesinteger[]Read-onlyOptional
usernamestringRead-onlyOptional
post_titlestringRead-onlyOptional
Responses
chevron-right
200

部分更新成功

No content

patch
/social/comment/{id}/

No content

4.3 车小圈用户互动

get

获取当前用户的所有点赞过的帖子

Authorizations
AuthorizationstringRequired
Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
chevron-right
200

获取成功

No content

get
/social/post/likes/

No content

get

获取当前用户的所有收藏过的帖子

Authorizations
AuthorizationstringRequired
Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
chevron-right
200

获取成功

No content

get
/social/post/favorites/

No content

post

修改当前用户对特定帖子点赞/收藏状态

Authorizations
AuthorizationstringRequired
Responses
post
/social/post/interaction/toggle/

No content

post

获取特定帖子的点赞/收藏数量

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200

获取成功

No content

post
/social/post/interaction/count/

No content

post

修改当前用户对另一用户的关注状态

Authorizations
AuthorizationstringRequired
Body
user_idintegerRequired
Responses
chevron-right
200

操作成功

No content

post
/social/follow/toggle/

No content

4.4 车小圈首页

get

获取首页的车小圈帖子,支持指定页码

Authorizations
AuthorizationstringRequired
Query parameters
pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

Responses
chevron-right
200

获取成功

No content

get
/social/homepage/

No content

5 二手交易模块

post

发布新的商品

Authorizations
AuthorizationstringRequired
Responses
post
/exchange/goods/

No content

get

获取当前用户发布的所有商品

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200

获取成功

No content

get
/exchange/goods/mine/
200

获取成功

No content

get

获取指定商品的详细信息

Authorizations
AuthorizationstringRequired
Path parameters
hashstringRequired

A unique value identifying this goods.

Responses
chevron-right
200

获取成功

No content

get
/exchange/goods/{hash}/

No content

put
Authorizations
AuthorizationstringRequired
Path parameters
hashstringRequired

A unique value identifying this goods.

Body
ownerintegerRequired
hashstring · min: 1 · max: 32Required
contentstring · min: 1 · max: 300Required
moneystring · min: 1 · max: 10Required
origin_moneystring · min: 1 · max: 10Required
send_moneystring · min: 1 · max: 10Required
classifystring · min: 1 · max: 200Required
edit_datestring · date-timeRead-onlyOptional
Responses
chevron-right
200Success
application/json
put
/exchange/goods/{hash}/
200Success
delete
Authorizations
AuthorizationstringRequired
Path parameters
hashstringRequired

A unique value identifying this goods.

Responses
delete
/exchange/goods/{hash}/
204Success

No content

patch
Authorizations
AuthorizationstringRequired
Path parameters
hashstringRequired

A unique value identifying this goods.

Body
ownerintegerRequired
hashstring · min: 1 · max: 32Required
contentstring · min: 1 · max: 300Required
moneystring · min: 1 · max: 10Required
origin_moneystring · min: 1 · max: 10Required
send_moneystring · min: 1 · max: 10Required
classifystring · min: 1 · max: 200Required
edit_datestring · date-timeRead-onlyOptional
Responses
chevron-right
200Success
application/json
patch
/exchange/goods/{hash}/
200Success

6 维修模块

6.1 维修预约

get

获取用户的所有预约

Authorizations
AuthorizationstringRequired
Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
chevron-right
200

获取成功

No content

get
/maintenance/appointments/

No content

post

创建新的预约

Authorizations
AuthorizationstringRequired
Body
idintegerRead-onlyOptional
service_typestring · min: 1 · max: 255Required
appointment_timestring · date-timeRequired
statusstring · enumOptionalDefault: pendingPossible values:
created_atstring · date-timeRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
status_changedstring · date-timeOptional
userintegerRequired
shopintegerRequired
Responses
post
/maintenance/appointments/

No content

get

获取指定的预约详情

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this appointment.

Responses
chevron-right
200

获取成功

No content

get
/maintenance/appointments/{id}/

No content

put

更新指定的预约信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this appointment.

Body
idintegerRead-onlyOptional
service_typestring · min: 1 · max: 255Required
appointment_timestring · date-timeRequired
statusstring · enumOptionalDefault: pendingPossible values:
created_atstring · date-timeRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
status_changedstring · date-timeOptional
userintegerRequired
shopintegerRequired
Responses
chevron-right
200

更新成功

No content

put
/maintenance/appointments/{id}/

No content

delete

删除指定的预约

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this appointment.

Responses
delete
/maintenance/appointments/{id}/

No content

patch

部分更新指定的预约信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this appointment.

Body
idintegerRead-onlyOptional
service_typestring · min: 1 · max: 255Required
appointment_timestring · date-timeRequired
statusstring · enumOptionalDefault: pendingPossible values:
created_atstring · date-timeRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
status_changedstring · date-timeOptional
userintegerRequired
shopintegerRequired
Responses
chevron-right
200

部分更新成功

No content

patch
/maintenance/appointments/{id}/

No content

6.2 维修商家

get

获取所有服务商家

Authorizations
AuthorizationstringRequired
Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
chevron-right
200

获取成功

No content

get
/maintenance/shops/

No content

post

创建新的服务商家

Authorizations
AuthorizationstringRequired
Body
idintegerRead-onlyOptional
namestring · min: 1 · max: 255Required
locationstring · max: 255Optional
service_descriptionstringOptional
contact_infostring · min: 1 · max: 255Required
userintegerRequired
Responses
post
/maintenance/shops/

No content

get

获取指定的服务商家详情

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this service shop.

Responses
chevron-right
200

获取成功

No content

get
/maintenance/shops/{id}/

No content

put

更新指定的服务商家信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this service shop.

Body
idintegerRead-onlyOptional
namestring · min: 1 · max: 255Required
locationstring · max: 255Optional
service_descriptionstringOptional
contact_infostring · min: 1 · max: 255Required
userintegerRequired
Responses
chevron-right
200

更新成功

No content

put
/maintenance/shops/{id}/

No content

delete

删除指定的服务商家

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this service shop.

Responses
delete
/maintenance/shops/{id}/

No content

patch

部分更新指定的服务商家信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this service shop.

Body
idintegerRead-onlyOptional
namestring · min: 1 · max: 255Required
locationstring · max: 255Optional
service_descriptionstringOptional
contact_infostring · min: 1 · max: 255Required
userintegerRequired
Responses
chevron-right
200

部分更新成功

No content

patch
/maintenance/shops/{id}/

No content

6.3 维修贴士

get

获取所有服务提示

Authorizations
AuthorizationstringRequired
Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
chevron-right
200

获取成功

No content

get
/maintenance/tips/

No content

post

创建新的服务提示

Authorizations
AuthorizationstringRequired
Body
idintegerRead-onlyOptional
titlestring · min: 1 · max: 255Required
contentstring · min: 1Required
categorystring · max: 100Optional
Responses
post
/maintenance/tips/

No content

get

获取指定的服务提示详情

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this service tip.

Responses
chevron-right
200

获取成功

No content

get
/maintenance/tips/{id}/

No content

put

更新指定的服务提示信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this service tip.

Body
idintegerRead-onlyOptional
titlestring · min: 1 · max: 255Required
contentstring · min: 1Required
categorystring · max: 100Optional
Responses
chevron-right
200

更新成功

No content

put
/maintenance/tips/{id}/

No content

delete

删除指定的服务提示

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this service tip.

Responses
delete
/maintenance/tips/{id}/

No content

patch

部分更新指定的服务提示信息

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this service tip.

Body
idintegerRead-onlyOptional
titlestring · min: 1 · max: 255Required
contentstring · min: 1Required
categorystring · max: 100Optional
Responses
chevron-right
200

部分更新成功

No content

patch
/maintenance/tips/{id}/

No content

7 安全和举报模块

get

获取所有举报报告

Authorizations
AuthorizationstringRequired
Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
chevron-right
200

获取成功

No content

get
/safety/reports/

No content

post

创建或更新举报报告

Authorizations
AuthorizationstringRequired
Body
idstring · uuidRead-onlyOptional
locationstring · min: 1 · max: 255Required
descriptionstring · min: 1Required
timestampstring · date-timeOptional
statusstring · enumOptionalDefault: pendingPossible values:
imagestring · uriRead-onlyOptional
userintegerRequired
Responses
chevron-right
200

报告更新成功

No content

post
/safety/reports/

No content

get

获取指定举报报告的详细信息

Authorizations
AuthorizationstringRequired
Path parameters
idstring · uuidRequired

A UUID string identifying this 举报.

Responses
chevron-right
200

获取成功

No content

get
/safety/reports/{id}/

No content

put

更新指定举报报告的信息

Authorizations
AuthorizationstringRequired
Path parameters
idstring · uuidRequired

A UUID string identifying this 举报.

Body
idstring · uuidRead-onlyOptional
locationstring · min: 1 · max: 255Required
descriptionstring · min: 1Required
timestampstring · date-timeOptional
statusstring · enumOptionalDefault: pendingPossible values:
imagestring · uriRead-onlyOptional
userintegerRequired
Responses
chevron-right
200

更新成功

No content

put
/safety/reports/{id}/

No content

patch

部分更新指定举报报告的信息

Authorizations
AuthorizationstringRequired
Path parameters
idstring · uuidRequired

A UUID string identifying this 举报.

Body
idstring · uuidRead-onlyOptional
locationstring · min: 1 · max: 255Required
descriptionstring · min: 1Required
timestampstring · date-timeOptional
statusstring · enumOptionalDefault: pendingPossible values:
imagestring · uriRead-onlyOptional
userintegerRequired
Responses
chevron-right
200

部分更新成功

No content

patch
/safety/reports/{id}/

No content

Last updated