forked from backstage/backstage
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request backstage#1338 from spotify/freben/schema-prettier
chore(docs): just ran prettier on the entity schema
- Loading branch information
Showing
1 changed file
with
93 additions
and
105 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,115 +1,103 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-07/schema", | ||
| "$id": "backstage.io/v1beta1", | ||
| "type": "object", | ||
| "title": "A JSON Schema for Backstage catalog entities.", | ||
| "description": "Each descriptor file has a number of entities. This schema matches each of those.", | ||
| "examples": [ | ||
| { | ||
| "apiVersion": "backstage.io/v1beta1", | ||
| "kind": "Component", | ||
| "spec": { | ||
| "type": "service" | ||
| }, | ||
| "metadata": { | ||
| "name": "LoremService", | ||
| "description": "Creates Lorems like a pro.", | ||
| "labels": { | ||
| "product_name": "Random value Generator" | ||
| }, | ||
| "annnotations": { | ||
| "docs": "https://github.com/..../tree/develop/doc" | ||
| }, | ||
| "teams": [{ | ||
| "name": "Team super great", | ||
| "email": "[email protected]" | ||
| }] | ||
| } | ||
| "$schema": "http://json-schema.org/draft-07/schema", | ||
| "$id": "backstage.io/v1beta1", | ||
| "type": "object", | ||
| "title": "A JSON Schema for Backstage catalog entities.", | ||
| "description": "Each descriptor file has a number of entities. This schema matches each of those.", | ||
| "examples": [ | ||
| { | ||
| "apiVersion": "backstage.io/v1beta1", | ||
| "kind": "Component", | ||
| "spec": { | ||
| "type": "service" | ||
| }, | ||
| "metadata": { | ||
| "name": "LoremService", | ||
| "description": "Creates Lorems like a pro.", | ||
| "labels": { | ||
| "product_name": "Random value Generator" | ||
| }, | ||
| "annnotations": { | ||
| "docs": "https://github.com/..../tree/develop/doc" | ||
| }, | ||
| "teams": [ | ||
| { | ||
| "name": "Team super great", | ||
| "email": "[email protected]" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ], | ||
| "required": ["apiVersion", "kind", "metadata"], | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "apiVersion": { | ||
| "type": "string", | ||
| "description": "Version of the specification format for a particular file is written against.", | ||
| "enum": ["backstage.io/v1beta1"] | ||
| }, | ||
| "kind": { | ||
| "type": "string", | ||
| "description": "High level entity type being described, from the Backstage system model.", | ||
| "enum": ["Component"] | ||
| }, | ||
| "spec": { | ||
| "type": "object", | ||
| "description": "Actual specification data that describes the entity. TODO: shape depend on `kind`", | ||
| "required": ["type"], | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "type": { | ||
| "type": "string", | ||
| "description": "The type of component.", | ||
| "default": "", | ||
| "examples": ["service"] | ||
| } | ||
| ], | ||
| "required": [ | ||
| "apiVersion", | ||
| "kind", | ||
| "metadata" | ||
| ], | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "apiVersion": { | ||
| "type": "string", | ||
| "description": "Version of the specification format for a particular file is written against.", | ||
| "enum": [ | ||
| "backstage.io/v1beta1" | ||
| ] | ||
| } | ||
| }, | ||
| "metadata": { | ||
| "type": "object", | ||
| "description": "Metadata about the entity, i.e. things that aren't directly part of the entity specification itself.", | ||
| "required": ["name"], | ||
| "additionalProperties": true, | ||
| "properties": { | ||
| "name": { | ||
| "type": "string", | ||
| "pattern": "^[a-z0-9A-Z_.-]{1,63}$", | ||
| "description": "The name of the entity. This name is both meant for human eyes to recognize the entity, and for machines and other components to reference the entity" | ||
| }, | ||
| "description": { | ||
| "type": "string", | ||
| "description": "A human readable description of the entity, to be shown in Backstage. Should be kept short and informative." | ||
| }, | ||
| "kind": { | ||
| "type": "string", | ||
| "description": "High level entity type being described, from the Backstage system model.", | ||
| "enum": [ | ||
| "Component" | ||
| ] | ||
| "namespace": { | ||
| "type": "string", | ||
| "description": "The name of a namespace that the entity belongs to." | ||
| }, | ||
| "spec": { | ||
| "type": "object", | ||
| "description": "Actual specification data that describes the entity. TODO: shape depend on `kind`", | ||
| "required": [ | ||
| "type" | ||
| ], | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "type": { | ||
| "type": "string", | ||
| "description": "The type of component.", | ||
| "default": "", | ||
| "examples": [ | ||
| "service" | ||
| ] | ||
| } | ||
| "labels": { | ||
| "type": "object", | ||
| "description": "Labels are optional key/value pairs of that are attached to the entity, and their use is identical to kubernetes object labels.", | ||
| "additionalProperties": true, | ||
| "patternProperties": { | ||
| "^([a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]\\.[a-zA-Z]{2,}/)?[a-z0-9A-Z_\\-\\.]{1,63}$": { | ||
| "type": "string", | ||
| "pattern": "^[a-z0-9A-Z_.-]{1,63}$" | ||
| } | ||
| } | ||
| }, | ||
| "metadata": { | ||
| "type": "object", | ||
| "description": "Metadata about the entity, i.e. things that aren't directly part of the entity specification itself.", | ||
| "required": [ | ||
| "name" | ||
| ], | ||
| "additionalProperties": true, | ||
| "properties": { | ||
| "name": { | ||
| "type": "string", | ||
| "pattern": "^[a-z0-9A-Z_.-]{1,63}$", | ||
| "description": "The name of the entity. This name is both meant for human eyes to recognize the entity, and for machines and other components to reference the entity" | ||
| }, | ||
| "description": { | ||
| "type": "string", | ||
| "description": "A human readable description of the entity, to be shown in Backstage. Should be kept short and informative." | ||
| }, | ||
| "namespace": { | ||
| "type": "string", | ||
| "description": "The name of a namespace that the entity belongs to." | ||
| }, | ||
| "labels": { | ||
| "type": "object", | ||
| "description": "Labels are optional key/value pairs of that are attached to the entity, and their use is identical to kubernetes object labels.", | ||
| "additionalProperties": true, | ||
| "patternProperties": { | ||
| "^([a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]\\.[a-zA-Z]{2,}\/)?[a-z0-9A-Z_\\-\\.]{1,63}$": { | ||
| "type": "string", | ||
| "pattern": "^[a-z0-9A-Z_.-]{1,63}$" | ||
| } | ||
| } | ||
| }, | ||
| "annnotations": { | ||
| "type": "object", | ||
| "description": "Arbitrary non-identifying metadata attached to the entity, identical in use to kubernetes object annotations.", | ||
| "additionalProperties": true, | ||
| "patternProperties": { | ||
| "^([a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]\\.[a-zA-Z]{2,}\/)?[a-z0-9A-Z_\\-\\.]{1,63}$": { | ||
| "type": "string", | ||
| "pattern": "^[a-z0-9A-Z_.-]{1,63}$" | ||
| } | ||
| } | ||
| } | ||
| "annnotations": { | ||
| "type": "object", | ||
| "description": "Arbitrary non-identifying metadata attached to the entity, identical in use to kubernetes object annotations.", | ||
| "additionalProperties": true, | ||
| "patternProperties": { | ||
| "^([a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]\\.[a-zA-Z]{2,}/)?[a-z0-9A-Z_\\-\\.]{1,63}$": { | ||
| "type": "string", | ||
| "pattern": "^[a-z0-9A-Z_.-]{1,63}$" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |