[RFC] Modify "Archive users not In discord" API endpoint name about website-api-contracts HOT 6 OPEN

@RitikJaiswal75 @apurvkhare @prakashchoudhary07 @sahsisunny @DashDeipayan @heyrandhir Please share your thoughts on this.

from website-api-contracts.

APIs Should represent the resource they are accessing I think it should just be
POST as PATCH here is used for a singular update, but the functionality of the API is to update multiple users

I would prefer the API name to be POST on `/users'
any action that it performs can go into the request body
something like

{
    action: "archive"
    on: "in_discord"
}

from website-api-contracts.

APIs Should represent the resource they are accessing I think it should just be POST as PATCH here is used for a singular update, but the functionality of the API is to update multiple users

I would prefer the API name to be POST on `/users' any action that it performs can go into the request body something like

{
    action: "archive"
    on: "in_discord"
}

There exists another API on the same endpoint /users. This API marks users unverified. If we go with this approach again we have to update the previously implemented API definition as well.

@prakashchoudhary07 @heyrandhir @apurvkhare What's you thoughts on this?

from website-api-contracts.

APIs Should represent the resource they are accessing I think it should just be POST as PATCH here is used for a singular update, but the functionality of the API is to update multiple users

I would prefer the API name to be POST on `/users' any action that it performs can go into the request body something like

{
    action: "archive"
    on: "in_discord"
}

Also, I don't understand why we used POST here. POST is supposed to be used when we are creating new resources. But, here we are just updating the existing archived property on the user's resources. Can you please explain?

from website-api-contracts.

There exists another API on the same endpoint /users. This API marks users unverified. If we go with this approach again we have to update the previously implemented API definition as well.

I think we would need to update the previous api then. Based on request body it should perform the unverified action. while as @RitikJaiswal75 suggested based on specific key such as

{
    action: "archive"
    on: "in_discord"
}

you can perform your action and similarly assign some other key for unverified action.

from website-api-contracts.

Based on this Discussion:

1. For archive users not in discord API

  POST /users

  Request Body

  {
    "action": "archive",
    "on": "in_discord"
  }

2. For marking users unverified in discord API

  POST /users

  Request Body

  {
    "action": "unverified",
    "on": "discord_unlinked"
  }

from website-api-contracts.