@superblocksteam/vite-plugin-file-sync 2.0.8-next.8 → 2.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/dist/ai-service/const.d.ts +2 -1
  2. package/dist/ai-service/const.d.ts.map +1 -1
  3. package/dist/ai-service/const.js +2 -1
  4. package/dist/ai-service/const.js.map +1 -1
  5. package/dist/ai-service/index.d.ts +1 -0
  6. package/dist/ai-service/index.d.ts.map +1 -1
  7. package/dist/ai-service/index.js +23 -2
  8. package/dist/ai-service/index.js.map +1 -1
  9. package/dist/ai-service/integration-validator.d.ts.map +1 -1
  10. package/dist/ai-service/integration-validator.js +1 -0
  11. package/dist/ai-service/integration-validator.js.map +1 -1
  12. package/dist/ai-service/integrations/const.d.ts +52 -21
  13. package/dist/ai-service/integrations/const.d.ts.map +1 -1
  14. package/dist/ai-service/integrations/const.js +72 -41
  15. package/dist/ai-service/integrations/const.js.map +1 -1
  16. package/dist/ai-service/integrations/from-prompt-context.d.ts +2 -1
  17. package/dist/ai-service/integrations/from-prompt-context.d.ts.map +1 -1
  18. package/dist/ai-service/integrations/from-prompt-context.js +22 -2
  19. package/dist/ai-service/integrations/from-prompt-context.js.map +1 -1
  20. package/dist/ai-service/integrations/store.d.ts +16 -0
  21. package/dist/ai-service/integrations/store.d.ts.map +1 -0
  22. package/dist/ai-service/integrations/store.js +53 -0
  23. package/dist/ai-service/integrations/store.js.map +1 -0
  24. package/dist/ai-service/integrations/to-sdk-prompt.js +1 -3387
  25. package/dist/ai-service/integrations/to-sdk-prompt.js.map +1 -1
  26. package/dist/ai-service/prompts/draft-subprompts/superblocks-api-draft.d.ts +1 -1
  27. package/dist/ai-service/prompts/draft-subprompts/superblocks-api-draft.d.ts.map +1 -1
  28. package/dist/ai-service/prompts/draft-subprompts/superblocks-api-draft.js +2 -2
  29. package/dist/ai-service/prompts/generated/library-components/ButtonPropsDocs.js +1 -1
  30. package/dist/ai-service/prompts/generated/library-components/CheckboxPropsDocs.d.ts +1 -1
  31. package/dist/ai-service/prompts/generated/library-components/CheckboxPropsDocs.d.ts.map +1 -1
  32. package/dist/ai-service/prompts/generated/library-components/CheckboxPropsDocs.js +2 -2
  33. package/dist/ai-service/prompts/generated/library-components/CheckboxPropsDocs.js.map +1 -1
  34. package/dist/ai-service/prompts/generated/library-components/ColumnPropsDocs.js +1 -1
  35. package/dist/ai-service/prompts/generated/library-components/ContainerPropsDocs.js +1 -1
  36. package/dist/ai-service/prompts/generated/library-components/DatePickerPropsDocs.d.ts +1 -1
  37. package/dist/ai-service/prompts/generated/library-components/DatePickerPropsDocs.d.ts.map +1 -1
  38. package/dist/ai-service/prompts/generated/library-components/DatePickerPropsDocs.js +2 -2
  39. package/dist/ai-service/prompts/generated/library-components/DatePickerPropsDocs.js.map +1 -1
  40. package/dist/ai-service/prompts/generated/library-components/DropdownPropsDocs.d.ts +1 -1
  41. package/dist/ai-service/prompts/generated/library-components/DropdownPropsDocs.d.ts.map +1 -1
  42. package/dist/ai-service/prompts/generated/library-components/DropdownPropsDocs.js +2 -2
  43. package/dist/ai-service/prompts/generated/library-components/DropdownPropsDocs.js.map +1 -1
  44. package/dist/ai-service/prompts/generated/library-components/IconPropsDocs.js +1 -1
  45. package/dist/ai-service/prompts/generated/library-components/ImagePropsDocs.js +1 -1
  46. package/dist/ai-service/prompts/generated/library-components/InputPropsDocs.d.ts +1 -1
  47. package/dist/ai-service/prompts/generated/library-components/InputPropsDocs.d.ts.map +1 -1
  48. package/dist/ai-service/prompts/generated/library-components/InputPropsDocs.js +2 -2
  49. package/dist/ai-service/prompts/generated/library-components/InputPropsDocs.js.map +1 -1
  50. package/dist/ai-service/prompts/generated/library-components/ModalPropsDocs.js +1 -1
  51. package/dist/ai-service/prompts/generated/library-components/PagePropsDocs.js +1 -1
  52. package/dist/ai-service/prompts/generated/library-components/SectionPropsDocs.js +1 -1
  53. package/dist/ai-service/prompts/generated/library-components/SlideoutPropsDocs.js +1 -1
  54. package/dist/ai-service/prompts/generated/library-components/SwitchPropsDocs.d.ts +1 -1
  55. package/dist/ai-service/prompts/generated/library-components/SwitchPropsDocs.d.ts.map +1 -1
  56. package/dist/ai-service/prompts/generated/library-components/SwitchPropsDocs.js +2 -2
  57. package/dist/ai-service/prompts/generated/library-components/SwitchPropsDocs.js.map +1 -1
  58. package/dist/ai-service/prompts/generated/library-components/TablePropsDocs.js +1 -1
  59. package/dist/ai-service/prompts/generated/library-components/TextPropsDocs.js +1 -1
  60. package/dist/ai-service/prompts/generated/library-typedefs/Dim.js +1 -1
  61. package/dist/ai-service/prompts/generated/library-typedefs/EventFlow.d.ts +1 -1
  62. package/dist/ai-service/prompts/generated/library-typedefs/EventFlow.d.ts.map +1 -1
  63. package/dist/ai-service/prompts/generated/library-typedefs/EventFlow.js +2 -2
  64. package/dist/ai-service/prompts/generated/library-typedefs/EventFlow.js.map +1 -1
  65. package/dist/ai-service/prompts/generated/library-typedefs/TextStyleWithVariant.js +1 -1
  66. package/dist/ai-service/prompts/generated/subprompts/full-examples.d.ts +1 -1
  67. package/dist/ai-service/prompts/generated/subprompts/full-examples.d.ts.map +1 -1
  68. package/dist/ai-service/prompts/generated/subprompts/full-examples.js +2 -2
  69. package/dist/ai-service/prompts/generated/subprompts/full-examples.js.map +1 -1
  70. package/dist/ai-service/prompts/generated/subprompts/superblocks-api.d.ts +1 -1
  71. package/dist/ai-service/prompts/generated/subprompts/superblocks-api.d.ts.map +1 -1
  72. package/dist/ai-service/prompts/generated/subprompts/superblocks-api.js +2 -2
  73. package/dist/ai-service/prompts/generated/subprompts/superblocks-api.js.map +1 -1
  74. package/dist/ai-service/prompts/generated/subprompts/superblocks-components-rules.js +1 -1
  75. package/dist/ai-service/prompts/generated/subprompts/superblocks-custom-components.js +1 -1
  76. package/dist/ai-service/prompts/generated/subprompts/superblocks-data-filtering.d.ts +1 -1
  77. package/dist/ai-service/prompts/generated/subprompts/superblocks-data-filtering.d.ts.map +1 -1
  78. package/dist/ai-service/prompts/generated/subprompts/superblocks-data-filtering.js +2 -2
  79. package/dist/ai-service/prompts/generated/subprompts/superblocks-data-filtering.js.map +1 -1
  80. package/dist/ai-service/prompts/generated/subprompts/superblocks-event-flow.js +1 -1
  81. package/dist/ai-service/prompts/generated/subprompts/superblocks-forms.d.ts +1 -1
  82. package/dist/ai-service/prompts/generated/subprompts/superblocks-forms.d.ts.map +1 -1
  83. package/dist/ai-service/prompts/generated/subprompts/superblocks-forms.js +2 -2
  84. package/dist/ai-service/prompts/generated/subprompts/superblocks-forms.js.map +1 -1
  85. package/dist/ai-service/prompts/generated/subprompts/superblocks-layouts.js +1 -1
  86. package/dist/ai-service/prompts/generated/subprompts/superblocks-page.d.ts +1 -1
  87. package/dist/ai-service/prompts/generated/subprompts/superblocks-page.d.ts.map +1 -1
  88. package/dist/ai-service/prompts/generated/subprompts/superblocks-page.js +2 -2
  89. package/dist/ai-service/prompts/generated/subprompts/superblocks-page.js.map +1 -1
  90. package/dist/ai-service/prompts/generated/subprompts/superblocks-rbac.js +1 -1
  91. package/dist/ai-service/prompts/generated/subprompts/superblocks-routes.js +1 -1
  92. package/dist/ai-service/prompts/generated/subprompts/superblocks-state.d.ts +1 -1
  93. package/dist/ai-service/prompts/generated/subprompts/superblocks-state.d.ts.map +1 -1
  94. package/dist/ai-service/prompts/generated/subprompts/superblocks-state.js +2 -2
  95. package/dist/ai-service/prompts/generated/subprompts/superblocks-state.js.map +1 -1
  96. package/dist/ai-service/prompts/generated/subprompts/superblocks-theming.js +1 -1
  97. package/dist/ai-service/prompts/generated/subprompts/system.d.ts +1 -1
  98. package/dist/ai-service/prompts/generated/subprompts/system.d.ts.map +1 -1
  99. package/dist/ai-service/prompts/generated/subprompts/system.js +2 -2
  100. package/dist/ai-service/prompts/generated/subprompts/system.js.map +1 -1
  101. package/dist/ai-service/prompts/openapi-intent.d.ts +17 -0
  102. package/dist/ai-service/prompts/openapi-intent.d.ts.map +1 -0
  103. package/dist/ai-service/prompts/openapi-intent.js +37 -0
  104. package/dist/ai-service/prompts/openapi-intent.js.map +1 -0
  105. package/dist/ai-service/state-machine/clark-fsm.d.ts +11 -0
  106. package/dist/ai-service/state-machine/clark-fsm.d.ts.map +1 -1
  107. package/dist/ai-service/state-machine/clark-fsm.js +6 -0
  108. package/dist/ai-service/state-machine/clark-fsm.js.map +1 -1
  109. package/dist/ai-service/state-machine/handlers/agent-planning.d.ts.map +1 -1
  110. package/dist/ai-service/state-machine/handlers/agent-planning.js +31 -19
  111. package/dist/ai-service/state-machine/handlers/agent-planning.js.map +1 -1
  112. package/dist/ai-service/state-machine/handlers/idle.d.ts.map +1 -1
  113. package/dist/ai-service/state-machine/handlers/idle.js +15 -3
  114. package/dist/ai-service/state-machine/handlers/idle.js.map +1 -1
  115. package/dist/ai-service/state-machine/handlers/post-processing.d.ts.map +1 -1
  116. package/dist/ai-service/state-machine/handlers/post-processing.js +1 -1
  117. package/dist/ai-service/state-machine/handlers/post-processing.js.map +1 -1
  118. package/dist/ai-service/state-machine/handlers/runtime-reviewing.d.ts.map +1 -1
  119. package/dist/ai-service/state-machine/handlers/runtime-reviewing.js +1 -1
  120. package/dist/ai-service/state-machine/handlers/runtime-reviewing.js.map +1 -1
  121. package/dist/ai-service/state-machine/helpers/change-info.d.ts.map +1 -1
  122. package/dist/ai-service/state-machine/helpers/change-info.js +2 -2
  123. package/dist/ai-service/state-machine/helpers/change-info.js.map +1 -1
  124. package/dist/ai-service/state-machine/helpers/peer.d.ts +2 -2
  125. package/dist/ai-service/state-machine/helpers/peer.d.ts.map +1 -1
  126. package/dist/ai-service/state-machine/helpers/peer.js +8 -2
  127. package/dist/ai-service/state-machine/helpers/peer.js.map +1 -1
  128. package/dist/ai-service/state-machine/mocks.d.ts.map +1 -1
  129. package/dist/ai-service/state-machine/mocks.js +4 -0
  130. package/dist/ai-service/state-machine/mocks.js.map +1 -1
  131. package/dist/ai-service/test-utils/app-generation-mocks/orders-app.d.ts +1 -1
  132. package/dist/ai-service/test-utils/app-generation-mocks/orders-app.js +10 -10
  133. package/dist/file-system-manager.d.ts.map +1 -1
  134. package/dist/file-system-manager.js +4 -0
  135. package/dist/file-system-manager.js.map +1 -1
  136. package/dist/parsing/entity/to-code-entity.js +6 -6
  137. package/dist/parsing/entity/to-code-entity.js.map +1 -1
  138. package/dist/parsing/entity/to-value-entity.js +8 -8
  139. package/dist/parsing/entity/to-value-entity.js.map +1 -1
  140. package/dist/parsing/events/to-value-events.d.ts +1 -1
  141. package/dist/parsing/events/to-value-events.d.ts.map +1 -1
  142. package/dist/parsing/events/to-value-events.js +2 -1
  143. package/dist/parsing/events/to-value-events.js.map +1 -1
  144. package/dist/parsing/scope.js +7 -7
  145. package/dist/parsing/scope.js.map +1 -1
  146. package/dist/rename-manager.js +3 -3
  147. package/dist/rename-manager.js.map +1 -1
  148. package/dist/util/open-api.d.ts +53 -0
  149. package/dist/util/open-api.d.ts.map +1 -0
  150. package/dist/util/open-api.js +104 -0
  151. package/dist/util/open-api.js.map +1 -0
  152. package/package.json +5 -5
@@ -14,3392 +14,6 @@ export const integrationsToSdkPromptContent = (integrations) => {
14
14
  });
15
15
  };
