Liberapay Badge shows "invalid response data"

[fschrempf]

Are you experiencing an issue with...

• shields.io
• My own instance
• badge-maker NPM package

🪲 Description

My Liberapay badges don't work and just show "invalid response data", though the data is accessible at https://liberapay.com/frsc/public.json. Badges of other users seem to work fine.

🔗 Link to the badge

https://img.shields.io/liberapay/gives/frsc.svg?logo=liberapay

[calebcartwright]

Thanks for reaching out. Our schema validation (used to process the response) is expecting the goal key to always exist, even if it has a null value. For some reason, the response for your entity does not have the goal key at all, which is causing the response validation to fail.

If the absence of the goal key is an expected/valid scenario, then we'd need to update our schema accordingly

shields/services/liberapay/liberapay-base.js

Lines 9 to 31 in 2359eb2

	const schema = Joi.object({
	npatrons: nonNegativeInteger,
	giving: Joi.object()
	.keys({
	amount: Joi.string().required(),
	currency: Joi.string().required(),
	})
	.allow(null)
	.required(),
	receiving: Joi.object()
	.keys({
	amount: Joi.string().required(),
	currency: Joi.string().required(),
	})
	.allow(null)
	.required(),
	goal: Joi.object()
	.keys({
	amount: Joi.string().required(),
	})
	.allow(null)
	.required(),
	}).required()

[chris48s]

Looking at the liberapay source/tests, it is expected that in some situations public.json will not include a "goal" key e.g:
https://github.com/liberapay/liberapay.com/blob/ca814ed2478108b119fef4498a8ee521a5553914/tests/py/test_public_json.py#L38-L41

We should split the schema for liberapay so that only the goal badge fails if there's no goal key - badges that don't need it shouldn't fail if it is not there.

[Changaco]

I suggest simply removing the .required() call in the schema. The goal badge should then error with the message "no public goals" when the goal is missing.

[fschrempf]

Thanks for fixing, works as expected!