discord-api-docs icon indicating copy to clipboard operation
discord-api-docs copied to clipboard

Guild Templates documentation is unclear

Open Nihlus opened this issue 1 year ago • 0 comments

Description

The current documentation regarding guild templates is highly unclear on what is and isn't allowed or expected data when working with the endpoints.

Primarily, serialized_source_guild is simply specified as a partial guild without any mention of additional fields, placeholder IDs instead of snowflakes, or any further considerations required for types referenced by this field (permission overwrites comes to mind).

The documentation needs to be expanded and clarified for this API to be usable.

Steps to Reproduce

  1. Read the docs
  2. Read the example payload
  3. Use the API
  4. Receive errors or unexpected behaviour
  5. Be confused

Expected Behavior

Clear, obvious documentation regarding the types and fields expected by the API.

Current Behavior

Unclear, confusing and plain wrong documentation regarding the types and fields expected by the API.

Screenshots/Videos

No response

Client and System Information

Nihlus avatar Dec 25 '22 14:12 Nihlus