Comments (3)
https://app.shortcut.com/larder/story/5931
from backstage-entity-validator.
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: {}
from backstage-entity-validator.
@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.
from backstage-entity-validator.
Related Issues (20)
- Possible unnecessary entry in schema HOT 6
- Follow links in Location files HOT 2
- The schema should be extendable HOT 2
- Auto-discover metadata files HOT 6
- Referential integrity should be checked HOT 2
- No such file or directory error during CI build HOT 6
- [Question] Entity validator source HOT 3
- Support `$yaml` and `$json` fields in API Kind definitions HOT 5
- Circle CI Orb build not executing integration tests HOT 2
- Orb usage examples are wrong - recommend adding a job to the orb to make them right HOT 2
- Update action to use Node 16 HOT 3
- Validation fails when using `backstage.io/techdocs-ref: dir:.` annotation HOT 4
- Handle nunjucks syntax for template files HOT 1
- Is this maintained? HOT 5
- Support Gitlab Pipelines HOT 3
- techdocs default mkdoc.yaml
- Allow to pass custom spec -> definition for API entity HOT 1
- DependsOn resource syntax error not detected
- Update action to use Node 20
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from backstage-entity-validator.