+{"$id":"https://json.schemastore.org/catalog-info.json","type":"object","$schema":"http://json-schema.org/draft-07/schema","anyOf":[{"$schema":"http://json-schema.org/draft-07/schema","$id":"ApiV1alpha1","examples":[{"apiVersion":"backstage.io/v1alpha1","kind":"API","metadata":{"name":"artist-api","labels":{"product_name":"Random value Generator"},"annotations":{"docs":"https://github.com/..../tree/develop/doc"}},"spec":{"type":"openapi","lifecycle":"production","owner":"artist-relations-team","system":"artist-engagement-portal","definition":"openapi: \"3.0.0\"\ninfo:..."}}],"allOf":[{"$ref":"https://json.schemastore.org/catalog-info.json#/definitions/entity"},{"type":"object","required":["spec"],"properties":{"apiVersion":{"enum":["backstage.io/v1alpha1","backstage.io/v1beta1"]},"kind":{"const":"API"},"spec":{"type":"object","required":["type","lifecycle","owner","definition"],"properties":{"type":{"type":"string","examples":["openapi","asyncapi","graphql","grpc"],"minLength":1},"lifecycle":{"type":"string","examples":["experimental","production","deprecated"],"minLength":1},"owner":{"type":"string","examples":["artist-relations-team","user:john.johnson"],"minLength":1},"system":{"type":"string","minLength":1},"definition":{"type":"string","minLength":1}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema","$id":"ComponentV1alpha1","examples":[{"apiVersion":"backstage.io/v1alpha1","kind":"Component","metadata":{"name":"LoremService","labels":{"product_name":"Random value Generator"},"annotations":{"docs":"https://github.com/..../tree/develop/doc"}},"spec":{"type":"service","lifecycle":"production","owner":"tools"}}],"allOf":[{"$ref":"https://json.schemastore.org/catalog-info.json#/definitions/entity"},{"type":"object","required":["spec"],"properties":{"apiVersion":{"enum":["backstage.io/v1alpha1","backstage.io/v1beta1"]},"kind":{"const":"Component"},"spec":{"type":"object","required":["type","lifecycle","owner"],"properties":{"type":{"type":"string","examples":["service","website","library"],"minLength":1},"lifecycle":{"type":"string","examples":["experimental","production","deprecated"],"minLength":1},"owner":{"type":"string","examples":["artist-relations-team","user:john.johnson"],"minLength":1},"system":{"type":"string","minLength":1},"subcomponentOf":{"type":"string","minLength":1},"providesApis":{"type":"array","items":{"type":"string","minLength":1}},"consumesApis":{"type":"array","items":{"type":"string","minLength":1}},"dependsOn":{"type":"array","items":{"type":"string","minLength":1}}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema","$id":"DomainV1alpha1","examples":[{"apiVersion":"backstage.io/v1alpha1","kind":"Domain","metadata":{"name":"artists"},"spec":{"owner":"artist-relations-team"}}],"allOf":[{"$ref":"https://json.schemastore.org/catalog-info.json#/definitions/entity"},{"type":"object","required":["spec"],"properties":{"apiVersion":{"enum":["backstage.io/v1alpha1","backstage.io/v1beta1"]},"kind":{"const":"Domain"},"spec":{"type":"object","required":["owner"],"properties":{"owner":{"type":"string","examples":["artist-relations-team","user:john.johnson"],"minLength":1}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema","$id":"GroupV1alpha1","examples":[{"apiVersion":"backstage.io/v1alpha1","kind":"Group","metadata":{"name":"infrastructure"},"spec":{"type":"business-unit","profile":{"displayName":"Infrastructure","email":"infrastructure@example.com","picture":"https://example.com/groups/bu-infrastructure.jpeg"},"parent":"ops","children":["backstage","other"]}}],"allOf":[{"$ref":"https://json.schemastore.org/catalog-info.json#/definitions/entity"},{"type":"object","required":["spec"],"properties":{"apiVersion":{"enum":["backstage.io/v1alpha1","backstage.io/v1beta1"]},"kind":{"const":"Group"},"spec":{"type":"object","required":["type","children"],"properties":{"type":{"type":"string","examples":["team","business-unit","product-area","root"],"minLength":1},"profile":{"type":"object","properties":{"displayName":{"type":"string","examples":["Infrastructure"],"minLength":1},"email":{"type":"string","examples":["infrastructure@example.com"],"minLength":1},"picture":{"type":"string","examples":["https://example.com/groups/bu-infrastructure.jpeg"],"minLength":1}}},"parent":{"type":"string","examples":["ops"],"minLength":1},"children":{"type":"array","items":{"type":"string","examples":["backstage","other"],"minLength":1}},"members":{"type":"array","items":{"type":"string","examples":["jdoe"],"minLength":1}}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema","$id":"LocationV1alpha1","examples":[{"apiVersion":"backstage.io/v1alpha1","kind":"Location","metadata":{"name":"org-data"},"spec":{"type":"url","targets":["http://github.com/myorg/myproject/org-data-dump/catalog-info-staff.yaml","http://github.com/myorg/myproject/org-data-dump/catalog-info-consultants.yaml"]}}],"allOf":[{"$ref":"https://json.schemastore.org/catalog-info.json#/definitions/entity"},{"type":"object","required":["spec"],"properties":{"apiVersion":{"enum":["backstage.io/v1alpha1","backstage.io/v1beta1"]},"kind":{"const":"Location"},"spec":{"type":"object","required":[],"properties":{"type":{"type":"string","examples":["url"],"minLength":1},"target":{"type":"string","examples":["./details/catalog-info.yaml"],"minLength":1},"targets":{"type":"array","items":{"type":"string","examples":["./details/catalog-info.yaml","http://github.com/myorg/myproject/org-data-dump/catalog-info-staff.yaml"],"minLength":1}}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema","$id":"ResourceV1alpha1","examples":[{"apiVersion":"backstage.io/v1alpha1","kind":"Resource","metadata":{"name":"artists-db"},"spec":{"type":"database","owner":"artist-relations-team","system":"artist-engagement-portal"}}],"allOf":[{"$ref":"https://json.schemastore.org/catalog-info.json#/definitions/entity"},{"type":"object","required":["spec"],"properties":{"apiVersion":{"enum":["backstage.io/v1alpha1","backstage.io/v1beta1"]},"kind":{"const":"Resource"},"spec":{"type":"object","required":["type","owner"],"properties":{"type":{"type":"string","examples":["database","s3-bucket","cluster"],"minLength":1},"owner":{"type":"string","examples":["artist-relations-team","user:john.johnson"],"minLength":1},"dependsOn":{"type":"array","items":{"type":"string","minLength":1}},"system":{"type":"string","minLength":1}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema","$id":"SystemV1alpha1","examples":[{"apiVersion":"backstage.io/v1alpha1","kind":"System","metadata":{"name":"artist-engagement-portal"},"spec":{"owner":"artist-relations-team","domain":"artists"}}],"allOf":[{"$ref":"https://json.schemastore.org/catalog-info.json#/definitions/entity"},{"type":"object","required":["spec"],"properties":{"apiVersion":{"enum":["backstage.io/v1alpha1","backstage.io/v1beta1"]},"kind":{"const":"System"},"spec":{"type":"object","required":["owner"],"properties":{"owner":{"type":"string","examples":["artist-relations-team","user:john.johnson"],"minLength":1},"domain":{"type":"string","examples":["artists"],"minLength":1}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema","$id":"TemplateV1beta2","examples":[{"apiVersion":"backstage.io/v1beta2","kind":"Template","metadata":{"name":"react-ssr-template","title":"React SSR Template","tags":["recommended","react"]},"spec":{"owner":"artist-relations-team","type":"website","parameters":{"required":["name","description"],"properties":{"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"}}},"steps":[{"id":"fetch","name":"Fetch","action":"fetch:plain","parameters":{"url":"./template"}},{"id":"publish","name":"Publish to GitHub","action":"publish:github","parameters":{"repoUrl":"{{ parameters.repoUrl }}"},"if":"{{ parameters.repoUrl }}"}],"output":{"catalogInfoUrl":"{{ steps.publish.output.catalogInfoUrl }}"}}}],"allOf":[{"$ref":"https://json.schemastore.org/catalog-info.json#/definitions/entity"},{"type":"object","required":["spec"],"properties":{"apiVersion":{"const":"backstage.io/v1beta2"},"kind":{"const":"Template"},"spec":{"type":"object","required":["type","steps"],"properties":{"type":{"type":"string","examples":["service","website","library"],"minLength":1},"parameters":{"oneOf":[{"type":"object"},{"type":"array","items":{"type":"object"}}]},"steps":{"type":"array","items":{"type":"object","required":["action"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"action":{"type":"string"},"input":{"type":"object"},"if":{"type":["string","boolean"]}}}},"output":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","required":[],"properties":{"url":{"type":"string","examples":["https://github.com/my-org/my-new-repo"],"minLength":1},"entityRef":{"type":"string","examples":["Component:default/my-app"],"minLength":1},"title":{"type":"string","examples":["View new repo"],"minLength":1},"icon":{"type":"string","examples":["dashboard"],"minLength":1}}}}},"additionalProperties":{"type":"string"}},"owner":{"type":"string","minLength":1}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema","$id":"UserV1alpha1","examples":[{"apiVersion":"backstage.io/v1alpha1","kind":"User","metadata":{"name":"jdoe"},"spec":{"profile":{"displayName":"Jenny Doe","email":"jenny-doe@example.com","picture":"https://example.com/staff/jenny-with-party-hat.jpeg"},"memberOf":["team-b","employees"]}}],"allOf":[{"$ref":"https://json.schemastore.org/catalog-info.json#/definitions/entity"},{"type":"object","required":["spec"],"properties":{"apiVersion":{"enum":["backstage.io/v1alpha1","backstage.io/v1beta1"]},"kind":{"const":"User"},"spec":{"type":"object","required":["memberOf"],"properties":{"profile":{"type":"object","properties":{"displayName":{"type":"string","examples":["Jenny Doe"],"minLength":1},"email":{"type":"string","examples":["jenny-doe@example.com"],"minLength":1},"picture":{"type":"string","examples":["https://example.com/staff/jenny-with-party-hat.jpeg"],"minLength":1}}},"memberOf":{"type":"array","items":{"type":"string","examples":["team-b","employees"],"minLength":1}}}}}}]}],"definitions":{"entity":{"$schema":"http://json-schema.org/draft-07/schema","$id":"Entity","examples":[{"apiVersion":"backstage.io/v1alpha1","kind":"Component","metadata":{"name":"LoremService","labels":{"product_name":"Random value Generator"},"annotations":{"docs":"https://github.com/..../tree/develop/doc"}},"spec":{"type":"service","lifecycle":"production","owner":"tools"}}],"type":"object","required":["apiVersion","kind","metadata"],"additionalProperties":false,"properties":{"apiVersion":{"type":"string","minLength":1,"examples":["backstage.io/v1alpha1","my-company.net/v1","1.0"]},"kind":{"type":"string","minLength":1,"examples":["API","Component","Domain","Group","Location","Resource","System","Template","User"]},"metadata":{"$schema":"http://json-schema.org/draft-07/schema","$id":"EntityMeta","examples":[{"uid":"e01199ab-08cc-44c2-8e19-5c29ded82521","etag":"lsndfkjsndfkjnsdfkjnsd==","generation":13,"name":"my-component-yay","namespace":"the-namespace","labels":{"backstage.io/custom":"ValueStuff"},"annotations":{"example.com/bindings":"are-secret"},"tags":["java","data"]}],"type":"object","required":["name"],"additionalProperties":true,"properties":{"uid":{"type":"string","examples":["e01199ab-08cc-44c2-8e19-5c29ded82521"],"minLength":1},"etag":{"type":"string","examples":["lsndfkjsndfkjnsdfkjnsd=="],"minLength":1},"generation":{"type":"integer","examples":[1],"minimum":1},"name":{"type":"string","examples":["metadata-proxy"],"minLength":1},"namespace":{"type":"string","default":"default","examples":["default","admin"],"minLength":1},"title":{"type":"string","examples":["React SSR Template"],"minLength":1},"description":{"type":"string"},"labels":{"type":"object","additionalProperties":true,"patternProperties":{"^.+$":{"type":"string"}}},"annotations":{"type":"object","additionalProperties":true,"patternProperties":{"^.+$":{"type":"string"}}},"tags":{"type":"array","items":{"type":"string","minLength":1}},"links":{"type":"array","items":{"type":"object","required":["url"],"properties":{"url":{"type":"string","examples":["https://admin.example-org.com"],"minLength":1},"title":{"type":"string","examples":["Admin Dashboard"],"minLength":1},"icon":{"type":"string","examples":["dashboard"],"minLength":1}}}}}},"spec":{"type":"object"},"relations":{"type":"array","items":{"$ref":"https://json.schemastore.org/catalog-info.json#/definitions/common/definitions/relation"}},"status":{"$ref":"https://json.schemastore.org/catalog-info.json#/definitions/common/definitions/status"}}},"common":{"$schema":"http://json-schema.org/draft-07/schema","$id":"common","type":"object","definitions":{"reference":{"$id":"#reference","type":"object","required":["kind","namespace","name"],"additionalProperties":false,"properties":{"kind":{"type":"string","minLength":1},"namespace":{"type":"string","minLength":1},"name":{"type":"string","minLength":1}}},"relation":{"$id":"#relation","type":"object","required":["type","target"],"additionalProperties":false,"properties":{"type":{"type":"string","minLength":1,"pattern":"^\\w+$"},"target":{"$ref":"#reference"}}},"status":{"$id":"#status","type":"object","required":[],"additionalProperties":true,"properties":{"items":{"type":"array","items":{"$ref":"#statusItem"}}}},"statusItem":{"$id":"#statusItem","type":"object","required":["type","level","message"],"additionalProperties":true,"properties":{"type":{"type":"string","minLength":1},"level":{"$ref":"#statusLevel"},"message":{"type":"string"},"error":{"$ref":"#error"}}},"statusLevel":{"$id":"#statusLevel","type":"string","enum":["info","warning","error"]},"error":{"$id":"#error","type":"object","required":["name","message"],"additionalProperties":true,"properties":{"name":{"type":"string","examples":["Error","InputError"],"minLength":1},"message":{"type":"string"},"code":{"type":"string"},"stack":{"type":"string"}}}}}}}
0 commit comments