Locations fail without `spec` attribute which is inconsistent with docs

[roadiehq]

Locations fail without `spec` attribute which is inconsistent with docs

[roadie-bot]

https://app.shortcut.com/larder/story/5931

[kissmikijr]

Hi @Counterfly I dug into it and it seems there is potentially a bug in the official backstage validators. We use their JSON schemas to validate the catalog-info.yaml files and here you can see that for Location entities it is required to have a spec key defined. However, it is true that all the properties of a spec object are optional.

I opened an issue to Backstage so we can either update the docs if the spec key is required or update the json schema to reflect the current behaviour. I'll get back to you when we got a conclusion which will it be.

In the meantime if you just provide a
spec: {} it should also pass the validation. Like so:

apiVersion: backstage.io/v1alpha1
kind: Location
metadata:
  name: todo-example-project
spec: {}

[kissmikijr]

@Counterfly it got merged and the docs is updated. We went with this since as you can see in the issue backstage/backstage#8906 that the spec field is required and actually doesn't make sense to use a Location if you are not using the spec.
I'll close this issue.