Skip to content

Commit 8ec16e1

Browse files
iamrajjoshigetsantry[bot]
iamrajjoshi
and
getsantry[bot]
authored
feat(api-idorslug): Rename Path paramaters to project_id_or_slug (#69716)
I am working on making our APIs work with slug and id in our path parameters. Over the path month, we have updated the endpoints so they can support both parameters. As a final step, we are renaming the parameters from `{resource}.slug` to `{resource}.id_or_slug`. There will be a similar PR for `organization_slug` --------- Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>
1 parent 368de5d commit 8ec16e1

File tree

155 files changed

+1114
-815
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

155 files changed

+1114
-815
lines changed

‎api-docs/openapi.json‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -114,34 +114,34 @@
114114
"/api/0/projects/": {
115115
"$ref": "paths/projects/index.json"
116116
},
117-
"/api/0/projects/{organization_slug}/{project_slug}/files/dsyms/": {
117+
"/api/0/projects/{organization_slug}/{project_id_or_slug}/files/dsyms/": {
118118
"$ref": "paths/projects/dsyms.json"
119119
},
120-
"/api/0/projects/{organization_slug}/{project_slug}/users/": {
120+
"/api/0/projects/{organization_slug}/{project_id_or_slug}/users/": {
121121
"$ref": "paths/projects/users.json"
122122
},
123-
"/api/0/projects/{organization_slug}/{project_slug}/tags/{key}/values/": {
123+
"/api/0/projects/{organization_slug}/{project_id_or_slug}/tags/{key}/values/": {
124124
"$ref": "paths/projects/tag-values.json"
125125
},
126-
"/api/0/projects/{organization_slug}/{project_slug}/stats/": {
126+
"/api/0/projects/{organization_slug}/{project_id_or_slug}/stats/": {
127127
"$ref": "paths/projects/stats.json"
128128
},
129-
"/api/0/projects/{organization_slug}/{project_slug}/user-feedback/": {
129+
"/api/0/projects/{organization_slug}/{project_id_or_slug}/user-feedback/": {
130130
"$ref": "paths/projects/user-feedback.json"
131131
},
132-
"/api/0/projects/{organization_slug}/{project_slug}/hooks/": {
132+
"/api/0/projects/{organization_slug}/{project_id_or_slug}/hooks/": {
133133
"$ref": "paths/projects/service-hooks.json"
134134
},
135-
"/api/0/projects/{organization_slug}/{project_slug}/hooks/{hook_id}/": {
135+
"/api/0/projects/{organization_slug}/{project_id_or_slug}/hooks/{hook_id}/": {
136136
"$ref": "paths/projects/service-hook-details.json"
137137
},
138-
"/api/0/projects/{organization_slug}/{project_slug}/events/{event_id}/": {
138+
"/api/0/projects/{organization_slug}/{project_id_or_slug}/events/{event_id}/": {
139139
"$ref": "paths/events/project-event-details.json"
140140
},
141-
"/api/0/projects/{organization_slug}/{project_slug}/events/": {
141+
"/api/0/projects/{organization_slug}/{project_id_or_slug}/events/": {
142142
"$ref": "paths/events/project-events.json"
143143
},
144-
"/api/0/projects/{organization_slug}/{project_slug}/issues/": {
144+
"/api/0/projects/{organization_slug}/{project_id_or_slug}/issues/": {
145145
"$ref": "paths/events/project-issues.json"
146146
},
147147
"/api/0/organizations/{organization_slug}/issues/{issue_id}/tags/{key}/values/": {
@@ -174,19 +174,19 @@
174174
"/api/0/organizations/{organization_slug}/releases/{version}/files/": {
175175
"$ref": "paths/releases/release-files.json"
176176
},
177-
"/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/files/": {
177+
"/api/0/projects/{organization_slug}/{project_id_or_slug}/releases/{version}/files/": {
178178
"$ref": "paths/releases/project-release-files.json"
179179
},
180180
"/api/0/organizations/{organization_slug}/releases/{version}/files/{file_id}/": {
181181
"$ref": "paths/releases/release-file.json"
182182
},
183-
"/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/files/{file_id}/": {
183+
"/api/0/projects/{organization_slug}/{project_id_or_slug}/releases/{version}/files/{file_id}/": {
184184
"$ref": "paths/releases/project-release-file.json"
185185
},
186186
"/api/0/organizations/{organization_slug}/releases/{version}/commits/": {
187187
"$ref": "paths/releases/organization-release-commits.json"
188188
},
189-
"/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/commits/": {
189+
"/api/0/projects/{organization_slug}/{project_id_or_slug}/releases/{version}/commits/": {
190190
"$ref": "paths/releases/project-release-commits.json"
191191
},
192192
"/api/0/organizations/{organization_slug}/releases/{version}/commitfiles/": {

‎api-docs/paths/events/project-event-details.json‎

Lines changed: 8 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
}
1515
},
1616
{
17-
"name": "project_slug",
17+
"name": "project_id_or_slug",
1818
"in": "path",
19-
"description": "The slug of the project the event belongs to.",
19+
"description": "The id or slug of the project the event belongs to.",
2020
"required": true,
2121
"schema": {
2222
"type": "string"
@@ -154,10 +154,7 @@
154154
71,
155155
" return fn.apply(this, wrappedArguments);"
156156
],
157-
[
158-
72,
159-
" // tslint:enable:no-unsafe-any"
160-
],
157+
[72, " // tslint:enable:no-unsafe-any"],
161158
[73, " }"],
162159
[74, " catch (ex) {"],
163160
[75, " ignoreNextOnError();"],
@@ -182,10 +179,7 @@
182179
"instructionAddr": null,
183180
"context": [
184181
[69, " */"],
185-
[
186-
70,
187-
" triggerAsync: function triggerAsync() {"
188-
],
182+
[70, " triggerAsync: function triggerAsync() {"],
189183
[71, " var args = arguments,"],
190184
[72, " me = this;"],
191185
[73, " _.nextTick(function () {"],
@@ -227,30 +221,18 @@
227221
"context": [
228222
[76, "/*!"],
229223
[77, " Copyright (c) 2018 Jed Watson."],
230-
[
231-
78,
232-
" Licensed under the MIT License (MIT), see"
233-
],
234-
[
235-
79,
236-
" http://jedwatson.github.io/react-select"
237-
],
224+
[78, " Licensed under the MIT License (MIT), see"],
225+
[79, " http://jedwatson.github.io/react-select"],
238226
[80, "*/"],
239227
[
240228
81,
241229
"{snip} e,t)}));return e.handleEvent?e.handleEvent.apply(this,s):e.apply(this,s)}catch(e){throw c(),Object(o.m)((function(n){n.addEventProcessor((fu {snip}"
242230
],
243231
[82, "/*!"],
244232
[83, " * JavaScript Cookie v2.2.1"],
245-
[
246-
84,
247-
" * https://github.com/js-cookie/js-cookie"
248-
],
233+
[84, " * https://github.com/js-cookie/js-cookie"],
249234
[85, " *"],
250-
[
251-
86,
252-
" * Copyright 2006, 2015 Klaus Hartl & Fagner Brack"
253-
]
235+
[86, " * Copyright 2006, 2015 Klaus Hartl & Fagner Brack"]
254236
],
255237
"symbolAddr": null,
256238
"trust": null,

‎api-docs/paths/events/project-events.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
}
1515
},
1616
{
17-
"name": "project_slug",
17+
"name": "project_id_or_slug",
1818
"in": "path",
19-
"description": "The slug of the project the events belong to.",
19+
"description": "The id or slug of the project the events belong to.",
2020
"required": true,
2121
"schema": {
2222
"type": "string"

‎api-docs/paths/events/project-issues.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
}
1515
},
1616
{
17-
"name": "project_slug",
17+
"name": "project_id_or_slug",
1818
"in": "path",
19-
"description": "The slug of the project the issues belong to.",
19+
"description": "The id or slug of the project the issues belong to.",
2020
"required": true,
2121
"schema": {
2222
"type": "string"
@@ -152,9 +152,9 @@
152152
}
153153
},
154154
{
155-
"name": "project_slug",
155+
"name": "project_id_or_slug",
156156
"in": "path",
157-
"description": "The slug of the project the issues belong to.",
157+
"description": "The id or slug of the project the issues belong to.",
158158
"required": true,
159159
"schema": {
160160
"type": "string"
@@ -313,9 +313,9 @@
313313
}
314314
},
315315
{
316-
"name": "project_slug",
316+
"name": "project_id_or_slug",
317317
"in": "path",
318-
"description": "The slug of the project the issues belong to.",
318+
"description": "The id or slug of the project the issues belong to.",
319319
"required": true,
320320
"schema": {
321321
"type": "string"

‎api-docs/paths/projects/dsyms.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
}
1515
},
1616
{
17-
"name": "project_slug",
17+
"name": "project_id_or_slug",
1818
"in": "path",
19-
"description": "The slug of the project to list the DIFs of.",
19+
"description": "The id or slug of the project to list the DIFs of.",
2020
"required": true,
2121
"schema": {
2222
"type": "string"
@@ -58,9 +58,9 @@
5858
}
5959
},
6060
{
61-
"name": "project_slug",
61+
"name": "project_id_or_slug",
6262
"in": "path",
63-
"description": "The slug of the project to upload a file to.",
63+
"description": "The id or slug of the project to upload a file to.",
6464
"required": true,
6565
"schema": {
6666
"type": "string"
@@ -126,9 +126,9 @@
126126
}
127127
},
128128
{
129-
"name": "project_slug",
129+
"name": "project_id_or_slug",
130130
"in": "path",
131-
"description": "The slug of the project to delete the DIF.",
131+
"description": "The id or slug of the project to delete the DIF.",
132132
"required": true,
133133
"schema": {
134134
"type": "string"

‎api-docs/paths/projects/service-hook-details.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
}
1515
},
1616
{
17-
"name": "project_slug",
17+
"name": "project_id_or_slug",
1818
"in": "path",
19-
"description": "The slug of the project the client keys belong to.",
19+
"description": "The id or slug of the project the client keys belong to.",
2020
"required": true,
2121
"schema": {
2222
"type": "string"
@@ -79,9 +79,9 @@
7979
}
8080
},
8181
{
82-
"name": "project_slug",
82+
"name": "project_id_or_slug",
8383
"in": "path",
84-
"description": "The slug of the project the client keys belong to.",
84+
"description": "The id or slug of the project the client keys belong to.",
8585
"required": true,
8686
"schema": {
8787
"type": "string"
@@ -175,9 +175,9 @@
175175
}
176176
},
177177
{
178-
"name": "project_slug",
178+
"name": "project_id_or_slug",
179179
"in": "path",
180-
"description": "The slug of the project the client keys belong to.",
180+
"description": "The id or slug of the project the client keys belong to.",
181181
"required": true,
182182
"schema": {
183183
"type": "string"

‎api-docs/paths/projects/service-hooks.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
}
1515
},
1616
{
17-
"name": "project_slug",
17+
"name": "project_id_or_slug",
1818
"in": "path",
19-
"description": "The slug of the project the client keys belong to.",
19+
"description": "The id or slug of the project the client keys belong to.",
2020
"required": true,
2121
"schema": {
2222
"type": "string"
@@ -75,9 +75,9 @@
7575
}
7676
},
7777
{
78-
"name": "project_slug",
78+
"name": "project_id_or_slug",
7979
"in": "path",
80-
"description": "The slug of the project the client keys belong to.",
80+
"description": "The id or slug of the project the client keys belong to.",
8181
"required": true,
8282
"schema": {
8383
"type": "string"

‎api-docs/paths/projects/stats.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
}
1616
},
1717
{
18-
"name": "project_slug",
18+
"name": "project_id_or_slug",
1919
"in": "path",
20-
"description": "The slug of the project.",
20+
"description": "The id or slug of the project.",
2121
"required": true,
2222
"schema": {
2323
"type": "string"

‎api-docs/paths/projects/tag-values.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
}
1515
},
1616
{
17-
"name": "project_slug",
17+
"name": "project_id_or_slug",
1818
"in": "path",
19-
"description": "The slug of the project.",
19+
"description": "The id or slug of the project.",
2020
"required": true,
2121
"schema": {
2222
"type": "string"

‎api-docs/paths/projects/user-feedback.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
}
1515
},
1616
{
17-
"name": "project_slug",
17+
"name": "project_id_or_slug",
1818
"in": "path",
19-
"description": "The slug of the project.",
19+
"description": "The id or slug of the project.",
2020
"required": true,
2121
"schema": {
2222
"type": "string"
@@ -81,9 +81,9 @@
8181
}
8282
},
8383
{
84-
"name": "project_slug",
84+
"name": "project_id_or_slug",
8585
"in": "path",
86-
"description": "The slug of the project.",
86+
"description": "The id or slug of the project.",
8787
"required": true,
8888
"schema": {
8989
"type": "string"

0 commit comments

Comments
 (0)