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

Are the required field names for audit log entries complete?

Open A5rocks opened this issue 1 year ago • 3 comments

According to the specification, the following fields are required on an audit log entry:

https://github.com/discord/discord-api-spec/blob/871c89864629d306ab97158263a99390ec2fa5db/specs/openapi.json#L12219-L12222

However, the documentation states that the following are required:

  • target_id
  • user_id
  • id
  • action_type

I'd also like a statement on which to trust more, because I ran into a few of these and am not entirely sure how to phrase these issue reports ("the spec is wrong" or "the docs are maybe wrong").

A5rocks avatar Aug 03 '23 05:08 A5rocks

@A5rocks While the spec is in public preview, you should follow the documentation over the spec

shaydewael avatar Aug 03 '23 17:08 shaydewael

I think we need to add a readme section about conventions we used for the spec :) Currently all nullable properties are also marked as optional. We are considering being more precise and differentiating between optional and nullable properties, but such task is not currently prioritized. We're curious what the community thinks.

mbialecka avatar Aug 03 '23 17:08 mbialecka

I would love a readme section about conventions, please!

I would very much appreciate being more precise. For instance (I'm going to raise a seperate issue about this), /users/@me/guilds's before parameter is nullable, and I'm pretty sure that's also due to this confusing of nullable and optional.

Though now that I think of it, I can imagine why this might be a challenge for Discord (using =None to mark things as optional, maybe?). I imagine it's worth it, however.

A5rocks avatar Aug 03 '23 22:08 A5rocks