Description required but nullable in OpenAPI spec

(#756) Bug Fixed api

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.

Location

https://github.com/fluxerapp/fluxer/blob/fe3f1b25b6fa7fb97830a217fb611a7e147c8d7b/fluxer_api/src/api/openapi/openapi.json#L28600

Suggested change

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.

1 comment

Sign in with Fluxer to comment and vote.
Comment by @Jiralite
RexSystem 1 vote originally by @Jiralite on GitHub
For future reference, changes to the specification will require a code change. For this reason, it would be more appropriate for this to be a regular bug rather than documentation.