@test-org-th/omd-schema 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,22 @@
-# Temporary Holding Version
+# @test-org-th/omd-schema
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Every released OMD schema version in one package. Sandbox for
+[omd-schema](https://github.com/wbd-streaming/omd-schema).
+
+```
+schemas/
+  index.json                 # versions per kind, newest first, with tag and commit
+  v1.4.4/OmdComponent.json
+  v1.2.1/OmdService.json
+  ...
+```
+
+Pick the schema from the `schema_version` in a `now.yaml`:
+
+```js
+const index = require('@test-org-th/omd-schema/schemas/index.json');
+const schema = require(`@test-org-th/omd-schema/schemas/${version}/OmdComponent.json`);
+```
+
+Each schema version is also a GitHub release (`component-v1.4.4`,
+`service-v1.2.1`) with the JSON attached.

package/package.json

@@ -1,6 +1,17 @@
 {
   "name": "@test-org-th/omd-schema",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "Every released OMD schema version, built from the component-v* and service-v* tags",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/saturday-vibes/omd-schema-sandbox.git"
+  },
+  "license": "MIT",
+  "files": [
+    "schemas"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/schemas/index.json

@@ -0,0 +1,112 @@
+{
+  "component": {
+    "latest": "v1.4.5",
+    "versions": [
+      {
+        "version": "v1.4.5",
+        "tag": "component-v1.4.5",
+        "commit": "d06dcf29da74051befdcd7ac04dcfac195d0d799"
+      },
+      {
+        "version": "v1.4.4",
+        "tag": "component-v1.4.4",
+        "commit": "4a4c674a465ad911b38fecc3f6bee91a98d371f2"
+      },
+      {
+        "version": "v1.4.3",
+        "tag": "component-v1.4.3",
+        "commit": "c8857b8073f332ead9ec55d2495da1203111659d"
+      },
+      {
+        "version": "v1.4.2",
+        "tag": "component-v1.4.2",
+        "commit": "a528c7bea181b61b187c3eaaa017dead8150ebcc"
+      },
+      {
+        "version": "v1.4.1",
+        "tag": "component-v1.4.1",
+        "commit": "974549be720acd8cf4e7340107dad9d463ec891e"
+      },
+      {
+        "version": "v1.4.0",
+        "tag": "component-v1.4.0",
+        "commit": "0a1c52b4f8509d39c5aa73f8a4ded6432e9e90f8"
+      },
+      {
+        "version": "v1.3.2",
+        "tag": "component-v1.3.2",
+        "commit": "8e7d192260f8041634b71095fdbb9b8f05bc01e4"
+      },
+      {
+        "version": "v1.3.1",
+        "tag": "component-v1.3.1",
+        "commit": "3e24d11eb54d63aaf14b1fcf5f1ac0759f2774e3"
+      },
+      {
+        "version": "v1.3.0",
+        "tag": "component-v1.3.0",
+        "commit": "ac2b437070bebb0236034f8c1eba53704e3ad0e6"
+      },
+      {
+        "version": "v1.2.0",
+        "tag": "component-v1.2.0",
+        "commit": "5e816d0b9470ae470d8c89ef190e1e890284ac8d"
+      },
+      {
+        "version": "v1.1.4",
+        "tag": "component-v1.1.4",
+        "commit": "2260e4967361caa0bf43bfd297f4f15d2e2343ac"
+      },
+      {
+        "version": "v1.1.3",
+        "tag": "component-v1.1.3",
+        "commit": "5aba254bc47ae0148fa6e496c9a1575aebe019a0"
+      },
+      {
+        "version": "v1.1.2",
+        "tag": "component-v1.1.2",
+        "commit": "1aac469247d5db1bfebed7508bcbfd4be514140f"
+      },
+      {
+        "version": "v1.1.1",
+        "tag": "component-v1.1.1",
+        "commit": "a88396bf21b7bff2c2407d6f02d4e2b72c368bf1"
+      },
+      {
+        "version": "v1.1.0",
+        "tag": "component-v1.1.0",
+        "commit": "74bb3aa87b83b3c5ba7a9e856dd59d88547f401b"
+      },
+      {
+        "version": "v1.0.0",
+        "tag": "component-v1.0.0",
+        "commit": "4ec0115f223be48af04e5b66f024627b9aac6770"
+      }
+    ]
+  },
+  "service": {
+    "latest": "v1.2.1",
+    "versions": [
+      {
+        "version": "v1.2.1",
+        "tag": "service-v1.2.1",
+        "commit": "4e29df57bc8676a084b80a58fab347ca57ab3c45"
+      },
+      {
+        "version": "v1.2.0",
+        "tag": "service-v1.2.0",
+        "commit": "a3c4a8f34a840161940d32e0c55fbae4e34290c2"
+      },
+      {
+        "version": "v1.1.0",
+        "tag": "service-v1.1.0",
+        "commit": "3d42570a95182c318c1b36307be48be3db635b09"
+      },
+      {
+        "version": "v1.0.0",
+        "tag": "service-v1.0.0",
+        "commit": "dca18472a77a275b397d63f131dbd6c90c9c8a63"
+      }
+    ]
+  }
+}

package/schemas/v1.0.0/OmdComponent.json

@@ -0,0 +1,93 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "title": "OMD Schema - Component",
+    "type": "object",
+    "required": [
+      "omd_service",
+      "omd_component",
+      "omd_jira_project",
+      "omd_schema_version",
+      "inventory_id"
+    ],
+    "properties": {
+      "omd_service": { "type": "string" },
+      "omd_schema_version": { "type": "string" },
+      "inventory_id": { "type": "string", "const": "980162270ee0cf69c2e3a0a0a87dd93d-e8e885e0931c2c609d3059f840c02b70" },
+      "omd_component": {
+        "title": "Component",
+        "description": "Name of an individual microservice, shared library, or other platform element (e.g. lambda, batch job, etc).  The value must be unique across the ecosystem.",
+        "type": "object",
+        "required": [
+          "name",
+          "description",
+          "omd_type",
+          "omd_compliance",
+          "omd_cell",
+          "subdivision_strategy",
+          "omd_sdm_owner_email"
+        ],
+        "properties": {
+          "name": {
+            "title": "Component",
+            "type": "string"
+          },
+          "description": {
+            "title": "Component description",
+            "type": "string"
+          },
+          "omd_type": {
+            "title": "Type",
+            "description": "Expresses what the implementation of the omd_component is",
+            "type": "string",
+            "enum": [
+              "microservice", "platform", "library", "sdk", "front-end", "infra", "client-app"
+            ]
+          },
+          "omd_compliance": {
+            "title": "Compliance",
+            "description": "Metadata associated with the omd_component which identifies if the service and its underlying components are directly associated with regulatory/compliance concerns.",
+            "type": "string"
+          },
+          "omd_cell": {
+            "title": "Cell",
+            "description": "Describes runtime relationships between microservices. For the time being, omd_cell should match omd_service",
+            "type": "string"
+          },
+          "subdivision_strategy": {
+            "title": "Subdivision Strategy",
+            "description": "A temporary tag in now.yaml describing the runtime deployment configuration of an OMD component that defines the mechanism for supporting multiple products across many regions. At deployment-time, this strategy is used to perform releases to specific subdivisions.",
+            "type": "string",
+            "enum": [
+              "product", "product-market", "global", "global-market"
+            ]
+          },
+          "omd_sdm_owner_email": {
+            "title": "SDM Owner Email",
+            "description": "The e-mail address of the WBD SDM/Director that owns the omd_component",
+            "type": "string"
+          }
+        }
+      },
+      "omd_jira_project": {
+        "title": "Jira Project",
+        "description": "The JIRA project acronym and URL associated with the Jira board representing where work is tracked for the corresponding omd_component",
+        "type": "object",
+        "required": [
+          "name",
+          "jira_board"
+        ],
+        "properties": {
+          "name": {
+            "title": "Name",
+            "description": "JIRA project acronym associated with the Jira board representing where work is tracked for the corresponding omd_component",
+            "type": "string"
+          },
+          "jira_board": {
+            "title": "Jira board URL",
+            "description": "URL associated with the Jira board representing where work is tracked for the corresponding omd_component",
+            "type": "string"
+          }
+        }
+      }
+    }
+  }

package/schemas/v1.0.0/OmdService.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "title": "OMD Schema - Repo Level",
+  "type": "object",
+  "required": [
+    "omd_business_service",
+    "omd_service",
+    "omd_schema_version",
+    "inventory_id"
+  ],
+  "properties": {
+    "omd_schema_version": { "type": "string" },
+    "inventory_id": { "type": "string", "const": "980162270ee0cf69c2e3a0a0a87dd93d-e8e885e0931c2c609d3059f840c02b70" },
+    "omd_business_service": {
+      "title": "Business Service",
+      "description": "Identifies the business owner of the components in the repository. Aligns to org chart and used primarily for auditing, accounting and reporting.",
+      "type": "object",
+      "required": [ "name" ],
+      "properties": {
+        "name": {
+          "title": "Business service name",
+          "type": "string"
+        }
+      }
+    },
+    "omd_service": {
+      "title": "Service",
+      "description": "A name for a group of related components which live together in source.",
+      "type": "object",
+      "required": [ "name", "description" ],
+      "properties": {
+        "name": {
+          "title": "Service name",
+          "type": "string"
+        },
+        "description": {
+          "title": "Service description",
+          "type": "string"
+        }
+      }
+    }
+  }
+}