16
16
  const getIntegrationMetadata = (integration) => {
17
- // the type should include these. I verified that type is the effective type.
18
- if (integration.type === "github") {
19
- return {
20
- // LARGE
21
- openApiSpec: {
22
- openapi: "3.0.3",
23
- info: {
24
- version: "1.1.4",
25
- title: "GitHub",
26
- },
27
- servers: [
28
- {
29
- url: "https://api.github.com",
30
- },
31
- ],
32
- paths: {
33
- "/repos/{owner}/{repo}/pulls/{pull_number}": {
34
- get: {
35
- summary: "Get a PR",
36
- description: 'Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub\'s products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.',
37
- parameters: [
38
- {
39
- $ref: "#/components/parameters/owner",
40
- },
41
- {
42
- $ref: "#/components/parameters/repo",
43
- },
44
- {
45
- $ref: "#/components/parameters/pull-number",
46
- },
47
- ],
48
- responses: {
49
- "200": {
50
- description: "Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.",
51
- content: {
52
- "application/json": {
53
- schema: {
54
- $ref: "#/components/schemas/pull-request",
55
- },
56
- },
57
- },
58
- },
59
- "304": {
60
- $ref: "#/components/responses/not_modified",
61
- },
62
- "404": {
63
- $ref: "#/components/responses/not_found",
64
- },
65
- "500": {
66
- $ref: "#/components/responses/internal_error",
67
- },
68
- "503": {
69
- $ref: "#/components/responses/service_unavailable",
70
- },
71
- },
72
- },
73
- },
74
- "/repos/{owner}/{repo}/pulls": {
75
- get: {
76
- summary: "List PRs",
77
- description: "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
78
- parameters: [
79
- {
80
- $ref: "#/components/parameters/owner",
81
- },
82
- {
83
- $ref: "#/components/parameters/repo",
84
- },
85
- {
86
- name: "state",
87
- description: "Either `open`, `closed`, or `all` to filter by state.",
88
- in: "query",
89
- required: false,
90
- schema: {
91
- type: "string",
92
- enum: ["open", "closed", "all"],
93
- default: "open",
94
- },
95
- },
96
- {
97
- name: "head",
98
- description: "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.",
99
- in: "query",
100
- required: false,
101
- schema: {
102
- type: "string",
103
- },
104
- },
105
- {
106
- name: "base",
107
- description: "Filter pulls by base branch name. Example: `gh-pages`.",
108
- in: "query",
109
- required: false,
110
- schema: {
111
- type: "string",
112
- },
113
- },
114
- {
115
- name: "sort",
116
- description: "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.",
117
- in: "query",
118
- required: false,
119
- schema: {
120
- type: "string",
121
- enum: ["created", "updated", "popularity", "long-running"],
122
- default: "created",
123
- },
124
- },
125
- {
126
- name: "direction",
127
- description: "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
128
- in: "query",
129
- required: false,
130
- schema: {
131
- type: "string",
132
- enum: ["asc", "desc"],
133
- },
134
- },
135
- {
136
- $ref: "#/components/parameters/per-page",
137
- },
138
- {
139
- $ref: "#/components/parameters/page",
140
- },
141
- ],
142
- responses: {
143
- "200": {
144
- description: "Response",
145
- content: {
146
- "application/json": {
147
- schema: {
148
- type: "array",
149
- items: {
150
- $ref: "#/components/schemas/pull-request-simple",
151
- },
152
- },
153
- },
154
- },
155
- headers: {
156
- Link: {
157
- $ref: "#/components/headers/link",
158
- },
159
- },
160
- },
161
- "304": {
162
- $ref: "#/components/responses/not_modified",
163
- },
164
- "422": {
165
- $ref: "#/components/responses/validation_failed",
166
- },
167
- },
168
- "x-github": {
169
- githubCloudOnly: false,
170
- enabledForGitHubApps: true,
171
- category: "pulls",
172
- subcategory: "pulls",
173
- },
174
- },
175
- },
176
- },
177
- components: {
178
- parameters: {
179
- owner: {
180
- name: "owner",
181
- description: "The account owner of the repository. The name is not case sensitive.",
182
- in: "path",
183
- required: true,
184
- schema: {
185
- type: "string",
186
- },
187
- },
188
- repo: {
189
- name: "repo",
190
- description: "The name of the repository without the `.git` extension. The name is not case sensitive.",
191
- in: "path",
192
- required: true,
193
- schema: {
194
- type: "string",
195
- },
196
- },
197
- "pull-number": {
198
- name: "pull_number",
199
- description: "The number that identifies the pull request.",
200
- in: "path",
201
- required: true,
202
- schema: {
203
- type: "integer",
204
- },
205
- },
206
- },
207
- schemas: {
208
- "simple-user": {
209
- title: "Simple User",
210
- description: "A GitHub user.",
211
- type: "object",
212
- properties: {
213
- name: {
214
- nullable: true,
215
- type: "string",
216
- },
217
- email: {
218
- nullable: true,
219
- type: "string",
220
- },
221
- login: {
222
- type: "string",
223
- example: "octocat",
224
- },
225
- id: {
226
- type: "integer",
227
- example: 1,
228
- },
229
- node_id: {
230
- type: "string",
231
- example: "MDQ6VXNlcjE=",
232
- },
233
- avatar_url: {
234
- type: "string",
235
- format: "uri",
236
- example: "https://github.com/images/error/octocat_happy.gif",
237
- },
238
- gravatar_id: {
239
- type: "string",
240
- example: "41d064eb2195891e12d0413f63227ea7",
241
- nullable: true,
242
- },
243
- url: {
244
- type: "string",
245
- format: "uri",
246
- example: "https://api.github.com/users/octocat",
247
- },
248
- html_url: {
249
- type: "string",
250
- format: "uri",
251
- example: "https://github.com/octocat",
252
- },
253
- followers_url: {
254
- type: "string",
255
- format: "uri",
256
- example: "https://api.github.com/users/octocat/followers",
257
- },
258
- following_url: {
259
- type: "string",
260
- example: "https://api.github.com/users/octocat/following{/other_user}",
261
- },
262
- gists_url: {
263
- type: "string",
264
- example: "https://api.github.com/users/octocat/gists{/gist_id}",
265
- },
266
- starred_url: {
267
- type: "string",
268
- example: "https://api.github.com/users/octocat/starred{/owner}{/repo}",
269
- },
270
- subscriptions_url: {
271
- type: "string",
272
- format: "uri",
273
- example: "https://api.github.com/users/octocat/subscriptions",
274
- },
275
- organizations_url: {
276
- type: "string",
277
- format: "uri",
278
- example: "https://api.github.com/users/octocat/orgs",
279
- },
280
- repos_url: {
281
- type: "string",
282
- format: "uri",
283
- example: "https://api.github.com/users/octocat/repos",
284
- },
285
- events_url: {
286
- type: "string",
287
- example: "https://api.github.com/users/octocat/events{/privacy}",
288
- },
289
- received_events_url: {
290
- type: "string",
291
- format: "uri",
292
- example: "https://api.github.com/users/octocat/received_events",
293
- },
294
- type: {
295
- type: "string",
296
- example: "User",
297
- },
298
- site_admin: {
299
- type: "boolean",
300
- },
301
- starred_at: {
302
- type: "string",
303
- example: '"2020-07-09T00:17:55Z"',
304
- },
305
- },
306
- required: [
307
- "avatar_url",
308
- "events_url",
309
- "followers_url",
310
- "following_url",
311
- "gists_url",
312
- "gravatar_id",
313
- "html_url",
314
- "id",
315
- "node_id",
316
- "login",
317
- "organizations_url",
318
- "received_events_url",
319
- "repos_url",
320
- "site_admin",
321
- "starred_url",
322
- "subscriptions_url",
323
- "type",
324
- "url",
325
- ],
326
- },
327
- link: {
328
- title: "Link",
329
- description: "Hypermedia Link",
330
- type: "object",
331
- properties: {
332
- href: {
333
- type: "string",
334
- },
335
- },
336
- required: ["href"],
337
- },
338
- "nullable-milestone": {
339
- title: "Milestone",
340
- description: "A collection of related issues and pull requests.",
341
- type: "object",
342
- properties: {
343
- url: {
344
- type: "string",
345
- format: "uri",
346
- example: "https://api.github.com/repos/octocat/Hello-World/milestones/1",
347
- },
348
- html_url: {
349
- type: "string",
350
- format: "uri",
351
- example: "https://github.com/octocat/Hello-World/milestones/v1.0",
352
- },
353
- labels_url: {
354
- type: "string",
355
- format: "uri",
356
- example: "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
357
- },
358
- id: {
359
- type: "integer",
360
- example: 1002604,
361
- },
362
- node_id: {
363
- type: "string",
364
- example: "MDk6TWlsZXN0b25lMTAwMjYwNA==",
365
- },
366
- number: {
367
- description: "The number of the milestone.",
368
- type: "integer",
369
- example: 42,
370
- },
371
- state: {
372
- description: "The state of the milestone.",
373
- example: "open",
374
- type: "string",
375
- enum: ["open", "closed"],
376
- default: "open",
377
- },
378
- title: {
379
- description: "The title of the milestone.",
380
- example: "v1.0",
381
- type: "string",
382
- },
383
- description: {
384
- type: "string",
385
- example: "Tracking milestone for version 1.0",
386
- nullable: true,
387
- },
388
- creator: {
389
- $ref: "#/components/schemas/nullable-simple-user",
390
- },
391
- open_issues: {
392
- type: "integer",
393
- example: 4,
394
- },
395
- closed_issues: {
396
- type: "integer",
397
- example: 8,
398
- },
399
- created_at: {
400
- type: "string",
401
- format: "date-time",
402
- example: "2011-04-10T20:09:31Z",
403
- },
404
- updated_at: {
405
- type: "string",
406
- format: "date-time",
407
- example: "2014-03-03T18:58:10Z",
408
- },
409
- closed_at: {
410
- type: "string",
411
- format: "date-time",
412
- example: "2013-02-12T13:22:01Z",
413
- nullable: true,
414
- },
415
- due_on: {
416
- type: "string",
417
- format: "date-time",
418
- example: "2012-10-09T23:39:01Z",
419
- nullable: true,
420
- },
421
- },
422
- required: [
423
- "closed_issues",
424
- "creator",
425
- "description",
426
- "due_on",
427
- "closed_at",
428
- "id",
429
- "node_id",
430
- "labels_url",
431
- "html_url",
432
- "number",
433
- "open_issues",
434
- "state",
435
- "title",
436
- "url",
437
- "created_at",
438
- "updated_at",
439
- ],
440
- nullable: true,
441
- },
442
- "nullable-simple-user": {
443
- title: "Simple User",
444
- description: "A GitHub user.",
445
- type: "object",
446
- properties: {
447
- name: {
448
- nullable: true,
449
- type: "string",
450
- },
451
- email: {
452
- nullable: true,
453
- type: "string",
454
- },
455
- login: {
456
- type: "string",
457
- example: "octocat",
458
- },
459
- id: {
460
- type: "integer",
461
- example: 1,
462
- },
463
- node_id: {
464
- type: "string",
465
- example: "MDQ6VXNlcjE=",
466
- },
467
- avatar_url: {
468
- type: "string",
469
- format: "uri",
470
- example: "https://github.com/images/error/octocat_happy.gif",
471
- },
472
- gravatar_id: {
473
- type: "string",
474
- example: "41d064eb2195891e12d0413f63227ea7",
475
- nullable: true,
476
- },
477
- url: {
478
- type: "string",
479
- format: "uri",
480
- example: "https://api.github.com/users/octocat",
481
- },
482
- html_url: {
483
- type: "string",
484
- format: "uri",
485
- example: "https://github.com/octocat",
486
- },
487
- followers_url: {
488
- type: "string",
489
- format: "uri",
490
- example: "https://api.github.com/users/octocat/followers",
491
- },
492
- following_url: {
493
- type: "string",
494
- example: "https://api.github.com/users/octocat/following{/other_user}",
495
- },
496
- gists_url: {
497
- type: "string",
498
- example: "https://api.github.com/users/octocat/gists{/gist_id}",
499
- },
500
- starred_url: {
501
- type: "string",
502
- example: "https://api.github.com/users/octocat/starred{/owner}{/repo}",
503
- },
504
- subscriptions_url: {
505
- type: "string",
506
- format: "uri",
507
- example: "https://api.github.com/users/octocat/subscriptions",
508
- },
509
- organizations_url: {
510
- type: "string",
511
- format: "uri",
512
- example: "https://api.github.com/users/octocat/orgs",
513
- },
514
- repos_url: {
515
- type: "string",
516
- format: "uri",
517
- example: "https://api.github.com/users/octocat/repos",
518
- },
519
- events_url: {
520
- type: "string",
521
- example: "https://api.github.com/users/octocat/events{/privacy}",
522
- },
523
- received_events_url: {
524
- type: "string",
525
- format: "uri",
526
- example: "https://api.github.com/users/octocat/received_events",
527
- },
528
- type: {
529
- type: "string",
530
- example: "User",
531
- },
532
- site_admin: {
533
- type: "boolean",
534
- },
535
- starred_at: {
536
- type: "string",
537
- example: '"2020-07-09T00:17:55Z"',
538
- },
539
- },
540
- required: [
541
- "avatar_url",
542
- "events_url",
543
- "followers_url",
544
- "following_url",
545
- "gists_url",
546
- "gravatar_id",
547
- "html_url",
548
- "id",
549
- "node_id",
550
- "login",
551
- "organizations_url",
552
- "received_events_url",
553
- "repos_url",
554
- "site_admin",
555
- "starred_url",
556
- "subscriptions_url",
557
- "type",
558
- "url",
559
- ],
560
- nullable: true,
561
- },
562
- "pull-request": {
563
- type: "object",
564
- title: "Pull Request",
565
- description: "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.",
566
- properties: {
567
- url: {
568
- type: "string",
569
- format: "uri",
570
- example: "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
571
- },
572
- id: {
573
- type: "integer",
574
- example: 1,
575
- },
576
- node_id: {
577
- type: "string",
578
- example: "MDExOlB1bGxSZXF1ZXN0MQ==",
579
- },
580
- html_url: {
581
- type: "string",
582
- format: "uri",
583
- example: "https://github.com/octocat/Hello-World/pull/1347",
584
- },
585
- diff_url: {
586
- type: "string",
587
- format: "uri",
588
- example: "https://github.com/octocat/Hello-World/pull/1347.diff",
589
- },
590
- patch_url: {
591
- type: "string",
592
- format: "uri",
593
- example: "https://github.com/octocat/Hello-World/pull/1347.patch",
594
- },
595
- issue_url: {
596
- type: "string",
597
- format: "uri",
598
- example: "https://api.github.com/repos/octocat/Hello-World/issues/1347",
599
- },
600
- commits_url: {
601
- type: "string",
602
- format: "uri",
603
- example: "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits",
604
- },
605
- review_comments_url: {
606
- type: "string",
607
- format: "uri",
608
- example: "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments",
609
- },
610
- review_comment_url: {
611
- type: "string",
612
- example: "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}",
613
- },
614
- comments_url: {
615
- type: "string",
616
- format: "uri",
617
- example: "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
618
- },
619
- statuses_url: {
620
- type: "string",
621
- format: "uri",
622
- example: "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
623
- },
624
- number: {
625
- description: "Number uniquely identifying the pull request within its repository.",
626
- example: 42,
627
- type: "integer",
628
- },
629
- state: {
630
- description: "State of this Pull Request. Either `open` or `closed`.",
631
- enum: ["open", "closed"],
632
- example: "open",
633
- type: "string",
634
- },
635
- locked: {
636
- type: "boolean",
637
- example: true,
638
- },
639
- title: {
640
- description: "The title of the pull request.",
641
- example: "Amazing new feature",
642
- type: "string",
643
- },
644
- user: {
645
- $ref: "#/components/schemas/simple-user",
646
- },
647
- body: {
648
- type: "string",
649
- example: "Please pull these awesome changes",
650
- nullable: true,
651
- },
652
- labels: {
653
- type: "array",
654
- items: {
655
- type: "object",
656
- properties: {
657
- id: {
658
- type: "integer",
659
- format: "int64",
660
- },
661
- node_id: {
662
- type: "string",
663
- },
664
- url: {
665
- type: "string",
666
- },
667
- name: {
668
- type: "string",
669
- },
670
- description: {
671
- type: "string",
672
- nullable: true,
673
- },
674
- color: {
675
- type: "string",
676
- },
677
- default: {
678
- type: "boolean",
679
- },
680
- },
681
- required: [
682
- "id",
683
- "node_id",
684
- "url",
685
- "name",
686
- "description",
687
- "color",
688
- "default",
689
- ],
690
- },
691
- },
692
- milestone: {
693
- $ref: "#/components/schemas/nullable-milestone",
694
- },
695
- active_lock_reason: {
696
- type: "string",
697
- example: "too heated",
698
- nullable: true,
699
- },
700
- created_at: {
701
- type: "string",
702
- format: "date-time",
703
- example: "2011-01-26T19:01:12Z",
704
- },
705
- updated_at: {
706
- type: "string",
707
- format: "date-time",
708
- example: "2011-01-26T19:01:12Z",
709
- },
710
- closed_at: {
711
- type: "string",
712
- format: "date-time",
713
- example: "2011-01-26T19:01:12Z",
714
- nullable: true,
715
- },
716
- merged_at: {
717
- type: "string",
718
- format: "date-time",
719
- example: "2011-01-26T19:01:12Z",
720
- nullable: true,
721
- },
722
- merge_commit_sha: {
723
- type: "string",
724
- example: "e5bd3914e2e596debea16f433f57875b5b90bcd6",
725
- nullable: true,
726
- },
727
- assignee: {
728
- $ref: "#/components/schemas/nullable-simple-user",
729
- },
730
- assignees: {
731
- type: "array",
732
- items: {
733
- $ref: "#/components/schemas/simple-user",
734
- },
735
- nullable: true,
736
- },
737
- requested_reviewers: {
738
- type: "array",
739
- items: {
740
- $ref: "#/components/schemas/simple-user",
741
- },
742
- nullable: true,
743
- },
744
- requested_teams: {
745
- type: "array",
746
- items: {
747
- $ref: "#/components/schemas/team-simple",
748
- },
749
- nullable: true,
750
- },
751
- head: {
752
- type: "object",
753
- properties: {
754
- label: {
755
- type: "string",
756
- },
757
- ref: {
758
- type: "string",
759
- },
760
- repo: {
761
- type: "object",
762
- nullable: true,
763
- properties: {
764
- archive_url: {
765
- type: "string",
766
- },
767
- assignees_url: {
768
- type: "string",
769
- },
770
- blobs_url: {
771
- type: "string",
772
- },
773
- branches_url: {
774
- type: "string",
775
- },
776
- collaborators_url: {
777
- type: "string",
778
- },
779
- comments_url: {
780
- type: "string",
781
- },
782
- commits_url: {
783
- type: "string",
784
- },
785
- compare_url: {
786
- type: "string",
787
- },
788
- contents_url: {
789
- type: "string",
790
- },
791
- contributors_url: {
792
- type: "string",
793
- format: "uri",
794
- },
795
- deployments_url: {
796
- type: "string",
797
- format: "uri",
798
- },
799
- description: {
800
- type: "string",
801
- nullable: true,
802
- },
803
- downloads_url: {
804
- type: "string",
805
- format: "uri",
806
- },
807
- events_url: {
808
- type: "string",
809
- format: "uri",
810
- },
811
- fork: {
812
- type: "boolean",
813
- },
814
- forks_url: {
815
- type: "string",
816
- format: "uri",
817
- },
818
- full_name: {
819
- type: "string",
820
- },
821
- git_commits_url: {
822
- type: "string",
823
- },
824
- git_refs_url: {
825
- type: "string",
826
- },
827
- git_tags_url: {
828
- type: "string",
829
- },
830
- hooks_url: {
831
- type: "string",
832
- format: "uri",
833
- },
834
- html_url: {
835
- type: "string",
836
- format: "uri",
837
- },
838
- id: {
839
- type: "integer",
840
- },
841
- node_id: {
842
- type: "string",
843
- },
844
- issue_comment_url: {
845
- type: "string",
846
- },
847
- issue_events_url: {
848
- type: "string",
849
- },
850
- issues_url: {
851
- type: "string",
852
- },
853
- keys_url: {
854
- type: "string",
855
- },
856
- labels_url: {
857
- type: "string",
858
- },
859
- languages_url: {
860
- type: "string",
861
- format: "uri",
862
- },
863
- merges_url: {
864
- type: "string",
865
- format: "uri",
866
- },
867
- milestones_url: {
868
- type: "string",
869
- },
870
- name: {
871
- type: "string",
872
- },
873
- notifications_url: {
874
- type: "string",
875
- },
876
- owner: {
877
- type: "object",
878
- properties: {
879
- avatar_url: {
880
- type: "string",
881
- format: "uri",
882
- },
883
- events_url: {
884
- type: "string",
885
- },
886
- followers_url: {
887
- type: "string",
888
- format: "uri",
889
- },
890
- following_url: {
891
- type: "string",
892
- },
893
- gists_url: {
894
- type: "string",
895
- },
896
- gravatar_id: {
897
- type: "string",
898
- nullable: true,
899
- },
900
- html_url: {
901
- type: "string",
902
- format: "uri",
903
- },
904
- id: {
905
- type: "integer",
906
- },
907
- node_id: {
908
- type: "string",
909
- },
910
- login: {
911
- type: "string",
912
- },
913
- organizations_url: {
914
- type: "string",
915
- format: "uri",
916
- },
917
- received_events_url: {
918
- type: "string",
919
- format: "uri",
920
- },
921
- repos_url: {
922
- type: "string",
923
- format: "uri",
924
- },
925
- site_admin: {
926
- type: "boolean",
927
- },
928
- starred_url: {
929
- type: "string",
930
- },
931
- subscriptions_url: {
932
- type: "string",
933
- format: "uri",
934
- },
935
- type: {
936
- type: "string",
937
- },
938
- url: {
939
- type: "string",
940
- format: "uri",
941
- },
942
- },
943
- required: [
944
- "avatar_url",
945
- "events_url",
946
- "followers_url",
947
- "following_url",
948
- "gists_url",
949
- "gravatar_id",
950
- "html_url",
951
- "id",
952
- "node_id",
953
- "login",
954
- "organizations_url",
955
- "received_events_url",
956
- "repos_url",
957
- "site_admin",
958
- "starred_url",
959
- "subscriptions_url",
960
- "type",
961
- "url",
962
- ],
963
- },
964
- private: {
965
- type: "boolean",
966
- },
967
- pulls_url: {
968
- type: "string",
969
- },
970
- releases_url: {
971
- type: "string",
972
- },
973
- stargazers_url: {
974
- type: "string",
975
- format: "uri",
976
- },
977
- statuses_url: {
978
- type: "string",
979
- },
980
- subscribers_url: {
981
- type: "string",
982
- format: "uri",
983
- },
984
- subscription_url: {
985
- type: "string",
986
- format: "uri",
987
- },
988
- tags_url: {
989
- type: "string",
990
- format: "uri",
991
- },
992
- teams_url: {
993
- type: "string",
994
- format: "uri",
995
- },
996
- trees_url: {
997
- type: "string",
998
- },
999
- url: {
1000
- type: "string",
1001
- format: "uri",
1002
- },
1003
- clone_url: {
1004
- type: "string",
1005
- },
1006
- default_branch: {
1007
- type: "string",
1008
- },
1009
- forks: {
1010
- type: "integer",
1011
- },
1012
- forks_count: {
1013
- type: "integer",
1014
- },
1015
- git_url: {
1016
- type: "string",
1017
- },
1018
- has_downloads: {
1019
- type: "boolean",
1020
- },
1021
- has_issues: {
1022
- type: "boolean",
1023
- },
1024
- has_projects: {
1025
- type: "boolean",
1026
- },
1027
- has_wiki: {
1028
- type: "boolean",
1029
- },
1030
- has_pages: {
1031
- type: "boolean",
1032
- },
1033
- has_discussions: {
1034
- type: "boolean",
1035
- },
1036
- homepage: {
1037
- type: "string",
1038
- format: "uri",
1039
- nullable: true,
1040
- },
1041
- language: {
1042
- type: "string",
1043
- nullable: true,
1044
- },
1045
- master_branch: {
1046
- type: "string",
1047
- },
1048
- archived: {
1049
- type: "boolean",
1050
- },
1051
- disabled: {
1052
- type: "boolean",
1053
- },
1054
- visibility: {
1055
- description: "The repository visibility: public, private, or internal.",
1056
- type: "string",
1057
- },
1058
- mirror_url: {
1059
- type: "string",
1060
- format: "uri",
1061
- nullable: true,
1062
- },
1063
- open_issues: {
1064
- type: "integer",
1065
- },
1066
- open_issues_count: {
1067
- type: "integer",
1068
- },
1069
- permissions: {
1070
- type: "object",
1071
- properties: {
1072
- admin: {
1073
- type: "boolean",
1074
- },
1075
- maintain: {
1076
- type: "boolean",
1077
- },
1078
- push: {
1079
- type: "boolean",
1080
- },
1081
- triage: {
1082
- type: "boolean",
1083
- },
1084
- pull: {
1085
- type: "boolean",
1086
- },
1087
- },
1088
- required: ["admin", "pull", "push"],
1089
- },
1090
- temp_clone_token: {
1091
- type: "string",
1092
- },
1093
- allow_merge_commit: {
1094
- type: "boolean",
1095
- },
1096
- allow_squash_merge: {
1097
- type: "boolean",
1098
- },
1099
- allow_rebase_merge: {
1100
- type: "boolean",
1101
- },
1102
- license: {
1103
- type: "object",
1104
- properties: {
1105
- key: {
1106
- type: "string",
1107
- },
1108
- name: {
1109
- type: "string",
1110
- },
1111
- url: {
1112
- type: "string",
1113
- format: "uri",
1114
- nullable: true,
1115
- },
1116
- spdx_id: {
1117
- type: "string",
1118
- nullable: true,
1119
- },
1120
- node_id: {
1121
- type: "string",
1122
- },
1123
- },
1124
- required: [
1125
- "key",
1126
- "name",
1127
- "url",
1128
- "spdx_id",
1129
- "node_id",
1130
- ],
1131
- nullable: true,
1132
- },
1133
- pushed_at: {
1134
- type: "string",
1135
- format: "date-time",
1136
- },
1137
- size: {
1138
- type: "integer",
1139
- },
1140
- ssh_url: {
1141
- type: "string",
1142
- },
1143
- stargazers_count: {
1144
- type: "integer",
1145
- },
1146
- svn_url: {
1147
- type: "string",
1148
- format: "uri",
1149
- },
1150
- topics: {
1151
- type: "array",
1152
- items: {
1153
- type: "string",
1154
- },
1155
- },
1156
- watchers: {
1157
- type: "integer",
1158
- },
1159
- watchers_count: {
1160
- type: "integer",
1161
- },
1162
- created_at: {
1163
- type: "string",
1164
- format: "date-time",
1165
- },
1166
- updated_at: {
1167
- type: "string",
1168
- format: "date-time",
1169
- },
1170
- allow_forking: {
1171
- type: "boolean",
1172
- },
1173
- is_template: {
1174
- type: "boolean",
1175
- },
1176
- web_commit_signoff_required: {
1177
- type: "boolean",
1178
- },
1179
- },
1180
- required: [
1181
- "archive_url",
1182
- "assignees_url",
1183
- "blobs_url",
1184
- "branches_url",
1185
- "collaborators_url",
1186
- "comments_url",
1187
- "commits_url",
1188
- "compare_url",
1189
- "contents_url",
1190
- "contributors_url",
1191
- "deployments_url",
1192
- "description",
1193
- "downloads_url",
1194
- "events_url",
1195
- "fork",
1196
- "forks_url",
1197
- "full_name",
1198
- "git_commits_url",
1199
- "git_refs_url",
1200
- "git_tags_url",
1201
- "hooks_url",
1202
- "html_url",
1203
- "id",
1204
- "node_id",
1205
- "issue_comment_url",
1206
- "issue_events_url",
1207
- "issues_url",
1208
- "keys_url",
1209
- "labels_url",
1210
- "languages_url",
1211
- "merges_url",
1212
- "milestones_url",
1213
- "name",
1214
- "notifications_url",
1215
- "owner",
1216
- "private",
1217
- "pulls_url",
1218
- "releases_url",
1219
- "stargazers_url",
1220
- "statuses_url",
1221
- "subscribers_url",
1222
- "subscription_url",
1223
- "tags_url",
1224
- "teams_url",
1225
- "trees_url",
1226
- "url",
1227
- "clone_url",
1228
- "default_branch",
1229
- "forks",
1230
- "forks_count",
1231
- "git_url",
1232
- "has_downloads",
1233
- "has_issues",
1234
- "has_projects",
1235
- "has_wiki",
1236
- "has_pages",
1237
- "has_discussions",
1238
- "homepage",
1239
- "language",
1240
- "archived",
1241
- "disabled",
1242
- "mirror_url",
1243
- "open_issues",
1244
- "open_issues_count",
1245
- "license",
1246
- "pushed_at",
1247
- "size",
1248
- "ssh_url",
1249
- "stargazers_count",
1250
- "svn_url",
1251
- "watchers",
1252
- "watchers_count",
1253
- "created_at",
1254
- "updated_at",
1255
- ],
1256
- },
1257
- sha: {
1258
- type: "string",
1259
- },
1260
- user: {
1261
- type: "object",
1262
- properties: {
1263
- avatar_url: {
1264
- type: "string",
1265
- format: "uri",
1266
- },
1267
- events_url: {
1268
- type: "string",
1269
- },
1270
- followers_url: {
1271
- type: "string",
1272
- format: "uri",
1273
- },
1274
- following_url: {
1275
- type: "string",
1276
- },
1277
- gists_url: {
1278
- type: "string",
1279
- },
1280
- gravatar_id: {
1281
- type: "string",
1282
- nullable: true,
1283
- },
1284
- html_url: {
1285
- type: "string",
1286
- format: "uri",
1287
- },
1288
- id: {
1289
- type: "integer",
1290
- },
1291
- node_id: {
1292
- type: "string",
1293
- },
1294
- login: {
1295
- type: "string",
1296
- },
1297
- organizations_url: {
1298
- type: "string",
1299
- format: "uri",
1300
- },
1301
- received_events_url: {
1302
- type: "string",
1303
- format: "uri",
1304
- },
1305
- repos_url: {
1306
- type: "string",
1307
- format: "uri",
1308
- },
1309
- site_admin: {
1310
- type: "boolean",
1311
- },
1312
- starred_url: {
1313
- type: "string",
1314
- },
1315
- subscriptions_url: {
1316
- type: "string",
1317
- format: "uri",
1318
- },
1319
- type: {
1320
- type: "string",
1321
- },
1322
- url: {
1323
- type: "string",
1324
- format: "uri",
1325
- },
1326
- },
1327
- required: [
1328
- "avatar_url",
1329
- "events_url",
1330
- "followers_url",
1331
- "following_url",
1332
- "gists_url",
1333
- "gravatar_id",
1334
- "html_url",
1335
- "id",
1336
- "node_id",
1337
- "login",
1338
- "organizations_url",
1339
- "received_events_url",
1340
- "repos_url",
1341
- "site_admin",
1342
- "starred_url",
1343
- "subscriptions_url",
1344
- "type",
1345
- "url",
1346
- ],
1347
- },
1348
- },
1349
- required: ["label", "ref", "repo", "sha", "user"],
1350
- },
1351
- base: {
1352
- type: "object",
1353
- properties: {
1354
- label: {
1355
- type: "string",
1356
- },
1357
- ref: {
1358
- type: "string",
1359
- },
1360
- repo: {
1361
- type: "object",
1362
- properties: {
1363
- archive_url: {
1364
- type: "string",
1365
- },
1366
- assignees_url: {
1367
- type: "string",
1368
- },
1369
- blobs_url: {
1370
- type: "string",
1371
- },
1372
- branches_url: {
1373
- type: "string",
1374
- },
1375
- collaborators_url: {
1376
- type: "string",
1377
- },
1378
- comments_url: {
1379
- type: "string",
1380
- },
1381
- commits_url: {
1382
- type: "string",
1383
- },
1384
- compare_url: {
1385
- type: "string",
1386
- },
1387
- contents_url: {
1388
- type: "string",
1389
- },
1390
- contributors_url: {
1391
- type: "string",
1392
- format: "uri",
1393
- },
1394
- deployments_url: {
1395
- type: "string",
1396
- format: "uri",
1397
- },
1398
- description: {
1399
- type: "string",
1400
- nullable: true,
1401
- },
1402
- downloads_url: {
1403
- type: "string",
1404
- format: "uri",
1405
- },
1406
- events_url: {
1407
- type: "string",
1408
- format: "uri",
1409
- },
1410
- fork: {
1411
- type: "boolean",
1412
- },
1413
- forks_url: {
1414
- type: "string",
1415
- format: "uri",
1416
- },
1417
- full_name: {
1418
- type: "string",
1419
- },
1420
- git_commits_url: {
1421
- type: "string",
1422
- },
1423
- git_refs_url: {
1424
- type: "string",
1425
- },
1426
- git_tags_url: {
1427
- type: "string",
1428
- },
1429
- hooks_url: {
1430
- type: "string",
1431
- format: "uri",
1432
- },
1433
- html_url: {
1434
- type: "string",
1435
- format: "uri",
1436
- },
1437
- id: {
1438
- type: "integer",
1439
- },
1440
- is_template: {
1441
- type: "boolean",
1442
- },
1443
- node_id: {
1444
- type: "string",
1445
- },
1446
- issue_comment_url: {
1447
- type: "string",
1448
- },
1449
- issue_events_url: {
1450
- type: "string",
1451
- },
1452
- issues_url: {
1453
- type: "string",
1454
- },
1455
- keys_url: {
1456
- type: "string",
1457
- },
1458
- labels_url: {
1459
- type: "string",
1460
- },
1461
- languages_url: {
1462
- type: "string",
1463
- format: "uri",
1464
- },
1465
- merges_url: {
1466
- type: "string",
1467
- format: "uri",
1468
- },
1469
- milestones_url: {
1470
- type: "string",
1471
- },
1472
- name: {
1473
- type: "string",
1474
- },
1475
- notifications_url: {
1476
- type: "string",
1477
- },
1478
- owner: {
1479
- type: "object",
1480
- properties: {
1481
- avatar_url: {
1482
- type: "string",
1483
- format: "uri",
1484
- },
1485
- events_url: {
1486
- type: "string",
1487
- },
1488
- followers_url: {
1489
- type: "string",
1490
- format: "uri",
1491
- },
1492
- following_url: {
1493
- type: "string",
1494
- },
1495
- gists_url: {
1496
- type: "string",
1497
- },
1498
- gravatar_id: {
1499
- type: "string",
1500
- nullable: true,
1501
- },
1502
- html_url: {
1503
- type: "string",
1504
- format: "uri",
1505
- },
1506
- id: {
1507
- type: "integer",
1508
- },
1509
- node_id: {
1510
- type: "string",
1511
- },
1512
- login: {
1513
- type: "string",
1514
- },
1515
- organizations_url: {
1516
- type: "string",
1517
- format: "uri",
1518
- },
1519
- received_events_url: {
1520
- type: "string",
1521
- format: "uri",
1522
- },
1523
- repos_url: {
1524
- type: "string",
1525
- format: "uri",
1526
- },
1527
- site_admin: {
1528
- type: "boolean",
1529
- },
1530
- starred_url: {
1531
- type: "string",
1532
- },
1533
- subscriptions_url: {
1534
- type: "string",
1535
- format: "uri",
1536
- },
1537
- type: {
1538
- type: "string",
1539
- },
1540
- url: {
1541
- type: "string",
1542
- format: "uri",
1543
- },
1544
- },
1545
- required: [
1546
- "avatar_url",
1547
- "events_url",
1548
- "followers_url",
1549
- "following_url",
1550
- "gists_url",
1551
- "gravatar_id",
1552
- "html_url",
1553
- "id",
1554
- "node_id",
1555
- "login",
1556
- "organizations_url",
1557
- "received_events_url",
1558
- "repos_url",
1559
- "site_admin",
1560
- "starred_url",
1561
- "subscriptions_url",
1562
- "type",
1563
- "url",
1564
- ],
1565
- },
1566
- private: {
1567
- type: "boolean",
1568
- },
1569
- pulls_url: {
1570
- type: "string",
1571
- },
1572
- releases_url: {
1573
- type: "string",
1574
- },
1575
- stargazers_url: {
1576
- type: "string",
1577
- format: "uri",
1578
- },
1579
- statuses_url: {
1580
- type: "string",
1581
- },
1582
- subscribers_url: {
1583
- type: "string",
1584
- format: "uri",
1585
- },
1586
- subscription_url: {
1587
- type: "string",
1588
- format: "uri",
1589
- },
1590
- tags_url: {
1591
- type: "string",
1592
- format: "uri",
1593
- },
1594
- teams_url: {
1595
- type: "string",
1596
- format: "uri",
1597
- },
1598
- trees_url: {
1599
- type: "string",
1600
- },
1601
- url: {
1602
- type: "string",
1603
- format: "uri",
1604
- },
1605
- clone_url: {
1606
- type: "string",
1607
- },
1608
- default_branch: {
1609
- type: "string",
1610
- },
1611
- forks: {
1612
- type: "integer",
1613
- },
1614
- forks_count: {
1615
- type: "integer",
1616
- },
1617
- git_url: {
1618
- type: "string",
1619
- },
1620
- has_downloads: {
1621
- type: "boolean",
1622
- },
1623
- has_issues: {
1624
- type: "boolean",
1625
- },
1626
- has_projects: {
1627
- type: "boolean",
1628
- },
1629
- has_wiki: {
1630
- type: "boolean",
1631
- },
1632
- has_pages: {
1633
- type: "boolean",
1634
- },
1635
- has_discussions: {
1636
- type: "boolean",
1637
- },
1638
- homepage: {
1639
- type: "string",
1640
- format: "uri",
1641
- nullable: true,
1642
- },
1643
- language: {
1644
- type: "string",
1645
- nullable: true,
1646
- },
1647
- master_branch: {
1648
- type: "string",
1649
- },
1650
- archived: {
1651
- type: "boolean",
1652
- },
1653
- disabled: {
1654
- type: "boolean",
1655
- },
1656
- visibility: {
1657
- description: "The repository visibility: public, private, or internal.",
1658
- type: "string",
1659
- },
1660
- mirror_url: {
1661
- type: "string",
1662
- format: "uri",
1663
- nullable: true,
1664
- },
1665
- open_issues: {
1666
- type: "integer",
1667
- },
1668
- open_issues_count: {
1669
- type: "integer",
1670
- },
1671
- permissions: {
1672
- type: "object",
1673
- properties: {
1674
- admin: {
1675
- type: "boolean",
1676
- },
1677
- maintain: {
1678
- type: "boolean",
1679
- },
1680
- push: {
1681
- type: "boolean",
1682
- },
1683
- triage: {
1684
- type: "boolean",
1685
- },
1686
- pull: {
1687
- type: "boolean",
1688
- },
1689
- },
1690
- required: ["admin", "pull", "push"],
1691
- },
1692
- temp_clone_token: {
1693
- type: "string",
1694
- },
1695
- allow_merge_commit: {
1696
- type: "boolean",
1697
- },
1698
- allow_squash_merge: {
1699
- type: "boolean",
1700
- },
1701
- allow_rebase_merge: {
1702
- type: "boolean",
1703
- },
1704
- license: {
1705
- $ref: "#/components/schemas/nullable-license-simple",
1706
- },
1707
- pushed_at: {
1708
- type: "string",
1709
- format: "date-time",
1710
- },
1711
- size: {
1712
- type: "integer",
1713
- },
1714
- ssh_url: {
1715
- type: "string",
1716
- },
1717
- stargazers_count: {
1718
- type: "integer",
1719
- },
1720
- svn_url: {
1721
- type: "string",
1722
- format: "uri",
1723
- },
1724
- topics: {
1725
- type: "array",
1726
- items: {
1727
- type: "string",
1728
- },
1729
- },
1730
- watchers: {
1731
- type: "integer",
1732
- },
1733
- watchers_count: {
1734
- type: "integer",
1735
- },
1736
- created_at: {
1737
- type: "string",
1738
- format: "date-time",
1739
- },
1740
- updated_at: {
1741
- type: "string",
1742
- format: "date-time",
1743
- },
1744
- allow_forking: {
1745
- type: "boolean",
1746
- },
1747
- web_commit_signoff_required: {
1748
- type: "boolean",
1749
- },
1750
- },
1751
- required: [
1752
- "archive_url",
1753
- "assignees_url",
1754
- "blobs_url",
1755
- "branches_url",
1756
- "collaborators_url",
1757
- "comments_url",
1758
- "commits_url",
1759
- "compare_url",
1760
- "contents_url",
1761
- "contributors_url",
1762
- "deployments_url",
1763
- "description",
1764
- "downloads_url",
1765
- "events_url",
1766
- "fork",
1767
- "forks_url",
1768
- "full_name",
1769
- "git_commits_url",
1770
- "git_refs_url",
1771
- "git_tags_url",
1772
- "hooks_url",
1773
- "html_url",
1774
- "id",
1775
- "node_id",
1776
- "issue_comment_url",
1777
- "issue_events_url",
1778
- "issues_url",
1779
- "keys_url",
1780
- "labels_url",
1781
- "languages_url",
1782
- "merges_url",
1783
- "milestones_url",
1784
- "name",
1785
- "notifications_url",
1786
- "owner",
1787
- "private",
1788
- "pulls_url",
1789
- "releases_url",
1790
- "stargazers_url",
1791
- "statuses_url",
1792
- "subscribers_url",
1793
- "subscription_url",
1794
- "tags_url",
1795
- "teams_url",
1796
- "trees_url",
1797
- "url",
1798
- "clone_url",
1799
- "default_branch",
1800
- "forks",
1801
- "forks_count",
1802
- "git_url",
1803
- "has_downloads",
1804
- "has_issues",
1805
- "has_projects",
1806
- "has_wiki",
1807
- "has_pages",
1808
- "has_discussions",
1809
- "homepage",
1810
- "language",
1811
- "archived",
1812
- "disabled",
1813
- "mirror_url",
1814
- "open_issues",
1815
- "open_issues_count",
1816
- "license",
1817
- "pushed_at",
1818
- "size",
1819
- "ssh_url",
1820
- "stargazers_count",
1821
- "svn_url",
1822
- "watchers",
1823
- "watchers_count",
1824
- "created_at",
1825
- "updated_at",
1826
- ],
1827
- },
1828
- sha: {
1829
- type: "string",
1830
- },
1831
- user: {
1832
- type: "object",
1833
- properties: {
1834
- avatar_url: {
1835
- type: "string",
1836
- format: "uri",
1837
- },
1838
- events_url: {
1839
- type: "string",
1840
- },
1841
- followers_url: {
1842
- type: "string",
1843
- format: "uri",
1844
- },
1845
- following_url: {
1846
- type: "string",
1847
- },
1848
- gists_url: {
1849
- type: "string",
1850
- },
1851
- gravatar_id: {
1852
- type: "string",
1853
- nullable: true,
1854
- },
1855
- html_url: {
1856
- type: "string",
1857
- format: "uri",
1858
- },
1859
- id: {
1860
- type: "integer",
1861
- },
1862
- node_id: {
1863
- type: "string",
1864
- },
1865
- login: {
1866
- type: "string",
1867
- },
1868
- organizations_url: {
1869
- type: "string",
1870
- format: "uri",
1871
- },
1872
- received_events_url: {
1873
- type: "string",
1874
- format: "uri",
1875
- },
1876
- repos_url: {
1877
- type: "string",
1878
- format: "uri",
1879
- },
1880
- site_admin: {
1881
- type: "boolean",
1882
- },
1883
- starred_url: {
1884
- type: "string",
1885
- },
1886
- subscriptions_url: {
1887
- type: "string",
1888
- format: "uri",
1889
- },
1890
- type: {
1891
- type: "string",
1892
- },
1893
- url: {
1894
- type: "string",
1895
- format: "uri",
1896
- },
1897
- },
1898
- required: [
1899
- "avatar_url",
1900
- "events_url",
1901
- "followers_url",
1902
- "following_url",
1903
- "gists_url",
1904
- "gravatar_id",
1905
- "html_url",
1906
- "id",
1907
- "node_id",
1908
- "login",
1909
- "organizations_url",
1910
- "received_events_url",
1911
- "repos_url",
1912
- "site_admin",
1913
- "starred_url",
1914
- "subscriptions_url",
1915
- "type",
1916
- "url",
1917
- ],
1918
- },
1919
- },
1920
- required: ["label", "ref", "repo", "sha", "user"],
1921
- },
1922
- _links: {
1923
- type: "object",
1924
- properties: {
1925
- comments: {
1926
- $ref: "#/components/schemas/link",
1927
- },
1928
- commits: {
1929
- $ref: "#/components/schemas/link",
1930
- },
1931
- statuses: {
1932
- $ref: "#/components/schemas/link",
1933
- },
1934
- html: {
1935
- $ref: "#/components/schemas/link",
1936
- },
1937
- issue: {
1938
- $ref: "#/components/schemas/link",
1939
- },
1940
- review_comments: {
1941
- $ref: "#/components/schemas/link",
1942
- },
1943
- review_comment: {
1944
- $ref: "#/components/schemas/link",
1945
- },
1946
- self: {
1947
- $ref: "#/components/schemas/link",
1948
- },
1949
- },
1950
- required: [
1951
- "comments",
1952
- "commits",
1953
- "statuses",
1954
- "html",
1955
- "issue",
1956
- "review_comments",
1957
- "review_comment",
1958
- "self",
1959
- ],
1960
- },
1961
- author_association: {
1962
- $ref: "#/components/schemas/author-association",
1963
- },
1964
- auto_merge: {
1965
- $ref: "#/components/schemas/auto-merge",
1966
- },
1967
- draft: {
1968
- description: "Indicates whether or not the pull request is a draft.",
1969
- example: false,
1970
- type: "boolean",
1971
- },
1972
- merged: {
1973
- type: "boolean",
1974
- },
1975
- mergeable: {
1976
- type: "boolean",
1977
- example: true,
1978
- nullable: true,
1979
- },
1980
- rebaseable: {
1981
- type: "boolean",
1982
- example: true,
1983
- nullable: true,
1984
- },
1985
- mergeable_state: {
1986
- type: "string",
1987
- example: "clean",
1988
- },
1989
- merged_by: {
1990
- $ref: "#/components/schemas/nullable-simple-user",
1991
- },
1992
- comments: {
1993
- type: "integer",
1994
- example: 10,
1995
- },
1996
- review_comments: {
1997
- type: "integer",
1998
- example: 0,
1999
- },
2000
- maintainer_can_modify: {
2001
- description: "Indicates whether maintainers can modify the pull request.",
2002
- example: true,
2003
- type: "boolean",
2004
- },
2005
- commits: {
2006
- type: "integer",
2007
- example: 3,
2008
- },
2009
- additions: {
2010
- type: "integer",
2011
- example: 100,
2012
- },
2013
- deletions: {
2014
- type: "integer",
2015
- example: 3,
2016
- },
2017
- changed_files: {
2018
- type: "integer",
2019
- example: 5,
2020
- },
2021
- },
2022
- required: [
2023
- "_links",
2024
- "assignee",
2025
- "labels",
2026
- "base",
2027
- "body",
2028
- "closed_at",
2029
- "comments_url",
2030
- "commits_url",
2031
- "created_at",
2032
- "diff_url",
2033
- "head",
2034
- "html_url",
2035
- "id",
2036
- "node_id",
2037
- "issue_url",
2038
- "merge_commit_sha",
2039
- "merged_at",
2040
- "milestone",
2041
- "number",
2042
- "patch_url",
2043
- "review_comment_url",
2044
- "review_comments_url",
2045
- "statuses_url",
2046
- "state",
2047
- "locked",
2048
- "title",
2049
- "updated_at",
2050
- "url",
2051
- "user",
2052
- "author_association",
2053
- "auto_merge",
2054
- "additions",
2055
- "changed_files",
2056
- "comments",
2057
- "commits",
2058
- "deletions",
2059
- "mergeable",
2060
- "mergeable_state",
2061
- "merged",
2062
- "maintainer_can_modify",
2063
- "merged_by",
2064
- "review_comments",
2065
- ],
2066
- },
2067
- "team-simple": {
2068
- title: "Team Simple",
2069
- description: "Groups of organization members that gives permissions on specified repositories.",
2070
- type: "object",
2071
- properties: {
2072
- id: {
2073
- description: "Unique identifier of the team",
2074
- type: "integer",
2075
- example: 1,
2076
- },
2077
- node_id: {
2078
- type: "string",
2079
- example: "MDQ6VGVhbTE=",
2080
- },
2081
- url: {
2082
- description: "URL for the team",
2083
- type: "string",
2084
- format: "uri",
2085
- example: "https://api.github.com/organizations/1/team/1",
2086
- },
2087
- members_url: {
2088
- type: "string",
2089
- example: "https://api.github.com/organizations/1/team/1/members{/member}",
2090
- },
2091
- name: {
2092
- description: "Name of the team",
2093
- type: "string",
2094
- example: "Justice League",
2095
- },
2096
- description: {
2097
- description: "Description of the team",
2098
- type: "string",
2099
- nullable: true,
2100
- example: "A great team.",
2101
- },
2102
- permission: {
2103
- description: "Permission that the team will have for its repositories",
2104
- type: "string",
2105
- example: "admin",
2106
- },
2107
- privacy: {
2108
- description: "The level of privacy this team should have",
2109
- type: "string",
2110
- example: "closed",
2111
- },
2112
- notification_setting: {
2113
- description: "The notification setting the team has set",
2114
- type: "string",
2115
- example: "notifications_enabled",
2116
- },
2117
- html_url: {
2118
- type: "string",
2119
- format: "uri",
2120
- example: "https://github.com/orgs/rails/teams/core",
2121
- },
2122
- repositories_url: {
2123
- type: "string",
2124
- format: "uri",
2125
- example: "https://api.github.com/organizations/1/team/1/repos",
2126
- },
2127
- slug: {
2128
- type: "string",
2129
- example: "justice-league",
2130
- },
2131
- ldap_dn: {
2132
- description: "Distinguished Name (DN) that team maps to within LDAP environment",
2133
- example: "uid=example,ou=users,dc=github,dc=com",
2134
- type: "string",
2135
- },
2136
- },
2137
- required: [
2138
- "id",
2139
- "node_id",
2140
- "url",
2141
- "members_url",
2142
- "name",
2143
- "description",
2144
- "permission",
2145
- "html_url",
2146
- "repositories_url",
2147
- "slug",
2148
- ],
2149
- },
2150
- "author-association": {
2151
- title: "author_association",
2152
- type: "string",
2153
- example: "OWNER",
2154
- description: "How the author is associated with the repository.",
2155
- enum: [
2156
- "COLLABORATOR",
2157
- "CONTRIBUTOR",
2158
- "FIRST_TIMER",
2159
- "FIRST_TIME_CONTRIBUTOR",
2160
- "MANNEQUIN",
2161
- "MEMBER",
2162
- "NONE",
2163
- "OWNER",
2164
- ],
2165
- },
2166
- "auto-merge": {
2167
- title: "Auto merge",
2168
- description: "The status of auto merging a pull request.",
2169
- type: "object",
2170
- properties: {
2171
- enabled_by: {
2172
- $ref: "#/components/schemas/simple-user",
2173
- },
2174
- merge_method: {
2175
- type: "string",
2176
- description: "The merge method to use.",
2177
- enum: ["merge", "squash", "rebase"],
2178
- },
2179
- commit_title: {
2180
- type: "string",
2181
- description: "Title for the merge commit message.",
2182
- },
2183
- commit_message: {
2184
- type: "string",
2185
- description: "Commit message for the merge commit.",
2186
- },
2187
- },
2188
- required: [
2189
- "enabled_by",
2190
- "merge_method",
2191
- "commit_title",
2192
- "commit_message",
2193
- ],
2194
- nullable: true,
2195
- },
2196
- "pull-request-merge-result": {
2197
- title: "Pull Request Merge Result",
2198
- description: "Pull Request Merge Result",
2199
- type: "object",
2200
- properties: {
2201
- sha: {
2202
- type: "string",
2203
- },
2204
- merged: {
2205
- type: "boolean",
2206
- },
2207
- message: {
2208
- type: "string",
2209
- },
2210
- },
2211
- required: ["merged", "message", "sha"],
2212
- },
2213
- "pull-request-review-request": {
2214
- title: "Pull Request Review Request",
2215
- description: "Pull Request Review Request",
2216
- type: "object",
2217
- properties: {
2218
- users: {
2219
- type: "array",
2220
- items: {
2221
- $ref: "#/components/schemas/simple-user",
2222
- },
2223
- },
2224
- teams: {
2225
- type: "array",
2226
- items: {
2227
- $ref: "#/components/schemas/team",
2228
- },
2229
- },
2230
- },
2231
- required: ["users", "teams"],
2232
- },
2233
- "pull-request-simple": {
2234
- title: "Pull Request Simple",
2235
- description: "Pull Request Simple",
2236
- type: "object",
2237
- properties: {
2238
- url: {
2239
- type: "string",
2240
- format: "uri",
2241
- example: "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
2242
- },
2243
- id: {
2244
- type: "integer",
2245
- example: 1,
2246
- },
2247
- node_id: {
2248
- type: "string",
2249
- example: "MDExOlB1bGxSZXF1ZXN0MQ==",
2250
- },
2251
- html_url: {
2252
- type: "string",
2253
- format: "uri",
2254
- example: "https://github.com/octocat/Hello-World/pull/1347",
2255
- },
2256
- diff_url: {
2257
- type: "string",
2258
- format: "uri",
2259
- example: "https://github.com/octocat/Hello-World/pull/1347.diff",
2260
- },
2261
- patch_url: {
2262
- type: "string",
2263
- format: "uri",
2264
- example: "https://github.com/octocat/Hello-World/pull/1347.patch",
2265
- },
2266
- issue_url: {
2267
- type: "string",
2268
- format: "uri",
2269
- example: "https://api.github.com/repos/octocat/Hello-World/issues/1347",
2270
- },
2271
- commits_url: {
2272
- type: "string",
2273
- format: "uri",
2274
- example: "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits",
2275
- },
2276
- review_comments_url: {
2277
- type: "string",
2278
- format: "uri",
2279
- example: "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments",
2280
- },
2281
- review_comment_url: {
2282
- type: "string",
2283
- example: "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}",
2284
- },
2285
- comments_url: {
2286
- type: "string",
2287
- format: "uri",
2288
- example: "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
2289
- },
2290
- statuses_url: {
2291
- type: "string",
2292
- format: "uri",
2293
- example: "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
2294
- },
2295
- number: {
2296
- type: "integer",
2297
- example: 1347,
2298
- },
2299
- state: {
2300
- type: "string",
2301
- example: "open",
2302
- },
2303
- locked: {
2304
- type: "boolean",
2305
- example: true,
2306
- },
2307
- title: {
2308
- type: "string",
2309
- example: "new-feature",
2310
- },
2311
- user: {
2312
- $ref: "#/components/schemas/nullable-simple-user",
2313
- },
2314
- body: {
2315
- type: "string",
2316
- example: "Please pull these awesome changes",
2317
- nullable: true,
2318
- },
2319
- labels: {
2320
- type: "array",
2321
- items: {
2322
- type: "object",
2323
- properties: {
2324
- id: {
2325
- type: "integer",
2326
- format: "int64",
2327
- },
2328
- node_id: {
2329
- type: "string",
2330
- },
2331
- url: {
2332
- type: "string",
2333
- },
2334
- name: {
2335
- type: "string",
2336
- },
2337
- description: {
2338
- type: "string",
2339
- },
2340
- color: {
2341
- type: "string",
2342
- },
2343
- default: {
2344
- type: "boolean",
2345
- },
2346
- },
2347
- required: [
2348
- "id",
2349
- "node_id",
2350
- "url",
2351
- "name",
2352
- "description",
2353
- "color",
2354
- "default",
2355
- ],
2356
- },
2357
- },
2358
- milestone: {
2359
- $ref: "#/components/schemas/nullable-milestone",
2360
- },
2361
- active_lock_reason: {
2362
- type: "string",
2363
- example: "too heated",
2364
- nullable: true,
2365
- },
2366
- created_at: {
2367
- type: "string",
2368
- format: "date-time",
2369
- example: "2011-01-26T19:01:12Z",
2370
- },
2371
- updated_at: {
2372
- type: "string",
2373
- format: "date-time",
2374
- example: "2011-01-26T19:01:12Z",
2375
- },
2376
- closed_at: {
2377
- type: "string",
2378
- format: "date-time",
2379
- example: "2011-01-26T19:01:12Z",
2380
- nullable: true,
2381
- },
2382
- merged_at: {
2383
- type: "string",
2384
- format: "date-time",
2385
- example: "2011-01-26T19:01:12Z",
2386
- nullable: true,
2387
- },
2388
- merge_commit_sha: {
2389
- type: "string",
2390
- example: "e5bd3914e2e596debea16f433f57875b5b90bcd6",
2391
- nullable: true,
2392
- },
2393
- assignee: {
2394
- $ref: "#/components/schemas/nullable-simple-user",
2395
- },
2396
- assignees: {
2397
- type: "array",
2398
- items: {
2399
- $ref: "#/components/schemas/simple-user",
2400
- },
2401
- nullable: true,
2402
- },
2403
- requested_reviewers: {
2404
- type: "array",
2405
- items: {
2406
- $ref: "#/components/schemas/simple-user",
2407
- },
2408
- nullable: true,
2409
- },
2410
- requested_teams: {
2411
- type: "array",
2412
- items: {
2413
- $ref: "#/components/schemas/team",
2414
- },
2415
- nullable: true,
2416
- },
2417
- head: {
2418
- type: "object",
2419
- properties: {
2420
- label: {
2421
- type: "string",
2422
- },
2423
- ref: {
2424
- type: "string",
2425
- },
2426
- repo: {
2427
- $ref: "#/components/schemas/repository",
2428
- },
2429
- sha: {
2430
- type: "string",
2431
- },
2432
- user: {
2433
- $ref: "#/components/schemas/nullable-simple-user",
2434
- },
2435
- },
2436
- required: ["label", "ref", "repo", "sha", "user"],
2437
- },
2438
- base: {
2439
- type: "object",
2440
- properties: {
2441
- label: {
2442
- type: "string",
2443
- },
2444
- ref: {
2445
- type: "string",
2446
- },
2447
- repo: {
2448
- $ref: "#/components/schemas/repository",
2449
- },
2450
- sha: {
2451
- type: "string",
2452
- },
2453
- user: {
2454
- $ref: "#/components/schemas/nullable-simple-user",
2455
- },
2456
- },
2457
- required: ["label", "ref", "repo", "sha", "user"],
2458
- },
2459
- _links: {
2460
- type: "object",
2461
- properties: {
2462
- comments: {
2463
- $ref: "#/components/schemas/link",
2464
- },
2465
- commits: {
2466
- $ref: "#/components/schemas/link",
2467
- },
2468
- statuses: {
2469
- $ref: "#/components/schemas/link",
2470
- },
2471
- html: {
2472
- $ref: "#/components/schemas/link",
2473
- },
2474
- issue: {
2475
- $ref: "#/components/schemas/link",
2476
- },
2477
- review_comments: {
2478
- $ref: "#/components/schemas/link",
2479
- },
2480
- review_comment: {
2481
- $ref: "#/components/schemas/link",
2482
- },
2483
- self: {
2484
- $ref: "#/components/schemas/link",
2485
- },
2486
- },
2487
- required: [
2488
- "comments",
2489
- "commits",
2490
- "statuses",
2491
- "html",
2492
- "issue",
2493
- "review_comments",
2494
- "review_comment",
2495
- "self",
2496
- ],
2497
- },
2498
- author_association: {
2499
- $ref: "#/components/schemas/author-association",
2500
- },
2501
- auto_merge: {
2502
- $ref: "#/components/schemas/auto-merge",
2503
- },
2504
- draft: {
2505
- description: "Indicates whether or not the pull request is a draft.",
2506
- example: false,
2507
- type: "boolean",
2508
- },
2509
- },
2510
- required: [
2511
- "_links",
2512
- "assignee",
2513
- "labels",
2514
- "base",
2515
- "body",
2516
- "closed_at",
2517
- "comments_url",
2518
- "commits_url",
2519
- "created_at",
2520
- "diff_url",
2521
- "head",
2522
- "html_url",
2523
- "id",
2524
- "node_id",
2525
- "issue_url",
2526
- "merge_commit_sha",
2527
- "merged_at",
2528
- "milestone",
2529
- "number",
2530
- "patch_url",
2531
- "review_comment_url",
2532
- "review_comments_url",
2533
- "statuses_url",
2534
- "state",
2535
- "locked",
2536
- "title",
2537
- "updated_at",
2538
- "url",
2539
- "user",
2540
- "author_association",
2541
- "auto_merge",
2542
- ],
2543
- },
2544
- "basic-error": {
2545
- title: "Basic Error",
2546
- description: "Basic Error",
2547
- type: "object",
2548
- properties: {
2549
- message: {
2550
- type: "string",
2551
- },
2552
- documentation_url: {
2553
- type: "string",
2554
- },
2555
- url: {
2556
- type: "string",
2557
- },
2558
- status: {
2559
- type: "string",
2560
- },
2561
- },
2562
- },
2563
- },
2564
- responses: {
2565
- not_modified: {
2566
- description: "Not modified",
2567
- },
2568
- not_found: {
2569
- description: "Resource not found",
2570
- content: {
2571
- "application/json": {
2572
- schema: {
2573
- $ref: "#/components/schemas/basic-error",
2574
- },
2575
- },
2576
- },
2577
- },
2578
- internal_error: {
2579
- description: "Internal Error",
2580
- content: {
2581
- "application/json": {
2582
- schema: {
2583
- $ref: "#/components/schemas/basic-error",
2584
- },
2585
- },
2586
- },
2587
- },
2588
- service_unavailable: {
2589
- description: "Service unavailable",
2590
- content: {
2591
- "application/json": {
2592
- schema: {
2593
- type: "object",
2594
- properties: {
2595
- code: {
2596
- type: "string",
2597
- },
2598
- message: {
2599
- type: "string",
2600
- },
2601
- documentation_url: {
2602
- type: "string",
2603
- },
2604
- },
2605
- },
2606
- },
2607
- },
2608
- },
2609
- },
2610
- },
2611
- },
2612
- };
2613
- }
2614
- if (integration.type === "jira") {
2615
- return {
2616
- openApiSpec: {
2617
- openapi: "3.0.1",
2618
- info: {
2619
- title: "Jira Cloud",
2620
- },
2621
- servers: [
2622
- {
2623
- url: "https://your-domain.atlassian.net",
2624
- },
2625
- ],
2626
- paths: {
2627
- "/rest/api/2/issue/{issueIdOrKey}": {
2628
- get: {
2629
- summary: "Get issue",
2630
- description: "Returns the details for an issue.\n\nThe issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is **not** returned. The issue key returned in the response is the key of the issue found.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.",
2631
- parameters: [
2632
- {
2633
- name: "issueIdOrKey",
2634
- in: "path",
2635
- description: "The ID or key of the issue.",
2636
- required: true,
2637
- schema: {
2638
- type: "string",
2639
- },
2640
- },
2641
- {
2642
- name: "fields",
2643
- in: "query",
2644
- description: "A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values:\n\n * `*all` Returns all fields.\n * `*navigable` Returns navigable fields.\n * Any issue field, prefixed with a minus to exclude.\n\nExamples:\n\n * `summary,comment` Returns only the summary and comments fields.\n * `-description` Returns all (default) fields except description.\n * `*navigable,-comment` Returns all navigable fields except comment.\n\nThis parameter may be specified multiple times. For example, `fields=field1,field2& fields=field3`.\n\nNote: All fields are returned by default. This differs from [Search for issues using JQL (GET)](#api-rest-api-2-search-get) and [Search for issues using JQL (POST)](#api-rest-api-2-search-post) where the default is all navigable fields.",
2645
- schema: {
2646
- type: "array",
2647
- items: {
2648
- type: "string",
2649
- default: "*all",
2650
- },
2651
- },
2652
- },
2653
- {
2654
- name: "fieldsByKeys",
2655
- in: "query",
2656
- description: "Whether fields in `fields` are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID.",
2657
- schema: {
2658
- type: "boolean",
2659
- default: false,
2660
- },
2661
- },
2662
- {
2663
- name: "expand",
2664
- in: "query",
2665
- description: "Use [expand](#expansion) to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `renderedFields` Returns field values rendered in HTML format.\n * `names` Returns the display name of each field.\n * `schema` Returns the schema describing a field type.\n * `transitions` Returns all possible transitions for the issue.\n * `editmeta` Returns information about how each field can be edited.\n * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent.\n * `versionedRepresentations` Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the `fields` parameter is ignored.",
2666
- schema: {
2667
- type: "string",
2668
- },
2669
- },
2670
- {
2671
- name: "properties",
2672
- in: "query",
2673
- description: "A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values:\n\n * `*all` Returns all issue properties.\n * Any issue property key, prefixed with a minus to exclude.\n\nExamples:\n\n * `*all` Returns all properties.\n * `*all,-prop1` Returns all properties except `prop1`.\n * `prop1,prop2` Returns `prop1` and `prop2` properties.\n\nThis parameter may be specified multiple times. For example, `properties=prop1,prop2& properties=prop3`.",
2674
- schema: {
2675
- type: "array",
2676
- items: {
2677
- type: "string",
2678
- default: "null",
2679
- },
2680
- },
2681
- },
2682
- {
2683
- name: "updateHistory",
2684
- in: "query",
2685
- description: "Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. This also populates the [JQL issues search](#api-rest-api-2-search-get) `lastViewed` field.",
2686
- schema: {
2687
- type: "boolean",
2688
- default: false,
2689
- },
2690
- },
2691
- ],
2692
- responses: {
2693
- "200": {
2694
- description: "Returned if the request is successful.",
2695
- content: {
2696
- "application/json": {
2697
- schema: {
2698
- $ref: "#/components/schemas/IssueBean",
2699
- },
2700
- example: '{"id":"10002","self":"https://your-domain.atlassian.net/rest/api/2/issue/10002","key":"ED-1","fields":{"watcher":{"self":"https://your-domain.atlassian.net/rest/api/2/issue/EX-1/watchers","isWatching":false,"watchCount":1,"watchers":[{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false}]},"attachment":[{"id":10001,"self":"https://your-domain.atlassian.net/rest/api/2/attachments/10001","filename":"debuglog.txt","author":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","key":"","accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","name":"","avatarUrls":{"48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32"},"displayName":"Mia Krystof","active":false},"created":"2023-09-18T07:39:03.936+0000","size":2460,"mimeType":"text/plain","content":"https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001"}],"sub-tasks":[{"id":"10000","type":{"id":"10000","name":"","inward":"Parent","outward":"Sub-task"},"outwardIssue":{"id":"10003","key":"ED-2","self":"https://your-domain.atlassian.net/rest/api/2/issue/ED-2","fields":{"status":{"iconUrl":"https://your-domain.atlassian.net/images/icons/statuses/open.png","name":"Open"}}}}],"description":"Main order flow broken","project":{"self":"https://your-domain.atlassian.net/rest/api/2/project/EX","id":"10000","key":"EX","name":"Example","avatarUrls":{"48x48":"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000","24x24":"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000","16x16":"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000","32x32":"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000"},"projectCategory":{"self":"https://your-domain.atlassian.net/rest/api/2/projectCategory/10000","id":"10000","name":"FIRST","description":"First Project Category"},"simplified":false,"style":"classic","insight":{"totalIssueCount":100,"lastIssueUpdateTime":"2023-09-18T07:39:03.934+0000"}},"comment":[{"self":"https://your-domain.atlassian.net/rest/api/2/issue/10010/comment/10000","id":"10000","author":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.","updateAuthor":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false},"created":"2021-01-17T12:34:00.000+0000","updated":"2021-01-18T23:45:00.000+0000","visibility":{"type":"role","value":"Administrators","identifier":"Administrators"}}],"issuelinks":[{"id":"10001","type":{"id":"10000","name":"Dependent","inward":"depends on","outward":"is depended by"},"outwardIssue":{"id":"10004L","key":"PR-2","self":"https://your-domain.atlassian.net/rest/api/2/issue/PR-2","fields":{"status":{"iconUrl":"https://your-domain.atlassian.net/images/icons/statuses/open.png","name":"Open"}}}},{"id":"10002","type":{"id":"10000","name":"Dependent","inward":"depends on","outward":"is depended by"},"inwardIssue":{"id":"10004","key":"PR-3","self":"https://your-domain.atlassian.net/rest/api/2/issue/PR-3","fields":{"status":{"iconUrl":"https://your-domain.atlassian.net/images/icons/statuses/open.png","name":"Open"}}}}],"worklog":[{"self":"https://your-domain.atlassian.net/rest/api/2/issue/10010/worklog/10000","author":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false},"updateAuthor":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false},"comment":"I did some work here.","updated":"2021-01-18T23:45:00.000+0000","visibility":{"type":"group","value":"jira-developers","identifier":"276f955c-63d7-42c8-9520-92d01dca0625"},"started":"2021-01-17T12:34:00.000+0000","timeSpent":"3h 20m","timeSpentSeconds":12000,"id":"100028","issueId":"10002"}],"updated":1,"timetracking":{"originalEstimate":"10m","remainingEstimate":"3m","timeSpent":"6m","originalEstimateSeconds":600,"remainingEstimateSeconds":200,"timeSpentSeconds":400}}}',
2701
- },
2702
- },
2703
- },
2704
- "401": {
2705
- description: "Returned if the authentication credentials are incorrect or missing.",
2706
- },
2707
- "404": {
2708
- description: "Returned if the issue is not found or the user does not have permission to view it.",
2709
- },
2710
- },
2711
- deprecated: false,
2712
- security: [
2713
- {
2714
- basicAuth: [],
2715
- },
2716
- {
2717
- OAuth2: ["read:jira-work"],
2718
- },
2719
- {},
2720
- ],
2721
- "x-atlassian-oauth2-scopes": [
2722
- {
2723
- state: "Current",
2724
- scheme: "OAuth2",
2725
- scopes: ["read:jira-work"],
2726
- },
2727
- {
2728
- state: "Beta",
2729
- scheme: "OAuth2",
2730
- scopes: [
2731
- "read:issue-meta:jira",
2732
- "read:issue-security-level:jira",
2733
- "read:issue.vote:jira",
2734
- "read:issue.changelog:jira",
2735
- "read:avatar:jira",
2736
- "read:issue:jira",
2737
- "read:status:jira",
2738
- "read:user:jira",
2739
- "read:field-configuration:jira",
2740
- ],
2741
- },
2742
- ],
2743
- "x-atlassian-connect-scope": "READ",
2744
- },
2745
- },
2746
- "/rest/api/2/search": {
2747
- get: {
2748
- summary: "Search for issues using JQL (GET)",
2749
- description: "Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).\n\nIf the JQL query expression is too large to be encoded as a query parameter, use the [POST](#api-rest-api-2-search-post) version of this resource.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Issues are included in the response where the user has:\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.",
2750
- parameters: [
2751
- {
2752
- name: "jql",
2753
- in: "query",
2754
- description: "The [JQL](https://confluence.atlassian.com/x/egORLQ) that defines the search. Note:\n\n * If no JQL expression is provided, all issues are returned.\n * `username` and `userkey` cannot be used as search terms due to privacy reasons. Use `accountId` instead.\n * If a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.",
2755
- schema: {
2756
- type: "string",
2757
- example: "project = HSP",
2758
- },
2759
- "x-showInExample": "true",
2760
- },
2761
- {
2762
- name: "startAt",
2763
- in: "query",
2764
- description: "The index of the first item to return in a page of results (page offset).",
2765
- schema: {
2766
- type: "integer",
2767
- format: "int32",
2768
- default: 0,
2769
- },
2770
- },
2771
- {
2772
- name: "maxResults",
2773
- in: "query",
2774
- description: "The maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting `id` or `key` only.",
2775
- schema: {
2776
- type: "integer",
2777
- format: "int32",
2778
- default: 50,
2779
- },
2780
- },
2781
- {
2782
- name: "validateQuery",
2783
- in: "query",
2784
- description: "Determines how to validate the JQL query and treat the validation results. Supported values are:\n\n * `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).\n * `warn` Returns all errors as warnings.\n * `none` No validation is performed.\n * `true` *Deprecated* A legacy synonym for `strict`.\n * `false` *Deprecated* A legacy synonym for `warn`.\n\nNote: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value.",
2785
- schema: {
2786
- type: "string",
2787
- default: "strict",
2788
- enum: ["strict", "warn", "none", "true", "false"],
2789
- },
2790
- },
2791
- {
2792
- name: "fields",
2793
- in: "query",
2794
- description: "A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include:\n\n * `*all` Returns all fields.\n * `*navigable` Returns navigable fields.\n * Any issue field, prefixed with a minus to exclude.\n\nExamples:\n\n * `summary,comment` Returns only the summary and comments fields.\n * `-description` Returns all navigable (default) fields except description.\n * `*all,-comment` Returns all fields except comments.\n\nThis parameter may be specified multiple times. For example, `fields=field1,field2&fields=field3`.\n\nNote: All navigable fields are returned by default. This differs from [GET issue](#api-rest-api-2-issue-issueIdOrKey-get) where the default is all fields.",
2795
- schema: {
2796
- type: "array",
2797
- items: {
2798
- type: "string",
2799
- default: "*navigable",
2800
- },
2801
- },
2802
- },
2803
- {
2804
- name: "expand",
2805
- in: "query",
2806
- description: "Use [expand](#expansion) to include additional information about issues in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `renderedFields` Returns field values rendered in HTML format.\n * `names` Returns the display name of each field.\n * `schema` Returns the schema describing a field type.\n * `transitions` Returns all possible transitions for the issue.\n * `operations` Returns all possible operations for the issue.\n * `editmeta` Returns information about how each field can be edited.\n * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent.\n * `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.",
2807
- schema: {
2808
- type: "string",
2809
- },
2810
- },
2811
- {
2812
- name: "properties",
2813
- in: "query",
2814
- description: "A list of issue property keys for issue properties to include in the results. This parameter accepts a comma-separated list. Multiple properties can also be provided using an ampersand separated list. For example, `properties=prop1,prop2&properties=prop3`. A maximum of 5 issue property keys can be specified.",
2815
- schema: {
2816
- type: "array",
2817
- items: {
2818
- type: "string",
2819
- },
2820
- },
2821
- },
2822
- {
2823
- name: "fieldsByKeys",
2824
- in: "query",
2825
- description: "Reference fields by their key (rather than ID).",
2826
- schema: {
2827
- type: "boolean",
2828
- default: false,
2829
- },
2830
- },
2831
- ],
2832
- responses: {
2833
- "200": {
2834
- description: "Returned if the request is successful.",
2835
- content: {
2836
- "application/json": {
2837
- schema: {
2838
- $ref: "#/components/schemas/SearchResults",
2839
- },
2840
- example: '{"expand":"names,schema","startAt":0,"maxResults":50,"total":1,"issues":[{"expand":"","id":"10002","self":"https://your-domain.atlassian.net/rest/api/2/issue/10002","key":"ED-1","fields":{"watcher":{"self":"https://your-domain.atlassian.net/rest/api/2/issue/EX-1/watchers","isWatching":false,"watchCount":1,"watchers":[{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false}]},"attachment":[{"id":10001,"self":"https://your-domain.atlassian.net/rest/api/2/attachments/10001","filename":"debuglog.txt","author":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","key":"","accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","name":"","avatarUrls":{"48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32"},"displayName":"Mia Krystof","active":false},"created":"2023-09-18T07:39:03.936+0000","size":2460,"mimeType":"text/plain","content":"https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001"}],"sub-tasks":[{"id":"10000","type":{"id":"10000","name":"","inward":"Parent","outward":"Sub-task"},"outwardIssue":{"id":"10003","key":"ED-2","self":"https://your-domain.atlassian.net/rest/api/2/issue/ED-2","fields":{"status":{"iconUrl":"https://your-domain.atlassian.net/images/icons/statuses/open.png","name":"Open"}}}}],"description":"Main order flow broken","project":{"self":"https://your-domain.atlassian.net/rest/api/2/project/EX","id":"10000","key":"EX","name":"Example","avatarUrls":{"48x48":"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000","24x24":"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000","16x16":"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000","32x32":"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000"},"projectCategory":{"self":"https://your-domain.atlassian.net/rest/api/2/projectCategory/10000","id":"10000","name":"FIRST","description":"First Project Category"},"simplified":false,"style":"classic","insight":{"totalIssueCount":100,"lastIssueUpdateTime":"2023-09-18T07:39:03.934+0000"}},"comment":[{"self":"https://your-domain.atlassian.net/rest/api/2/issue/10010/comment/10000","id":"10000","author":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.","updateAuthor":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false},"created":"2021-01-17T12:34:00.000+0000","updated":"2021-01-18T23:45:00.000+0000","visibility":{"type":"role","value":"Administrators","identifier":"Administrators"}}],"issuelinks":[{"id":"10001","type":{"id":"10000","name":"Dependent","inward":"depends on","outward":"is depended by"},"outwardIssue":{"id":"10004L","key":"PR-2","self":"https://your-domain.atlassian.net/rest/api/2/issue/PR-2","fields":{"status":{"iconUrl":"https://your-domain.atlassian.net/images/icons/statuses/open.png","name":"Open"}}}},{"id":"10002","type":{"id":"10000","name":"Dependent","inward":"depends on","outward":"is depended by"},"inwardIssue":{"id":"10004","key":"PR-3","self":"https://your-domain.atlassian.net/rest/api/2/issue/PR-3","fields":{"status":{"iconUrl":"https://your-domain.atlassian.net/images/icons/statuses/open.png","name":"Open"}}}}],"worklog":[{"self":"https://your-domain.atlassian.net/rest/api/2/issue/10010/worklog/10000","author":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false},"updateAuthor":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false},"comment":"I did some work here.","updated":"2021-01-18T23:45:00.000+0000","visibility":{"type":"group","value":"jira-developers","identifier":"276f955c-63d7-42c8-9520-92d01dca0625"},"started":"2021-01-17T12:34:00.000+0000","timeSpent":"3h 20m","timeSpentSeconds":12000,"id":"100028","issueId":"10002"}],"updated":1,"timetracking":{"originalEstimate":"10m","remainingEstimate":"3m","timeSpent":"6m","originalEstimateSeconds":600,"remainingEstimateSeconds":200,"timeSpentSeconds":400}}}],"warningMessages":["The value \'bar\' does not exist for the field \'foo\'."]}',
2841
- },
2842
- },
2843
- },
2844
- "400": {
2845
- description: "Returned if the JQL query is invalid.",
2846
- },
2847
- "401": {
2848
- description: "Returned if the authentication credentials are incorrect or missing.",
2849
- },
2850
- },
2851
- deprecated: false,
2852
- security: [
2853
- {
2854
- basicAuth: [],
2855
- },
2856
- {
2857
- OAuth2: ["read:jira-work"],
2858
- },
2859
- {},
2860
- ],
2861
- },
2862
- post: {
2863
- tags: ["Issue search"],
2864
- summary: "Search for issues using JQL (POST)",
2865
- description: "Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).\n\nThere is a [GET](#api-rest-api-2-search-get) version of this resource that can be used for smaller JQL query expressions.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Issues are included in the response where the user has:\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.",
2866
- operationId: "searchForIssuesUsingJqlPost",
2867
- parameters: [],
2868
- requestBody: {
2869
- description: "A JSON object containing the search request.",
2870
- content: {
2871
- "application/json": {
2872
- schema: {
2873
- $ref: "#/components/schemas/SearchRequestBean",
2874
- },
2875
- example: {
2876
- expand: ["names", "schema", "operations"],
2877
- fields: ["summary", "status", "assignee"],
2878
- fieldsByKeys: false,
2879
- jql: "project = HSP",
2880
- maxResults: 15,
2881
- startAt: 0,
2882
- },
2883
- },
2884
- },
2885
- required: true,
2886
- },
2887
- responses: {
2888
- "200": {
2889
- description: "Returned if the request is successful.",
2890
- content: {
2891
- "application/json": {
2892
- schema: {
2893
- $ref: "#/components/schemas/SearchResults",
2894
- },
2895
- example: '{"expand":"names,schema","startAt":0,"maxResults":50,"total":1,"issues":[{"expand":"","id":"10002","self":"https://your-domain.atlassian.net/rest/api/2/issue/10002","key":"ED-1","fields":{"watcher":{"self":"https://your-domain.atlassian.net/rest/api/2/issue/EX-1/watchers","isWatching":false,"watchCount":1,"watchers":[{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false}]},"attachment":[{"id":10001,"self":"https://your-domain.atlassian.net/rest/api/2/attachments/10001","filename":"debuglog.txt","author":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","key":"","accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","name":"","avatarUrls":{"48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32"},"displayName":"Mia Krystof","active":false},"created":"2023-09-18T07:39:03.936+0000","size":2460,"mimeType":"text/plain","content":"https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001"}],"sub-tasks":[{"id":"10000","type":{"id":"10000","name":"","inward":"Parent","outward":"Sub-task"},"outwardIssue":{"id":"10003","key":"ED-2","self":"https://your-domain.atlassian.net/rest/api/2/issue/ED-2","fields":{"status":{"iconUrl":"https://your-domain.atlassian.net/images/icons/statuses/open.png","name":"Open"}}}}],"description":"Main order flow broken","project":{"self":"https://your-domain.atlassian.net/rest/api/2/project/EX","id":"10000","key":"EX","name":"Example","avatarUrls":{"48x48":"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000","24x24":"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000","16x16":"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000","32x32":"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000"},"projectCategory":{"self":"https://your-domain.atlassian.net/rest/api/2/projectCategory/10000","id":"10000","name":"FIRST","description":"First Project Category"},"simplified":false,"style":"classic","insight":{"totalIssueCount":100,"lastIssueUpdateTime":"2023-09-18T07:39:03.934+0000"}},"comment":[{"self":"https://your-domain.atlassian.net/rest/api/2/issue/10010/comment/10000","id":"10000","author":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.","updateAuthor":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false},"created":"2021-01-17T12:34:00.000+0000","updated":"2021-01-18T23:45:00.000+0000","visibility":{"type":"role","value":"Administrators","identifier":"Administrators"}}],"issuelinks":[{"id":"10001","type":{"id":"10000","name":"Dependent","inward":"depends on","outward":"is depended by"},"outwardIssue":{"id":"10004L","key":"PR-2","self":"https://your-domain.atlassian.net/rest/api/2/issue/PR-2","fields":{"status":{"iconUrl":"https://your-domain.atlassian.net/images/icons/statuses/open.png","name":"Open"}}}},{"id":"10002","type":{"id":"10000","name":"Dependent","inward":"depends on","outward":"is depended by"},"inwardIssue":{"id":"10004","key":"PR-3","self":"https://your-domain.atlassian.net/rest/api/2/issue/PR-3","fields":{"status":{"iconUrl":"https://your-domain.atlassian.net/images/icons/statuses/open.png","name":"Open"}}}}],"worklog":[{"self":"https://your-domain.atlassian.net/rest/api/2/issue/10010/worklog/10000","author":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false},"updateAuthor":{"self":"https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false},"comment":"I did some work here.","updated":"2021-01-18T23:45:00.000+0000","visibility":{"type":"group","value":"jira-developers","identifier":"276f955c-63d7-42c8-9520-92d01dca0625"},"started":"2021-01-17T12:34:00.000+0000","timeSpent":"3h 20m","timeSpentSeconds":12000,"id":"100028","issueId":"10002"}],"updated":1,"timetracking":{"originalEstimate":"10m","remainingEstimate":"3m","timeSpent":"6m","originalEstimateSeconds":600,"remainingEstimateSeconds":200,"timeSpentSeconds":400}}}],"warningMessages":["The value \'bar\' does not exist for the field \'foo\'."]}',
2896
- },
2897
- },
2898
- },
2899
- "400": {
2900
- description: "Returned if the JQL query is invalid.",
2901
- },
2902
- "401": {
2903
- description: "Returned if the authentication credentials are incorrect or missing.",
2904
- },
2905
- },
2906
- deprecated: false,
2907
- security: [
2908
- {
2909
- basicAuth: [],
2910
- },
2911
- {
2912
- OAuth2: ["read:jira-work"],
2913
- },
2914
- {},
2915
- ],
2916
- "x-atlassian-oauth2-scopes": [
2917
- {
2918
- state: "Current",
2919
- scheme: "OAuth2",
2920
- scopes: ["read:jira-work"],
2921
- },
2922
- {
2923
- state: "Beta",
2924
- scheme: "OAuth2",
2925
- scopes: [
2926
- "read:issue-details:jira",
2927
- "read:field.default-value:jira",
2928
- "read:field.option:jira",
2929
- "read:field:jira",
2930
- "read:group:jira",
2931
- ],
2932
- },
2933
- ],
2934
- "x-atlassian-connect-scope": "READ",
2935
- },
2936
- },
2937
- },
2938
- components: {
2939
- schemas: {
2940
- IssueBean: {
2941
- type: "object",
2942
- properties: {
2943
- changelog: {
2944
- description: "Details of changelogs associated with the issue.",
2945
- readOnly: true,
2946
- allOf: [
2947
- {
2948
- $ref: "#/components/schemas/PageOfChangelogs",
2949
- },
2950
- ],
2951
- },
2952
- editmeta: {
2953
- description: "The metadata for the fields on the issue that can be amended.",
2954
- readOnly: true,
2955
- allOf: [
2956
- {
2957
- $ref: "#/components/schemas/IssueUpdateMetadata",
2958
- },
2959
- ],
2960
- },
2961
- expand: {
2962
- type: "string",
2963
- description: "Expand options that include additional issue details in the response.",
2964
- readOnly: true,
2965
- xml: {
2966
- attribute: true,
2967
- },
2968
- },
2969
- fields: {
2970
- type: "object",
2971
- additionalProperties: {},
2972
- },
2973
- fieldsToInclude: {
2974
- $ref: "#/components/schemas/IncludedFields",
2975
- },
2976
- id: {
2977
- type: "string",
2978
- description: "The ID of the issue.",
2979
- readOnly: true,
2980
- },
2981
- key: {
2982
- type: "string",
2983
- description: "The key of the issue.",
2984
- readOnly: true,
2985
- },
2986
- names: {
2987
- type: "object",
2988
- additionalProperties: {
2989
- type: "string",
2990
- readOnly: true,
2991
- },
2992
- description: "The ID and name of each field present on the issue.",
2993
- readOnly: true,
2994
- },
2995
- operations: {
2996
- description: "The operations that can be performed on the issue.",
2997
- readOnly: true,
2998
- allOf: [
2999
- {
3000
- $ref: "#/components/schemas/Operations",
3001
- },
3002
- ],
3003
- },
3004
- properties: {
3005
- type: "object",
3006
- additionalProperties: {
3007
- readOnly: true,
3008
- },
3009
- description: "Details of the issue properties identified in the request.",
3010
- readOnly: true,
3011
- },
3012
- renderedFields: {
3013
- type: "object",
3014
- additionalProperties: {
3015
- readOnly: true,
3016
- },
3017
- description: "The rendered value of each field present on the issue.",
3018
- readOnly: true,
3019
- },
3020
- schema: {
3021
- type: "object",
3022
- additionalProperties: {
3023
- $ref: "#/components/schemas/JsonTypeBean",
3024
- },
3025
- description: "The schema describing each field present on the issue.",
3026
- readOnly: true,
3027
- },
3028
- self: {
3029
- type: "string",
3030
- description: "The URL of the issue details.",
3031
- format: "uri",
3032
- readOnly: true,
3033
- },
3034
- transitions: {
3035
- type: "array",
3036
- description: "The transitions that can be performed on the issue.",
3037
- readOnly: true,
3038
- items: {
3039
- $ref: "#/components/schemas/IssueTransition",
3040
- },
3041
- },
3042
- versionedRepresentations: {
3043
- type: "object",
3044
- additionalProperties: {
3045
- type: "object",
3046
- additionalProperties: {
3047
- readOnly: true,
3048
- },
3049
- readOnly: true,
3050
- },
3051
- description: "The versions of each field on the issue.",
3052
- readOnly: true,
3053
- },
3054
- },
3055
- additionalProperties: false,
3056
- description: "Details about an issue.",
3057
- xml: {
3058
- name: "issue",
3059
- },
3060
- },
3061
- IncludedFields: {
3062
- type: "object",
3063
- properties: {
3064
- actuallyIncluded: {
3065
- uniqueItems: true,
3066
- type: "array",
3067
- items: {
3068
- type: "string",
3069
- },
3070
- },
3071
- excluded: {
3072
- uniqueItems: true,
3073
- type: "array",
3074
- items: {
3075
- type: "string",
3076
- },
3077
- },
3078
- included: {
3079
- uniqueItems: true,
3080
- type: "array",
3081
- items: {
3082
- type: "string",
3083
- },
3084
- },
3085
- },
3086
- additionalProperties: false,
3087
- },
3088
- IssueTransition: {
3089
- type: "object",
3090
- properties: {
3091
- expand: {
3092
- type: "string",
3093
- description: "Expand options that include additional transition details in the response.",
3094
- readOnly: true,
3095
- },
3096
- fields: {
3097
- type: "object",
3098
- additionalProperties: {
3099
- $ref: "#/components/schemas/FieldMetadata",
3100
- },
3101
- description: "Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request.",
3102
- readOnly: true,
3103
- },
3104
- hasScreen: {
3105
- type: "boolean",
3106
- description: "Whether there is a screen associated with the issue transition.",
3107
- readOnly: true,
3108
- },
3109
- id: {
3110
- type: "string",
3111
- description: "The ID of the issue transition. Required when specifying a transition to undertake.",
3112
- },
3113
- isAvailable: {
3114
- type: "boolean",
3115
- description: "Whether the transition is available to be performed.",
3116
- readOnly: true,
3117
- },
3118
- isConditional: {
3119
- type: "boolean",
3120
- description: "Whether the issue has to meet criteria before the issue transition is applied.",
3121
- readOnly: true,
3122
- },
3123
- isGlobal: {
3124
- type: "boolean",
3125
- description: "Whether the issue transition is global, that is, the transition is applied to issues regardless of their status.",
3126
- readOnly: true,
3127
- },
3128
- isInitial: {
3129
- type: "boolean",
3130
- description: "Whether this is the initial issue transition for the workflow.",
3131
- readOnly: true,
3132
- },
3133
- looped: {
3134
- type: "boolean",
3135
- },
3136
- name: {
3137
- type: "string",
3138
- description: "The name of the issue transition.",
3139
- readOnly: true,
3140
- },
3141
- to: {
3142
- description: "Details of the issue status after the transition.",
3143
- readOnly: true,
3144
- allOf: [
3145
- {
3146
- $ref: "#/components/schemas/StatusDetails",
3147
- },
3148
- ],
3149
- },
3150
- },
3151
- additionalProperties: true,
3152
- description: "Details of an issue transition.",
3153
- },
3154
- PageOfChangelogs: {
3155
- type: "object",
3156
- properties: {
3157
- histories: {
3158
- type: "array",
3159
- description: "The list of changelogs.",
3160
- readOnly: true,
3161
- items: {
3162
- $ref: "#/components/schemas/Changelog",
3163
- },
3164
- },
3165
- maxResults: {
3166
- type: "integer",
3167
- description: "The maximum number of results that could be on the page.",
3168
- format: "int32",
3169
- readOnly: true,
3170
- },
3171
- startAt: {
3172
- type: "integer",
3173
- description: "The index of the first item returned on the page.",
3174
- format: "int32",
3175
- readOnly: true,
3176
- },
3177
- total: {
3178
- type: "integer",
3179
- description: "The number of results on the page.",
3180
- format: "int32",
3181
- readOnly: true,
3182
- },
3183
- },
3184
- additionalProperties: false,
3185
- description: "A page of changelogs.",
3186
- },
3187
- Changelog: {
3188
- type: "object",
3189
- properties: {
3190
- author: {
3191
- description: "The user who made the change.",
3192
- readOnly: true,
3193
- allOf: [
3194
- {
3195
- $ref: "#/components/schemas/UserDetails",
3196
- },
3197
- ],
3198
- },
3199
- created: {
3200
- type: "string",
3201
- description: "The date on which the change took place.",
3202
- format: "date-time",
3203
- readOnly: true,
3204
- },
3205
- historyMetadata: {
3206
- description: "The history metadata associated with the changed.",
3207
- readOnly: true,
3208
- allOf: [
3209
- {
3210
- $ref: "#/components/schemas/HistoryMetadata",
3211
- },
3212
- ],
3213
- },
3214
- id: {
3215
- type: "string",
3216
- description: "The ID of the changelog.",
3217
- readOnly: true,
3218
- },
3219
- items: {
3220
- type: "array",
3221
- description: "The list of items changed.",
3222
- readOnly: true,
3223
- items: {
3224
- $ref: "#/components/schemas/ChangeDetails",
3225
- },
3226
- },
3227
- },
3228
- additionalProperties: false,
3229
- description: "A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.",
3230
- },
3231
- SearchResults: {
3232
- type: "object",
3233
- properties: {
3234
- expand: {
3235
- type: "string",
3236
- description: "Expand options that include additional search result details in the response.",
3237
- readOnly: true,
3238
- },
3239
- issues: {
3240
- type: "array",
3241
- description: "The list of issues found by the search.",
3242
- readOnly: true,
3243
- items: {
3244
- $ref: "#/components/schemas/IssueBean",
3245
- },
3246
- },
3247
- maxResults: {
3248
- type: "integer",
3249
- description: "The maximum number of results that could be on the page.",
3250
- format: "int32",
3251
- readOnly: true,
3252
- },
3253
- names: {
3254
- type: "object",
3255
- additionalProperties: {
3256
- type: "string",
3257
- readOnly: true,
3258
- },
3259
- description: "The ID and name of each field in the search results.",
3260
- readOnly: true,
3261
- },
3262
- schema: {
3263
- type: "object",
3264
- additionalProperties: {
3265
- $ref: "#/components/schemas/JsonTypeBean",
3266
- },
3267
- description: "The schema describing the field types in the search results.",
3268
- readOnly: true,
3269
- },
3270
- startAt: {
3271
- type: "integer",
3272
- description: "The index of the first item returned on the page.",
3273
- format: "int32",
3274
- readOnly: true,
3275
- },
3276
- total: {
3277
- type: "integer",
3278
- description: "The number of results on the page.",
3279
- format: "int32",
3280
- readOnly: true,
3281
- },
3282
- warningMessages: {
3283
- type: "array",
3284
- description: "Any warnings related to the JQL query.",
3285
- readOnly: true,
3286
- items: {
3287
- type: "string",
3288
- readOnly: true,
3289
- },
3290
- },
3291
- },
3292
- additionalProperties: false,
3293
- description: "The result of a JQL search.",
3294
- },
3295
- JsonTypeBean: {
3296
- required: ["type"],
3297
- type: "object",
3298
- properties: {
3299
- configuration: {
3300
- type: "object",
3301
- additionalProperties: {
3302
- readOnly: true,
3303
- },
3304
- description: "If the field is a custom field, the configuration of the field.",
3305
- readOnly: true,
3306
- },
3307
- custom: {
3308
- type: "string",
3309
- description: "If the field is a custom field, the URI of the field.",
3310
- readOnly: true,
3311
- },
3312
- customId: {
3313
- type: "integer",
3314
- description: "If the field is a custom field, the custom ID of the field.",
3315
- format: "int64",
3316
- readOnly: true,
3317
- },
3318
- items: {
3319
- type: "string",
3320
- description: "When the data type is an array, the name of the field items within the array.",
3321
- readOnly: true,
3322
- },
3323
- system: {
3324
- type: "string",
3325
- description: "If the field is a system field, the name of the field.",
3326
- readOnly: true,
3327
- },
3328
- type: {
3329
- type: "string",
3330
- description: "The data type of the field.",
3331
- readOnly: true,
3332
- },
3333
- },
3334
- additionalProperties: false,
3335
- description: "The schema of a field.",
3336
- },
3337
- UserDetails: {
3338
- type: "object",
3339
- properties: {
3340
- accountId: {
3341
- maxLength: 128,
3342
- type: "string",
3343
- description: "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
3344
- },
3345
- accountType: {
3346
- type: "string",
3347
- description: "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
3348
- readOnly: true,
3349
- },
3350
- active: {
3351
- type: "boolean",
3352
- description: "Whether the user is active.",
3353
- readOnly: true,
3354
- },
3355
- avatarUrls: {
3356
- description: "The avatars of the user.",
3357
- readOnly: true,
3358
- allOf: [
3359
- {
3360
- $ref: "#/components/schemas/AvatarUrlsBean",
3361
- },
3362
- ],
3363
- },
3364
- displayName: {
3365
- type: "string",
3366
- description: "The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.",
3367
- readOnly: true,
3368
- },
3369
- emailAddress: {
3370
- type: "string",
3371
- description: "The email address of the user. Depending on the user’s privacy settings, this may be returned as null.",
3372
- readOnly: true,
3373
- },
3374
- key: {
3375
- type: "string",
3376
- description: "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
3377
- readOnly: true,
3378
- },
3379
- name: {
3380
- type: "string",
3381
- description: "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
3382
- readOnly: true,
3383
- },
3384
- self: {
3385
- type: "string",
3386
- description: "The URL of the user.",
3387
- readOnly: true,
3388
- },
3389
- timeZone: {
3390
- type: "string",
3391
- description: "The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.",
3392
- readOnly: true,
3393
- },
3394
- },
3395
- additionalProperties: false,
3396
- description: "User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:\n\n * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).\n * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.\n * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.",
3397
- },
3398
- },
3399
- },
3400
- },
3401
- };
3402
- }
3403
17
  if (integration.name.includes("InternalAPICustomers")) {
3404
18
  return {
3405
19
  openApiSpec: {
@@ -3712,7 +326,7 @@ const formatSdkClassContent = (sdkClassName, integrations) => {
3712
326
  const metadataById = integrations.map(({ name: description, id, metadata }) => ({ id, description, metadata }));
3713
327
  return `class ${sdkClassName} extends ${openApiIntegrationTypes.includes(sdkClassName.toLowerCase()) ? "RestApi" : "Integration"} {
3714
328
  static integrations: Integrations = ${JSON.stringify(metadataById)};
3715
-
329
+
3716
330
  // the rest of the type from above ...
3717
331
  }`;
3718
332
  };