See https://github.com/fluxerapp/fluxer/pull/1519 for exact change suggested.Removed: -### ChecksRemoved: -Removed: -- ☑ I searched existing issues.Removed: -- ☑ I wrote this report in my own words, except for direct translation if needed.Removed: -
Show
Description required but nullable in OpenAPI spec
What needs fixing?
Unsure if this counts as "documentation", please relabel if not, but the OpenAPI spec seems to specify a nullable description field as being "required". This type is used in numerous places so I have not done an exhaustive check but where it's used in some basic places (namely POST /channels/{channel_id}/messages and POST /webhooks/{webhook_id}/{token}) seem to work fine with the description value being undefined.
If the description type is required (as nullable) for some endpoints, I suggest changing the code to remove the requiredness and default to null, but since I assume that it is not the case, I suggest simply removing the required restriction in the OpenAPI spec.
See https://github.com/fluxerapp/fluxer/pull/1519 for exact change suggested.
Original by Rex
Show
Description required but nullable in OpenAPI spec
What needs fixing?
Unsure if this counts as "documentation", please relabel if not, but the OpenAPI spec seems to specify a nullable description field as being "required". This type is used in numerous places so I have not done an exhaustive check but where it's used in some basic places (namely POST /channels/{channel_id}/messages and POST /webhooks/{webhook_id}/{token}) seem to work fine with the description value being undefined.
If the description type is required (as nullable) for some endpoints, I suggest changing the code to remove the requiredness and default to null, but since I assume that it is not the case, I suggest simply removing the required restriction in the OpenAPI spec.
See https://github.com/fluxerapp/fluxer/pull/1519 for exact change suggested.
Checks
☑ I searched existing issues.
☑ I wrote this report in my own words, except for direct translation if needed.