package/schemas/v1.1.0/OmdComponent.json

@@ -0,0 +1,121 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "title": "OMD Schema - Component",
+    "type": "object",
+    "required": [
+      "omd_service",
+      "omd_component",
+      "omd_jira_project",
+      "omd_schema_version",
+      "inventory_id"
+    ],
+    "properties": {
+      "omd_service": { "type": "string" },
+      "omd_schema_version": { "type": "string" },
+      "inventory_id": { "type": "string", "const": "980162270ee0cf69c2e3a0a0a87dd93d-e8e885e0931c2c609d3059f840c02b70" },
+      "omd_component": {
+        "title": "Component",
+        "description": "Name of an individual microservice, shared library, or other platform element (e.g. lambda, batch job, etc).  The value must be unique across the ecosystem.",
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "name",
+          "description",
+          "omd_type",
+          "omd_compliance",
+          "omd_cell",
+          "subdivision_strategy",
+          "omd_sdm_owner_email",
+          "omd_team"
+        ],
+        "properties": {
+          "name": {
+            "title": "Component",
+            "type": "string"
+          },
+          "description": {
+            "title": "Component description",
+            "type": "string"
+          },
+          "omd_type": {
+            "title": "Type",
+            "description": "Expresses what the implementation of the omd_component is",
+            "type": "string",
+            "enum": [
+              "microservice", "platform", "library", "sdk", "front-end", "infra", "client-app"
+            ]
+          },
+          "omd_compliance": {
+            "title": "Compliance",
+            "description": "Metadata associated with the omd_component which identifies if the service and its underlying components are directly associated with regulatory/compliance concerns.",
+            "type": "string"
+          },
+          "omd_cell": {
+            "title": "Cell",
+            "description": "Describes runtime relationships between microservices. For the time being, omd_cell should match omd_service",
+            "type": "string"
+          },
+          "subdivision_strategy": {
+            "title": "Subdivision Strategy",
+            "description": "A temporary tag in now.yaml describing the runtime deployment configuration of an OMD component that defines the mechanism for supporting multiple products across many regions. At deployment-time, this strategy is used to perform releases to specific subdivisions.",
+            "type": "string",
+            "enum": [
+              "product", "product-market", "global", "global-market"
+            ]
+          },
+          "omd_sdm_owner_email": {
+            "title": "SDM Owner Email",
+            "description": "The e-mail address of the WBD SDM/Director that owns the omd_component",
+            "type": "string"
+          },
+          "omd_team" : {
+            "title": "OMD Team",
+            "description": "The JIRA team name, who owns this component",
+            "type": "string"
+          },
+          "omd_paths" : {
+            "title": "OMD Paths",
+            "description": "The paths, where you can find specific part(s) of the component.",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "src" : {
+                "title": "Source code",
+                "type": "array"
+              },
+              "infra" : {
+                "title": "IAC code",
+                "type": "array"
+              },
+              "docs" : {
+                "title": "Documentation",
+                "type": "array"
+              }
+            }
+          }
+        }
+      },
+      "omd_jira_project": {
+        "title": "Jira Project",
+        "description": "The JIRA project acronym and URL associated with the Jira board representing where work is tracked for the corresponding omd_component",
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "name",
+          "jira_board"
+        ],
+        "properties": {
+          "name": {
+            "title": "Name",
+            "description": "JIRA project acronym associated with the Jira board representing where work is tracked for the corresponding omd_component",
+            "type": "string"
+          },
+          "jira_board": {
+            "title": "Jira board URL",
+            "description": "URL associated with the Jira board representing where work is tracked for the corresponding omd_component",
+            "type": "string"
+          }
+        }
+      }
+    }
+  }

package/schemas/v1.1.0/OmdService.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "title": "OMD Schema - Repo Level",
+  "type": "object",
+  "required": [
+    "omd_business_service",
+    "omd_service",
+    "schema_version",
+    "inventory_id"
+  ],
+  "properties": {
+    "schema_version": { "type": "string" },
+    "inventory_id": { "type": "string", "const": "980162270ee0cf69c2e3a0a0a87dd93d-e8e885e0931c2c609d3059f840c02b70" },
+    "omd_business_service": {
+      "title": "Business Service",
+      "description": "Identifies the business owner of the components in the repository. Aligns to org chart and used primarily for auditing, accounting and reporting.",
+      "type": "object",
+      "required": [ "name" ],
+      "properties": {
+        "name": {
+          "title": "Business service name",
+          "type": "string"
+        }
+      }
+    },
+    "omd_service": {
+      "title": "Service",
+      "description": "A name for a group of related components which live together in source.",
+      "type": "object",
+      "required": [ "name", "description" ],
+      "properties": {
+        "name": {
+          "title": "Service name",
+          "type": "string"
+        },
+        "description": {
+          "title": "Service description",
+          "type": "string"
+        }
+      }
+    }
+  }
+}

package/schemas/v1.1.1/OmdComponent.json

@@ -0,0 +1,121 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "title": "OMD Schema - Component",
+    "type": "object",
+    "required": [
+      "omd_service",
+      "omd_component",
+      "omd_jira_project",
+      "omd_schema_version",
+      "inventory_id"
+    ],
+    "properties": {
+      "omd_service": { "type": "string" },
+      "omd_schema_version": { "type": "string" },
+      "inventory_id": { "type": "string", "const": "980162270ee0cf69c2e3a0a0a87dd93d-e8e885e0931c2c609d3059f840c02b70" },
+      "omd_component": {
+        "title": "Component",
+        "description": "Name of an individual microservice, shared library, or other platform element (e.g. lambda, batch job, etc).  The value must be unique across the ecosystem.",
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "name",
+          "description",
+          "omd_type",
+          "omd_compliance",
+          "omd_cell",
+          "subdivision_strategy",
+          "omd_sdm_owner_email",
+          "omd_team"
+        ],
+        "properties": {
+          "name": {
+            "title": "Component",
+            "type": "string"
+          },
+          "description": {
+            "title": "Component description",
+            "type": "string"
+          },
+          "omd_type": {
+            "title": "Type",
+            "description": "Expresses what the implementation of the omd_component is",
+            "type": "string",
+            "enum": [
+              "microservice", "platform", "library", "sdk", "front-end", "infra", "client-app", "dashboard"
+            ]
+          },
+          "omd_compliance": {
+            "title": "Compliance",
+            "description": "Metadata associated with the omd_component which identifies if the service and its underlying components are directly associated with regulatory/compliance concerns.",
+            "type": "string"
+          },
+          "omd_cell": {
+            "title": "Cell",
+            "description": "Describes runtime relationships between microservices. For the time being, omd_cell should match omd_service",
+            "type": "string"
+          },
+          "subdivision_strategy": {
+            "title": "Subdivision Strategy",
+            "description": "A temporary tag in now.yaml describing the runtime deployment configuration of an OMD component that defines the mechanism for supporting multiple products across many regions. At deployment-time, this strategy is used to perform releases to specific subdivisions.",
+            "type": "string",
+            "enum": [
+              "product", "product-market", "global", "global-market"
+            ]
+          },
+          "omd_sdm_owner_email": {
+            "title": "SDM Owner Email",
+            "description": "The e-mail address of the WBD SDM/Director that owns the omd_component",
+            "type": "string"
+          },
+          "omd_team" : {
+            "title": "OMD Team",
+            "description": "The JIRA team name, who owns this component",
+            "type": "string"
+          },
+          "omd_paths" : {
+            "title": "OMD Paths",
+            "description": "The paths, where you can find specific part(s) of the component.",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "src" : {
+                "title": "Source code",
+                "type": "array"
+              },
+              "infra" : {
+                "title": "IAC code",
+                "type": "array"
+              },
+              "docs" : {
+                "title": "Documentation",
+                "type": "array"
+              }
+            }
+          }
+        }
+      },
+      "omd_jira_project": {
+        "title": "Jira Project",
+        "description": "The JIRA project acronym and URL associated with the Jira board representing where work is tracked for the corresponding omd_component",
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "name",
+          "jira_board"
+        ],
+        "properties": {
+          "name": {
+            "title": "Name",
+            "description": "JIRA project acronym associated with the Jira board representing where work is tracked for the corresponding omd_component",
+            "type": "string"
+          },
+          "jira_board": {
+            "title": "Jira board URL",
+            "description": "URL associated with the Jira board representing where work is tracked for the corresponding omd_component",
+            "type": "string"
+          }
+        }
+      }
+    }
+  }