API to update and remove custom emoji

[i-ky]

Right now there is only API to upload custom emoji. This makes it impossible to programmatically manage custom emojis, which may be desirable if organization has hundreds of custom emojis that need to be updated from time to time.

For comparison, linkifier can be added, updated and removed via API.

[AbdulBasit2733]

@i-ky Hello sir i want to solve this issue will you please assign it to me.

[i-ky]

will you please assign it to me

@AbdulBasit2733, I believe you need to ask zulipbot.
Thank you for your interest in solving this issue!

[deep-poharkar]

@zulipbot claim

[zulipbot]

Hello @deep-poharkar!

Thanks for your interest in Zulip! You have attempted to claim an issue without the label "help wanted". You can only claim and submit pull requests for issues with the help wanted label.

If this is your first time here, we recommend reading our guide for new contributors before getting started.

[deep-poharkar]

@i-ky please update the label with help-wanted, i would love to resolve this issue.

[i-ky]

@zulipbot add "area: api" "area: emoji" "help wanted"

[zulipbot]

Hello @zulip/server-api, @zulip/server-emoji members, this issue was labeled with the "area: emoji", "area: api" labels, so you may want to check it out!

[deep-poharkar]

@zulipbot claim

[zulipbot]

Hello @deep-poharkar, it looks like you've currently claimed 1 issue in this repository. We encourage new contributors to focus their efforts on at most 1 issue at a time, so please complete your work on your other claimed issues before trying to claim this issue again.

We look forward to your valuable contributions!

[Lalit3716]

Hi @i-ky, it seems like we have an endpoint available to delete an emoji but it is "intentionally undocumented" for some reason here:
https://github.com/zulip/zulip/blob/main/zproject/urls.py#L261

[i-ky]

@Lalit3716, that's interesting. I've done some blaming and "intentionally undocumented" seems to first appear in 74a72fc. The reasoning is not very clear to me, but there is a comment:

zulip/zproject/urls.py

Line 102 in a3c475f

# this endpoint throws a status code 400 JsonableError when it should be a 404.

[Lalit3716]

Yeah, it's also unclear to me why this is undocumented! I guess I can make an update endpoint till we get clarity on this!

[AdityaSingh-02]

@zulipbot claim

[timabbott]

I don't think we have a use case for an update endpoint at present -- in any case, such a proposal should be discussed in "api design" before something in implemented.

The existing delete_emoji endpoint being undocumented appears to be a mistake; we'd take a PR adding OpenAPI docs for it following our documentation. (And I'd want to investigate the 400/404 issue and correct that as part of the documentation, including an API changelog entry for that change).

https://zulip.readthedocs.io/en/latest/documentation/api.html documents this process in detail.

[Lalit3716]

@timabbott
Okay cool let's add delete_emoji endpoint to docs then!
For update_emoji I can see it's use-case what if a user made a typo in emoji name while creating it. We can have an update endpoint to correct it instead of making two calls for delete_emoji and create_emoji ?

[zulipbot]

@AdityaSingh-02 You have been unassigned from this issue because you have not made any updates for over 14 days. Please feel free to reclaim the issue if you decide to pick up again. Thanks!

[tanmaymunjal]

@zulipbot claim

[zulipbot]

Welcome to Zulip, @tanmaymunjal! We just sent you an invite to collaborate on this repository at https://github.com/zulip/zulip/invitations. Please accept this invite in order to claim this issue and begin a fun, rewarding experience contributing to Zulip!

Here's some tips to get you off to a good start:

• Join me on the Zulip developers' server, to get help, chat about this issue, and meet the other developers.
• Unwatch this repository, so that you don't get 100 emails a day.

As you work on this issue, you'll also want to refer to the Zulip code contribution guide, as well as the rest of the developer documentation on that site.

See you on the other side (that is, the pull request side)!

[tanmaymunjal]

@zulipbot abandon