feat: author_association schema (#26)

octokit · Jan 21, 2021 · 7023f50 · 7023f50
1 parent 940ac8c
commit 7023f50
Show file tree

Hide file tree

Showing 3 changed files with 95 additions and 71 deletions.
diff --git a/cache/openapi-schema.json b/cache/openapi-schema.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "2.4.0",
+ "version": "2.4.1",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -38862,6 +38862,22 @@
  "updated_at"
  ]
  },
+ "author_association": {
+ "title": "author_association",
+ "type": "string",
+ "example": "OWNER",
+ "description": "How the author is associated with the repository.",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
  "issue-simple": {
  "title": "Issue Simple",
  "description": "Issue Simple",
@@ -38975,7 +38991,9 @@
  "format": "date-time",
  "example": "2011-04-22T13:33:48Z"
  },
- "author_association": { "type": "string" },
+ "author_association": {
+ "$ref": "#/components/schemas/author_association"
+ },
  "body_html": { "type": "string" },
  "body_text": { "type": "string" },
  "timeline_url": { "type": "string", "format": "uri" },
@@ -39078,17 +39096,7 @@
  },
  "issue_url": { "type": "string", "format": "uri" },
  "author_association": {
- "type": "string",
- "enum": [
- "collaborator",
- "contributor",
- "first_timer",
- "first_time_contributor",
- "mannequin",
- "member",
- "none",
- "owner"
- ]
+ "$ref": "#/components/schemas/author_association"
  },
  "performed_via_github_app": {
  "nullable": true,
@@ -39382,7 +39390,9 @@
  "format": "date-time",
  "example": "2011-04-18T23:23:56Z"
  },
- "author_association": { "type": "string" }
+ "author_association": {
+ "$ref": "#/components/schemas/author_association"
+ }
  },
  "required": [
  "url",
@@ -39568,7 +39578,9 @@
  "nullable": true,
  "allOf": [{ "$ref": "#/components/schemas/integration" }]
  },
- "author_association": { "type": "string" },
+ "author_association": {
+ "$ref": "#/components/schemas/author_association"
+ },
  "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
  },
  "required": [
@@ -44248,7 +44260,9 @@
  },
  "created_at": { "type": "string", "format": "date-time" },
  "updated_at": { "type": "string", "format": "date-time" },
- "author_association": { "type": "string" },
+ "author_association": {
+ "$ref": "#/components/schemas/author_association"
+ },
  "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
  },
  "required": [
@@ -44498,7 +44512,9 @@
  "self"
  ]
  },
- "author_association": { "type": "string", "example": "OWNER" },
+ "author_association": {
+ "$ref": "#/components/schemas/author_association"
+ },
  "draft": {
  "description": "Indicates whether or not the pull request is a draft.",
  "example": false,
@@ -46035,7 +46051,9 @@
  "$ref": "#/components/schemas/issue-event-project-card"
  },
  "rename": { "$ref": "#/components/schemas/issue-event-rename" },
- "author_association": { "type": "string" },
+ "author_association": {
+ "$ref": "#/components/schemas/author_association"
+ },
  "lock_reason": { "type": "string", "nullable": true }
  },
  "required": [
@@ -46083,8 +46101,7 @@
  "example": "\"2020-07-09T00:17:36Z\""
  },
  "author_association": {
- "type": "string",
- "example": "\"COLLABORATOR\""
+ "$ref": "#/components/schemas/author_association"
  },
  "body": { "type": "string", "example": "\":+1:\"" },
  "lock_reason": { "type": "string", "example": "\"off-topic\"" },
@@ -47040,7 +47057,9 @@
  "self"
  ]
  },
- "author_association": { "type": "string", "example": "OWNER" },
+ "author_association": {
+ "$ref": "#/components/schemas/author_association"
+ },
  "draft": {
  "description": "Indicates whether or not the pull request is a draft.",
  "example": false,
@@ -47204,9 +47223,7 @@
  "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
  },
  "author_association": {
- "description": "How the author of the comment is associated with the pull request.",
- "type": "string",
- "example": "OWNER"
+ "$ref": "#/components/schemas/author_association"
  },
  "_links": {
  "type": "object",
@@ -47395,7 +47412,9 @@
  },
  "body_html": { "type": "string" },
  "body_text": { "type": "string" },
- "author_association": { "type": "string" }
+ "author_association": {
+ "$ref": "#/components/schemas/author_association"
+ }
  },
  "required": [
  "id",
@@ -47471,7 +47490,9 @@
  "format": "uri",
  "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
  },
- "author_association": { "type": "string" },
+ "author_association": {
+ "$ref": "#/components/schemas/author_association"
+ },
  "_links": {
  "type": "object",
  "properties": {
@@ -48513,7 +48534,9 @@
  },
  "body": { "type": "string" },
  "score": { "type": "integer" },
- "author_association": { "type": "string" },
+ "author_association": {
+ "$ref": "#/components/schemas/author_association"
+ },
  "draft": { "type": "boolean" },
  "repository": { "$ref": "#/components/schemas/repository" },
  "body_html": { "type": "string" },
@@ -50406,7 +50429,7 @@
  },
  "created_at": "2011-04-18T23:23:56Z",
  "updated_at": "2011-04-18T23:23:56Z",
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  ]
  },
@@ -50438,7 +50461,7 @@
  },
  "created_at": "2011-04-18T23:23:56Z",
  "updated_at": "2011-04-18T23:23:56Z",
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  },
  "gist-commit-items": {
@@ -50945,7 +50968,7 @@
  "open_issues": 1,
  "watchers": 1
  },
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  ]
  },
@@ -57512,7 +57535,7 @@
  },
  "created_at": "2011-04-14T16:00:49Z",
  "updated_at": "2011-04-14T16:00:49Z",
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  ]
  },
@@ -57527,7 +57550,7 @@
  "position": 4,
  "line": 14,
  "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
- "author_association": "collaborator",
+ "author_association": "COLLABORATOR",
  "user": {
  "login": "octocat",
  "id": 1,
@@ -57563,7 +57586,7 @@
  "position": 4,
  "line": 14,
  "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
- "author_association": "collaborator",
+ "author_association": "COLLABORATOR",
  "user": {
  "login": "octocat",
  "id": 1,
@@ -60319,7 +60342,7 @@
  "closed_at": null,
  "created_at": "2011-04-22T13:33:48Z",
  "updated_at": "2011-04-22T13:33:48Z",
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  ]
  },
@@ -60479,7 +60502,7 @@
  "type": "User",
  "site_admin": false
  },
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  },
  "issue-comment-items": {
@@ -60513,7 +60536,7 @@
  "created_at": "2011-04-14T16:00:49Z",
  "updated_at": "2011-04-14T16:00:49Z",
  "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  ]
  },
@@ -60547,7 +60570,7 @@
  "created_at": "2011-04-14T16:00:49Z",
  "updated_at": "2011-04-14T16:00:49Z",
  "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  },
  "issue-event-items": {
@@ -60715,7 +60738,7 @@
  "closed_at": null,
  "created_at": "2011-04-22T13:33:48Z",
  "updated_at": "2011-04-22T13:33:48Z",
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  }
  ]
@@ -60884,7 +60907,7 @@
  "closed_at": null,
  "created_at": "2011-04-22T13:33:48Z",
  "updated_at": "2011-04-22T13:33:48Z",
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  }
  },
@@ -61064,7 +61087,7 @@
  "closed_at": null,
  "created_at": "2011-04-22T13:33:48Z",
  "updated_at": "2011-04-22T13:33:48Z",
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  },
  "issue-event-for-issue-items": {
@@ -62798,7 +62821,7 @@
  },
  "submitted_at": "2019-11-17T17:43:43Z",
  "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  ]
  },
@@ -62840,7 +62863,7 @@
  },
  "submitted_at": "2019-11-17T17:43:43Z",
  "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  },
  "pull-request-review-4": {
@@ -62881,7 +62904,7 @@
  },
  "submitted_at": "2019-11-17T17:43:43Z",
  "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  },
  "pull-request-review-5": {
@@ -62922,7 +62945,7 @@
  },
  "submitted_at": "2019-11-17T17:43:43Z",
  "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  },
  "review-comment-items": {
@@ -63017,7 +63040,7 @@
  },
  "submitted_at": "2019-11-17T17:43:43Z",
  "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  },
  "content-file": {
@@ -64655,7 +64678,7 @@
  "body": "...",
  "score": 1,
  "locked": true,
- "author_association": "collaborator"
+ "author_association": "COLLABORATOR"
  }
  ]
  }