From 04a2ac22f87a4d1a0618d8a39eee4776b6072fbc Mon Sep 17 00:00:00 2001 From: earlinn Date: Thu, 1 Feb 2024 15:53:05 +0600 Subject: [PATCH] Add some query examples to README --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 94ddc09..69aa81e 100644 --- a/README.md +++ b/README.md @@ -239,7 +239,7 @@ POST-запрос без передачи каких-либо полей на э Если пользователь является админом, он может получить информацию обо всех зарегистрированных пользователях сайта, направив GET-запрос без передачи каких-либо полей на эндпойнт /api/users/ Также админ может просматривать данные конкретного зарегистрированного пользователя, -направив GET-запрос на эндпойнт /api/users/{id}/ +направив GET-запрос на эндпойнт /api/users/{id}/, например, /api/users/7/. #### Редактирование своих личных данных @@ -433,7 +433,8 @@ PUT-запросом можно редактировать те же самые ``` Если пользователь является админом, он может отредактировать личные данные других -зарегистрированных пользователей сайта, направив PATCH- или PUT-запрос на эндпойнт /api/users/{id}/ +зарегистрированных пользователей сайта, направив PATCH- или PUT-запрос +на эндпойнт /api/users/{id}/, например, /api/users/7/. #### Удаление пользователем своего аккаунта @@ -465,14 +466,14 @@ PUT-запросом можно редактировать те же самые ``` Если пользователь является админом, он может удалить аккаунт другого зарегистрированного -пользователя, направив DELETE-запрос на эндпойнт /api/users/{id}/ +пользователя, направив DELETE-запрос на эндпойнт /api/users/{id}/, например, /api/users/7/. ### Эндпойнты для просмотра пользовательских адресов доставки Данные эндпойнты доступны только админам и принимают только GET-запросы. Для просмотра всех адресов конкретного зарегистрированного пользователя админу -нужно направить запрос на эндпойнт /api/users/{id}/addresses/, например, /api/users/2/addresses/ +нужно направить запрос на эндпойнт /api/users/{id}/addresses/, например, /api/users/2/addresses/. Пример ответа на GET-запрос на получение одного из адресов конкретного зарегистрированного пользователя: ``` @@ -502,7 +503,7 @@ PUT-запросом можно редактировать те же самые Для просмотра одного из адресов конкретного зарегистрированного пользователя админу нужно направить запрос на эндпойнт /api/users/{user_id}/addresses/{id}/, -например, /api/users/2/addresses/1/ +например, /api/users/2/addresses/1/. Пример ответа на GET-запрос на получение всех адресов конкретного зарегистрированного пользователя: ``` @@ -814,7 +815,7 @@ _**Продукт**_ ### Редактирование продуктов, категорий, подкатегорий, тегов, компонентов, производителей и промоакций -Доступно админам с помощью PATCH-запросов на эндпойнт /api/products/{id}/. +Доступно админам с помощью PATCH-запросов на эндпойнт /api/products/{id}/, например, /api/products/4/. При редактировании продукта можно применить к нему промоакции (при создании этого нельзя было сделать). Для этого нужно передать в запросе поле promotions со списком id промоакций. В настоящее время действует ограничение: у продукта не может быть более 1 промоакции.