PhilanthropyDataCommons / service

A project for collecting and serving public information associated with grant applications
GNU Affero General Public License v3.0
8 stars 2 forks source link

Review required fields in our swagger specification #987

Closed slifty closed 4 months ago

slifty commented 4 months ago

Our swagger specification for the BulkUpload entity has an incomplete list of required fields -- specifically, it only says "required": ["fileName", "sourceKey"] but there are a bunch of other fields that are not nullable.

This is a mistake in the specification, and also happens to result in an incorrect SDK.

In the long term this actually represents a potential issue with the way we're defining our specification since we have no tests to prevent this kind of mistake. In the short term we just need to fix the spec.