Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document Guild Scheduled Event structure and HTTP methods #3586

Merged
merged 44 commits into from
Nov 15, 2021
Merged

Document Guild Scheduled Event structure and HTTP methods #3586

merged 44 commits into from
Nov 15, 2021

Conversation

apacheli
Copy link
Contributor

@apacheli apacheli commented Aug 4, 2021 •
edited
Loading

This PR adds documentation for the upcoming guild scheduled event feature.

  • Guild Scheduled Event structure
  • Guild Scheduled Event Privacy Level enum
  • Guild Scheduled Event Status enum
  • Guild Scheduled Event Entity Metadata
  • Guild Scheduled Event Entity Types
  • Adds GET/POST /guilds/{guild.id}/scheduled-events
  • Adds GET/PATCH/DELETE /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}
  • Adds GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}/users
  • /guild-events/* and /guilds/{guild.id}/events were previously available, but they are now deprecated in favor of the new endpoints listed above.
  • Adds MANAGE_EVENTS permission
  • Adds audit log events
    • GUILD_SCHEDULED_EVENT_CREATE
    • GUILD_SCHEDULED_EVENT_UPDATE
    • GUILD_SCHEDULED_EVENT_DELETE
  • Audit log events new/old key changes
  • Gateway events
    • GUILD_SCHEDULED_EVENT_CREATE
    • GUILD_SCHEDULED_EVENT_UPDATE
    • GUILD_SCHEDULED_EVENT_DELETE
    • GUILD_SCHEDULED_EVENT_USER_ADD
    • GUILD_SCHEDULED_EVENT_USER_REMOVE
    • GUILD_SCHEDULED_EVENT_USER_CREATE and GUILD_SCHEDULED_EVENT_USER_DELETE are now deprecated.
  • API Invites query guild_scheduled_event_id
  • Cover images will not be documented at this time!

@apacheli apacheli marked this pull request as draft August 4, 2021 19:53
@Jupith
Copy link
Contributor

Jupith commented Aug 6, 2021

Eventually, you will be able to set up events that arnt tied to a stage, so I don't think stage instance is the correct place for this.

@Jupith
Copy link
Contributor

Jupith commented Aug 6, 2021 •
edited
Loading

The endpoint for deleting and patching an event is /guild-events/id

Jupith
Jupith suggested changes Aug 6, 2021
View reviewed changes
docs/resources/Stage_Instance.md Outdated Show resolved Hide resolved
@Lulalaby
Copy link
Contributor

Lulalaby commented Aug 6, 2021

Eventually, you will be able to set up events that arnt tied to a stage, so I don't think stage instance is the correct place for this.

Yeah seems like this

@apacheli
Copy link
Contributor Author

apacheli commented Aug 6, 2021

Eventually, you will be able to set up events that arnt tied to a stage, so I don't think stage instance is the correct place for this.

Yeah, I noticed channel_id was not a required parameter when I tried using the POST endpoint. I suppose I could move it back to Guild.md but I think it would be too cluttered. Maybe a separate file would better(?)

@apacheli apacheli changed the title Document guild/:id/events methods Document Guild Event structure and HTTP methods Aug 6, 2021
@apacheli apacheli marked this pull request as ready for review August 9, 2021 16:41
@l7ssha l7ssha mentioned this pull request Aug 17, 2021
Closed
rikashore
rikashore suggested changes Aug 21, 2021
View reviewed changes
docs/resources/Guild_Event.md Outdated Show resolved Hide resolved
@iShibi iShibi mentioned this pull request Aug 21, 2021
Merged
18 tasks
@apacheli
Copy link
Contributor Author

Thank you everyone for the reviews. I will mark this as a draft again and will try to get to these as soon as possible.

@apacheli apacheli marked this pull request as draft August 21, 2021 23:24
i0bs
i0bs reviewed Nov 15, 2021
View reviewed changes
docs/resources/Invite.md
| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/<code>` endpoint when `with_counts` is `true` |
| expires_at? | ?ISO8601 timestamp | the expiration date of this invite, returned from the `GET /invites/<code>` endpoint when `with_expiration` is `true` |
| stage_instance? | [invite stage instance](#DOCS_RESOURCES_INVITE/invite-stage-instance-object) object | stage instance data if there is a [public Stage instance](#DOCS_RESOURCES_STAGE_INSTANCE) in the Stage channel this invite is for |
| guild_scheduled_event? | [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event id |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| guild_scheduled_event? | [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event id |
| guild_scheduled_event? | [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event ID |

i0bs
i0bs suggested changes Nov 15, 2021
View reviewed changes
Copy link
Contributor

@i0bs i0bs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More consistency requests similar to @Vitorlops

@hemu
Copy link
Contributor

hemu commented Nov 15, 2021

I did a pr a while ago to this pr. Isn't merged, should I close it? apacheli#1

Wanted to double check what the final decision on images was today before responding on this thread re. images. We currently won't be supporting images for this initial launch. I'm going to remove all mentions of images from the docs so that they can be re-added later if support for images is added.

Thanks for submitting this change, I think we can hold off on this until we add image support later.

@Lulalaby
Copy link
Contributor

I'm gonna close it for now then.

@hemu hemu marked this pull request as ready for review November 15, 2021 19:04
hemu
hemu approved these changes Nov 15, 2021
View reviewed changes
Copy link
Contributor

@hemu hemu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really awesome work, thank you to @apacheli and everyone else that contributed to this PR!

@Lulalaby
Copy link
Contributor

@hemu docs contributor badge when xD joking

Yeah, that was good work.
Thanks hemu to work with us together on that.
That was amazing <3

@hemu
Copy link
Contributor

hemu commented Nov 15, 2021

@hemu docs contributor badge when xD joking

Yeah, that was good work. Thanks hemu to work with us together on that. That was amazing <3

thank you for being so involved and helping document this :)

@Lulalaby
Copy link
Contributor

Anytime!

@hemu hemu merged commit 1298152 into discord:master Nov 15, 2021
@Lulalaby
Copy link
Contributor

Lulalaby commented Nov 15, 2021 •
edited
Loading

@hemu bots are still not able to use the events api right?
Because I'm done with the implementation but can't test it xD

@royporter7
Copy link

@Lulalaby I also still cannot use a bot to interact with these endpoints. Previously I was getting an error message saying something like 'Not supported', because at that time bots were blocked. However @hemu announced that was lifted a little bit ago, only now the error has slightly changed to 'Missing access'.

Any advice?

@Lulalaby
Copy link
Contributor

No it's still blocked.
They have to fix a few things and going to release it today or latest tomorrow.

@royporter7
Copy link

@Lulalaby Thank you for the update 👍

@Jupith
Copy link
Contributor

Jupith commented Nov 16, 2021

You can use the api with bots just now if you send the x-super-properties header

@jhgg
Copy link
Contributor

jhgg commented Nov 16, 2021

You can use the api with bots just now if you send the x-super-properties header

I don't think this is true...

@jhgg
Copy link
Contributor

jhgg commented Nov 16, 2021

You can use the api with bots just now if you send the x-super-properties header

I don't think this is true...

It is true! @hemu - there looks to be some experiment gating based on client version in the x-super-properties header that is causing these woes.

@Lulalaby
Copy link
Contributor

welp

@hemu
Copy link
Contributor

hemu commented Nov 16, 2021

You can use the api with bots just now if you send the x-super-properties header

I don't think this is true...

It is true! @hemu - there looks to be some experiment gating based on client version in the x-super-properties header that is causing these woes.

Yep we've been debugging this to pinpoint the best way to fix this without breaking the experiment. It's def the experiment gating.

You can use the api with bots just now if you send the x-super-properties header

GREAT CATCH. Pretty awesome that you figured this out

@hemu
Copy link
Contributor

hemu commented Nov 16, 2021

this should be fixed now. sorry about the additional headaches. still awesome that ya'll figured out the X-Super-Properties header workaround

@Lulalaby
Copy link
Contributor

Thanks @hemu, works now!

@jchristgit jchristgit mentioned this pull request Nov 16, 2021
Closed
@queer queer mentioned this pull request Nov 16, 2021
Open
@ghost

This comment has been minimized.

Sign in to view
@apacheli

This comment has been minimized.

Sign in to view
@ghost

This comment has been minimized.

Sign in to view
@discord discord locked as off-topic and limited conversation to collaborators Nov 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@xiBread xiBread xiBread left review comments

@vvito7 vvito7 vvito7 left review comments

@iShibi iShibi iShibi left review comments

@ImRodry ImRodry ImRodry left review comments

@HarmoGlace HarmoGlace HarmoGlace left review comments

@advaith1 advaith1 advaith1 requested changes

@i0bs i0bs i0bs requested changes

@AnotherZane AnotherZane AnotherZane requested changes

@rikashore rikashore rikashore requested changes

@wasdennnoch wasdennnoch wasdennnoch requested changes

@Davi-the-Mudkip Davi-the-Mudkip Davi-the-Mudkip requested changes

@Jupith Jupith Jupith requested changes

@Lulalaby Lulalaby Lulalaby approved these changes

@hemu hemu hemu approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.