SchemaStore / SchemaStore/schemastore

Backstage `template.yaml` schema

Open
#4,417 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

fileMatch Conflict
Dominant language
JavaScript
Stars
3.8k
Forks
2.3k
Avg merge
19h 59m
Merged PRs (30d)
127

Description

Description of the JSON schema.

Backstage's template.yaml is not included and seems to match too braodly to one of AWS's components. For example, I get the following errors in Megalinter:

Processing ./templates/template.yaml
Found schema in https://www.schemastore.org/api/json/catalog.json ...
Validating ./templates/template.yaml against schema from https://raw.githubusercontent.com/aws/serverless-application-model/main/samtranslator/schema/schema.json ...
./templates/template.yaml is invalid

./templates/template.yaml# must have required property 'Resources'
./templates/template.yaml# must NOT have additional properties
./templates/template.yaml# must NOT have additional properties
./templates/template.yaml# must NOT have additional properties
./templates/template.yaml# must NOT have additional properties

And the matching schema:

https://github.com/SchemaStore/schemastore/blob/9b03146f316ebb69d72f11ca5689f1910ef780c5/src/api/json/catalog.json#L1509-L1512

Supporting information.

Backstage's template.yaml is defined here: https://backstage.io/docs/features/software-catalog/descriptor-format/#kind-template

Are you making a PR for this?

No, someone else must create the PR.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Backstage template descriptor format linked in the issue, then inspect the matching entry around line 1509 in src/api/json/catalog.json. Compare the current AWS SAM match with the Backstage template.yaml structure and determine how the catalog should identify it. Done means Backstage template.yaml files validate against the intended schema rather than the AWS schema.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.