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.

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

Are the required field names for audit log entries complete? #5

Open
A5rocks opened this issue Aug 3, 2023 · 3 comments
Open

Are the required field names for audit log entries complete? #5

A5rocks opened this issue Aug 3, 2023 · 3 comments

Comments

@A5rocks
Copy link

A5rocks commented Aug 3, 2023

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

"required": [
"id",
"action_type"
]

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").

@shaydewael
Copy link
Contributor

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

@mbialecka
Copy link
Contributor

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.

@A5rocks
Copy link
Author

A5rocks commented Aug 3, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants