refactor: add new repository-lite common schema & add format to created_at, updated_at properties (#394)

wolfy1339 · web-flow · commit 2275762fc5d4 · 2021-03-02T17:06:45.000-05:00
diff --git a/payload-schemas/schemas/common/repository-lite.schema.json b/payload-schemas/schemas/common/repository-lite.schema.json
@@ -0,0 +1,109 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "common/repository-lite.schema.json",
+  "required": [
+    "archive_url",
+    "assignees_url",
+    "blobs_url",
+    "branches_url",
+    "collaborators_url",
+    "comments_url",
+    "commits_url",
+    "compare_url",
+    "contents_url",
+    "contributors_url",
+    "deployments_url",
+    "description",
+    "downloads_url",
+    "events_url",
+    "fork",
+    "forks_url",
+    "full_name",
+    "git_commits_url",
+    "git_refs_url",
+    "git_tags_url",
+    "hooks_url",
+    "html_url",
+    "id",
+    "issue_comment_url",
+    "issue_events_url",
+    "issues_url",
+    "keys_url",
+    "labels_url",
+    "languages_url",
+    "merges_url",
+    "milestones_url",
+    "name",
+    "node_id",
+    "notifications_url",
+    "owner",
+    "private",
+    "pulls_url",
+    "releases_url",
+    "stargazers_url",
+    "statuses_url",
+    "subscribers_url",
+    "subscription_url",
+    "tags_url",
+    "teams_url",
+    "trees_url",
+    "url"
+  ],
+  "type": "object",
+  "properties": {
+    "archive_url": { "type": "string", "format": "uri-template" },
+    "assignees_url": { "type": "string", "format": "uri-template" },
+    "blobs_url": { "type": "string", "format": "uri-template" },
+    "branches_url": { "type": "string", "format": "uri-template" },
+    "collaborators_url": { "type": "string", "format": "uri-template" },
+    "comments_url": { "type": "string", "format": "uri-template" },
+    "commits_url": { "type": "string", "format": "uri-template" },
+    "compare_url": { "type": "string", "format": "uri-template" },
+    "contents_url": { "type": "string", "format": "uri-template" },
+    "contributors_url": { "type": "string", "format": "uri" },
+    "deployments_url": { "type": "string", "format": "uri" },
+    "description": { "type": ["string", "null"] },
+    "downloads_url": { "type": "string", "format": "uri" },
+    "events_url": { "type": "string", "format": "uri" },
+    "fork": { "type": "boolean" },
+    "forks_url": { "type": "string", "format": "uri" },
+    "full_name": { "type": "string" },
+    "git_commits_url": { "type": "string", "format": "uri-template" },
+    "git_refs_url": { "type": "string", "format": "uri-template" },
+    "git_tags_url": { "type": "string", "format": "uri-template" },
+    "hooks_url": { "type": "string", "format": "uri" },
+    "html_url": { "type": "string", "format": "uri" },
+    "id": {
+      "type": "integer",
+      "description": "Unique identifier of the repository"
+    },
+    "issue_comment_url": { "type": "string", "format": "uri-template" },
+    "issue_events_url": { "type": "string", "format": "uri-template" },
+    "issues_url": { "type": "string", "format": "uri-template" },
+    "keys_url": { "type": "string", "format": "uri-template" },
+    "labels_url": { "type": "string", "format": "uri-template" },
+    "languages_url": { "type": "string", "format": "uri" },
+    "merges_url": { "type": "string", "format": "uri" },
+    "milestones_url": { "type": "string", "format": "uri-template" },
+    "name": { "type": "string", "description": "The name of the repository." },
+    "node_id": { "type": "string" },
+    "notifications_url": { "type": "string", "format": "uri-template" },
+    "owner": { "$ref": "user.schema.json" },
+    "private": {
+      "type": "boolean",
+      "description": "Whether the repository is private or public."
+    },
+    "pulls_url": { "type": "string", "format": "uri-template" },
+    "releases_url": { "type": "string", "format": "uri-template" },
+    "stargazers_url": { "type": "string", "format": "uri" },
+    "statuses_url": { "type": "string", "format": "uri-template" },
+    "subscribers_url": { "type": "string", "format": "uri" },
+    "subscription_url": { "type": "string", "format": "uri" },
+    "tags_url": { "type": "string", "format": "uri" },
+    "teams_url": { "type": "string", "format": "uri" },
+    "trees_url": { "type": "string", "format": "uri-template" },
+    "url": { "type": "string", "format": "uri" }
+  },
+  "additionalProperties": false,
+  "title": "Repository Lite"
+}
diff --git a/payload-schemas/schemas/common/workflow-run.schema.json b/payload-schemas/schemas/common/workflow-run.schema.json
@@ -33,110 +33,11 @@
     "cancel_url": { "type": "string", "format": "uri" },
     "check_suite_url": { "type": "string", "format": "uri" },
     "conclusion": { "type": ["string", "null"] },
-    "created_at": { "type": "string" },
+    "created_at": { "type": "string", "format": "date-time" },
     "event": { "type": "string" },
     "head_branch": { "type": "string" },
     "head_commit": { "$ref": "commit-simple.schema.json" },
-    "head_repository": {
-      "type": "object",
-      "required": [
-        "archive_url",
-        "assignees_url",
-        "blobs_url",
-        "branches_url",
-        "collaborators_url",
-        "comments_url",
-        "commits_url",
-        "compare_url",
-        "contents_url",
-        "contributors_url",
-        "deployments_url",
-        "description",
-        "downloads_url",
-        "events_url",
-        "fork",
-        "forks_url",
-        "full_name",
-        "git_commits_url",
-        "git_refs_url",
-        "git_tags_url",
-        "hooks_url",
-        "html_url",
-        "id",
-        "issue_comment_url",
-        "issue_events_url",
-        "issues_url",
-        "keys_url",
-        "labels_url",
-        "languages_url",
-        "merges_url",
-        "milestones_url",
-        "name",
-        "node_id",
-        "notifications_url",
-        "owner",
-        "private",
-        "pulls_url",
-        "releases_url",
-        "stargazers_url",
-        "statuses_url",
-        "subscribers_url",
-        "subscription_url",
-        "tags_url",
-        "teams_url",
-        "trees_url",
-        "url"
-      ],
-      "properties": {
-        "archive_url": { "type": "string", "format": "uri-template" },
-        "assignees_url": { "type": "string", "format": "uri-template" },
-        "blobs_url": { "type": "string", "format": "uri-template" },
-        "branches_url": { "type": "string", "format": "uri-template" },
-        "collaborators_url": { "type": "string", "format": "uri-template" },
-        "comments_url": { "type": "string", "format": "uri-template" },
-        "commits_url": { "type": "string", "format": "uri-template" },
-        "compare_url": { "type": "string", "format": "uri-template" },
-        "contents_url": { "type": "string", "format": "uri-template" },
-        "contributors_url": { "type": "string", "format": "uri" },
-        "deployments_url": { "type": "string", "format": "uri" },
-        "description": { "type": "string" },
-        "downloads_url": { "type": "string", "format": "uri" },
-        "events_url": { "type": "string", "format": "uri" },
-        "fork": { "type": "boolean" },
-        "forks_url": { "type": "string", "format": "uri" },
-        "full_name": { "type": "string" },
-        "git_commits_url": { "type": "string", "format": "uri-template" },
-        "git_refs_url": { "type": "string", "format": "uri-template" },
-        "git_tags_url": { "type": "string", "format": "uri-template" },
-        "hooks_url": { "type": "string", "format": "uri" },
-        "html_url": { "type": "string", "format": "uri" },
-        "id": { "type": "integer" },
-        "issue_comment_url": { "type": "string", "format": "uri-template" },
-        "issue_events_url": { "type": "string", "format": "uri-template" },
-        "issues_url": { "type": "string", "format": "uri-template" },
-        "keys_url": { "type": "string", "format": "uri-template" },
-        "labels_url": { "type": "string", "format": "uri-template" },
-        "languages_url": { "type": "string", "format": "uri" },
-        "merges_url": { "type": "string", "format": "uri" },
-        "milestones_url": { "type": "string", "format": "uri-template" },
-        "name": { "type": "string" },
-        "node_id": { "type": "string" },
-        "notifications_url": { "type": "string", "format": "uri-template" },
-        "owner": { "$ref": "user.schema.json" },
-        "private": { "type": "boolean" },
-        "pulls_url": { "type": "string", "format": "uri-template" },
-        "releases_url": { "type": "string", "format": "uri-template" },
-        "stargazers_url": { "type": "string", "format": "uri" },
-        "statuses_url": { "type": "string", "format": "uri-template" },
-        "subscribers_url": { "type": "string", "format": "uri" },
-        "subscription_url": { "type": "string", "format": "uri" },
-        "tags_url": { "type": "string", "format": "uri" },
-        "teams_url": { "type": "string", "format": "uri" },
-        "trees_url": { "type": "string", "format": "uri-template" },
-        "url": { "type": "string", "format": "uri" }
-      },
-      "additionalProperties": false
-    },
+    "head_repository": { "$ref": "repository-lite.schema.json" },
     "head_sha": { "type": "string" },
     "html_url": { "type": "string", "format": "uri" },
     "id": { "type": "integer" },
@@ -147,119 +48,11 @@
       "type": "array",
       "items": { "$ref": "pull-request.schema.json" }
     },
-    "repository": {
-      "type": "object",
-      "required": [
-        "archive_url",
-        "assignees_url",
-        "blobs_url",
-        "branches_url",
-        "collaborators_url",
-        "comments_url",
-        "commits_url",
-        "compare_url",
-        "contents_url",
-        "contributors_url",
-        "deployments_url",
-        "description",
-        "downloads_url",
-        "events_url",
-        "fork",
-        "forks_url",
-        "full_name",
-        "git_commits_url",
-        "git_refs_url",
-        "git_tags_url",
-        "hooks_url",
-        "html_url",
-        "id",
-        "issue_comment_url",
-        "issue_events_url",
-        "issues_url",
-        "keys_url",
-        "labels_url",
-        "languages_url",
-        "merges_url",
-        "milestones_url",
-        "name",
-        "node_id",
-        "notifications_url",
-        "owner",
-        "private",
-        "pulls_url",
-        "releases_url",
-        "stargazers_url",
-        "statuses_url",
-        "subscribers_url",
-        "subscription_url",
-        "tags_url",
-        "teams_url",
-        "trees_url",
-        "url"
-      ],
-      "properties": {
-        "archive_url": { "type": "string", "format": "uri-template" },
-        "assignees_url": { "type": "string", "format": "uri-template" },
-        "blobs_url": { "type": "string", "format": "uri-template" },
-        "branches_url": { "type": "string", "format": "uri-template" },
-        "collaborators_url": { "type": "string", "format": "uri-template" },
-        "comments_url": { "type": "string", "format": "uri-template" },
-        "commits_url": { "type": "string", "format": "uri-template" },
-        "compare_url": { "type": "string", "format": "uri-template" },
-        "contents_url": { "type": "string", "format": "uri-template" },
-        "contributors_url": { "type": "string", "format": "uri" },
-        "deployments_url": { "type": "string", "format": "uri" },
-        "description": { "type": "string" },
-        "downloads_url": { "type": "string", "format": "uri" },
-        "events_url": { "type": "string", "format": "uri" },
-        "fork": { "type": "boolean" },
-        "forks_url": { "type": "string", "format": "uri" },
-        "full_name": { "type": "string" },
-        "git_commits_url": { "type": "string", "format": "uri-template" },
-        "git_refs_url": { "type": "string", "format": "uri-template" },
-        "git_tags_url": { "type": "string", "format": "uri-template" },
-        "hooks_url": { "type": "string", "format": "uri" },
-        "html_url": { "type": "string", "format": "uri" },
-        "id": {
-          "type": "integer",
-          "description": "Unique identifier of the repository"
-        },
-        "issue_comment_url": { "type": "string", "format": "uri-template" },
-        "issue_events_url": { "type": "string", "format": "uri-template" },
-        "issues_url": { "type": "string", "format": "uri-template" },
-        "keys_url": { "type": "string", "format": "uri-template" },
-        "labels_url": { "type": "string", "format": "uri-template" },
-        "languages_url": { "type": "string", "format": "uri" },
-        "merges_url": { "type": "string", "format": "uri" },
-        "milestones_url": { "type": "string", "format": "uri-template" },
-        "name": {
-          "type": "string",
-          "description": "The name of the repository."
-        },
-        "node_id": { "type": "string" },
-        "notifications_url": { "type": "string", "format": "uri-template" },
-        "owner": { "$ref": "user.schema.json" },
-        "private": {
-          "type": "boolean",
-          "description": "Whether the repository is private or public."
-        },
-        "pulls_url": { "type": "string", "format": "uri-template" },
-        "releases_url": { "type": "string", "format": "uri-template" },
-        "stargazers_url": { "type": "string", "format": "uri" },
-        "statuses_url": { "type": "string", "format": "uri-template" },
-        "subscribers_url": { "type": "string", "format": "uri" },
-        "subscription_url": { "type": "string", "format": "uri" },
-        "tags_url": { "type": "string", "format": "uri" },
-        "teams_url": { "type": "string", "format": "uri" },
-        "trees_url": { "type": "string", "format": "uri-template" },
-        "url": { "type": "string", "format": "uri" }
-      },
-      "additionalProperties": false
-    },
+    "repository": { "$ref": "repository-lite.schema.json" },
     "rerun_url": { "type": "string", "format": "uri" },
     "run_number": { "type": "integer" },
     "status": { "type": "string" },
-    "updated_at": { "type": "string" },
+    "updated_at": { "type": "string", "format": "date-time" },
     "url": { "type": "string", "format": "uri" },
     "workflow_id": { "type": "integer" },
     "workflow_url": { "type": "string", "format": "uri" }
diff --git a/schema.d.ts b/schema.d.ts
