Graylog2 / Graylog2/graylog2-server

Mandatory API parameters shouldn't be called 'optional'

Open
#10,367 2 comments 0 reactions 0 assignees View on GitHub
bug triaged
Dominant language
Java
Stars
8.1k
Forks
1.1k
Avg merge
1d 20h
Merged PRs (30d)
217

Description

I've notice that some API endpoints list up properties as optional while there are not.

For example `POST /sidecar/configurations` lists everything as optional which doesn't make sense at all, while color is a mandatory property and the API rejects a `null` value. I don't think color should be a mandatory thing anyway, since it could do a fallback to the standard color in the graylog ui. This overall should be better documented in the swagger UI.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.