Incorrect documentation of Scheduled Event's entity_metadata for STAGE_INSTANCE entity

[Jackenmen]

Description

The Field Requirements By Entity Type table incorrectly states that entity_metadata is null for entity of type STAGE_INSTANCE.

Steps to Reproduce

1. Create an event taking place in a stage channel.
2. Call GET /guilds/{guild.id}/scheduled-events endpoint
3. Look at the response body and notice that entity_metadata is not null

Expected Behavior

entity_metadata should be null or the documentation should state that it is an object.
It should also contain information about the fields that can be in that object as the "Guild Scheduled Event Entity Metadata" documentation does not contain speaker_ids which is a part of entity_metadata for Stage Channels.

Current Behavior

entity_metadata is not null despite what documentation states.

[
    {
        "id": "916428807244771378",
        "guild_id": "504291561824059392",
        "channel_id": "827722343575977985",
        "creator_id": "176070082584248320",
        "name": "ggds",
        "description": "gdsgds",
        "image": null,
        "scheduled_start_time": "2021-12-03T22:00:00.993000+00:00",
        "scheduled_end_time": null,
        "privacy_level": 2,
        "status": 1,
        "entity_type": 1,
        "entity_id": null,
        "entity_metadata": {
            "speaker_ids": []
        },
        "sku_ids": [],
        "creator": {
            "id": "176070082584248320",
            "username": "Jackenmen",
            "avatar": "4dd5ea8d5b3a686f8f98263958985f32",
            "discriminator": "6607",
            "public_flags": 256
        }
    }
]

Screenshots/Videos

None

Client and System Information

Windows 10, Discord Stable client
API requests made through Postman.

[hemu]

there are currently no plans on publicly supporting this field for events with type STAGE_INSTANCE. this is more of a free form metadata property with no guarantees for this field to be non-null in the future for STAGE_INSTANCE events. Does that help explain the discrepancy or do you still have concerns?

[Jackenmen]

It does explain the discrepancy but I do feel it would make sense for the documentation to indicate that this field might be an object for events of type STAGE_INSTANCE (especially that it says "This field is required to be null"). It certainly makes sense not to document the speaker_ids field inside it though since as you said, it's not publically supported.

[hemu]

It does explain the discrepancy but I do feel it would make sense for the documentation to indicate that this field might be an object for events of type STAGE_INSTANCE (especially that it says "This field is required to be null"). It certainly makes sense not to document the speaker_ids field inside it though since as you said, it's not publically supported.

This was to avoid confusion because e.g. sending a non-null metadata field value for a voice channel event when updating the event will return an error, and doing so for stage events in the future could return an error as well even if it currently might not.

[hemu]

let me know if that makes sense and you're cool with this issue being closed :)

[Jackenmen]

Sure