Skip to content

Commit

Permalink
feat(api-idorslug): Rename Path paramaters to project_id_or_slug (#…
Browse files Browse the repository at this point in the history 
…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>
  • Loading branch information
@iamrajjoshi @getsantry
iamrajjoshi and getsantry[bot] authored Apr 29, 2024
1 parent 368de5d commit 8ec16e1
Show file tree
Hide file tree
Showing 155 changed files with 1,114 additions and 815 deletions.
26 changes: 13 additions & 13 deletions api-docs/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,34 +114,34 @@
"/api/0/projects/": {
"$ref": "paths/projects/index.json"
},
"/api/0/projects/{organization_slug}/{project_slug}/files/dsyms/": {
"/api/0/projects/{organization_slug}/{project_id_or_slug}/files/dsyms/": {
"$ref": "paths/projects/dsyms.json"
},
"/api/0/projects/{organization_slug}/{project_slug}/users/": {
"/api/0/projects/{organization_slug}/{project_id_or_slug}/users/": {
"$ref": "paths/projects/users.json"
},
"/api/0/projects/{organization_slug}/{project_slug}/tags/{key}/values/": {
"/api/0/projects/{organization_slug}/{project_id_or_slug}/tags/{key}/values/": {
"$ref": "paths/projects/tag-values.json"
},
"/api/0/projects/{organization_slug}/{project_slug}/stats/": {
"/api/0/projects/{organization_slug}/{project_id_or_slug}/stats/": {
"$ref": "paths/projects/stats.json"
},
"/api/0/projects/{organization_slug}/{project_slug}/user-feedback/": {
"/api/0/projects/{organization_slug}/{project_id_or_slug}/user-feedback/": {
"$ref": "paths/projects/user-feedback.json"
},
"/api/0/projects/{organization_slug}/{project_slug}/hooks/": {
"/api/0/projects/{organization_slug}/{project_id_or_slug}/hooks/": {
"$ref": "paths/projects/service-hooks.json"
},
"/api/0/projects/{organization_slug}/{project_slug}/hooks/{hook_id}/": {
"/api/0/projects/{organization_slug}/{project_id_or_slug}/hooks/{hook_id}/": {
"$ref": "paths/projects/service-hook-details.json"
},
"/api/0/projects/{organization_slug}/{project_slug}/events/{event_id}/": {
"/api/0/projects/{organization_slug}/{project_id_or_slug}/events/{event_id}/": {
"$ref": "paths/events/project-event-details.json"
},
"/api/0/projects/{organization_slug}/{project_slug}/events/": {
"/api/0/projects/{organization_slug}/{project_id_or_slug}/events/": {
"$ref": "paths/events/project-events.json"
},
"/api/0/projects/{organization_slug}/{project_slug}/issues/": {
"/api/0/projects/{organization_slug}/{project_id_or_slug}/issues/": {
"$ref": "paths/events/project-issues.json"
},
"/api/0/organizations/{organization_slug}/issues/{issue_id}/tags/{key}/values/": {
Expand Down Expand Up @@ -174,19 +174,19 @@
"/api/0/organizations/{organization_slug}/releases/{version}/files/": {
"$ref": "paths/releases/release-files.json"
},
"/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/files/": {
"/api/0/projects/{organization_slug}/{project_id_or_slug}/releases/{version}/files/": {
"$ref": "paths/releases/project-release-files.json"
},
"/api/0/organizations/{organization_slug}/releases/{version}/files/{file_id}/": {
"$ref": "paths/releases/release-file.json"
},
"/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/files/{file_id}/": {
"/api/0/projects/{organization_slug}/{project_id_or_slug}/releases/{version}/files/{file_id}/": {
"$ref": "paths/releases/project-release-file.json"
},
"/api/0/organizations/{organization_slug}/releases/{version}/commits/": {
"$ref": "paths/releases/organization-release-commits.json"
},
"/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/commits/": {
"/api/0/projects/{organization_slug}/{project_id_or_slug}/releases/{version}/commits/": {
"$ref": "paths/releases/project-release-commits.json"
},
"/api/0/organizations/{organization_slug}/releases/{version}/commitfiles/": {
Expand Down
34 changes: 8 additions & 26 deletions api-docs/paths/events/project-event-details.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project the event belongs to.",
"description": "The id or slug of the project the event belongs to.",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -154,10 +154,7 @@
71,
" return fn.apply(this, wrappedArguments);"
],
[
72,
" // tslint:enable:no-unsafe-any"
],
[72, " // tslint:enable:no-unsafe-any"],
[73, " }"],
[74, " catch (ex) {"],
[75, " ignoreNextOnError();"],
Expand All @@ -182,10 +179,7 @@
"instructionAddr": null,
"context": [
[69, " */"],
[
70,
" triggerAsync: function triggerAsync() {"
],
[70, " triggerAsync: function triggerAsync() {"],
[71, " var args = arguments,"],
[72, " me = this;"],
[73, " _.nextTick(function () {"],
Expand Down Expand Up @@ -227,30 +221,18 @@
"context": [
[76, "/*!"],
[77, " Copyright (c) 2018 Jed Watson."],
[
78,
" Licensed under the MIT License (MIT), see"
],
[
79,
" http://jedwatson.github.io/react-select"
],
[78, " Licensed under the MIT License (MIT), see"],
[79, " http://jedwatson.github.io/react-select"],
[80, "*/"],
[
81,
"{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}"
],
[82, "/*!"],
[83, " * JavaScript Cookie v2.2.1"],
[
84,
" * https://github.com/js-cookie/js-cookie"
],
[84, " * https://github.com/js-cookie/js-cookie"],
[85, " *"],
[
86,
" * Copyright 2006, 2015 Klaus Hartl & Fagner Brack"
]
[86, " * Copyright 2006, 2015 Klaus Hartl & Fagner Brack"]
],
"symbolAddr": null,
"trust": null,
Expand Down
4 changes: 2 additions & 2 deletions api-docs/paths/events/project-events.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project the events belong to.",
"description": "The id or slug of the project the events belong to.",
"required": true,
"schema": {
"type": "string"
Expand Down
12 changes: 6 additions & 6 deletions api-docs/paths/events/project-issues.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project the issues belong to.",
"description": "The id or slug of the project the issues belong to.",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -152,9 +152,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project the issues belong to.",
"description": "The id or slug of the project the issues belong to.",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -313,9 +313,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project the issues belong to.",
"description": "The id or slug of the project the issues belong to.",
"required": true,
"schema": {
"type": "string"
Expand Down
12 changes: 6 additions & 6 deletions api-docs/paths/projects/dsyms.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project to list the DIFs of.",
"description": "The id or slug of the project to list the DIFs of.",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -58,9 +58,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project to upload a file to.",
"description": "The id or slug of the project to upload a file to.",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -126,9 +126,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project to delete the DIF.",
"description": "The id or slug of the project to delete the DIF.",
"required": true,
"schema": {
"type": "string"
Expand Down
12 changes: 6 additions & 6 deletions api-docs/paths/projects/service-hook-details.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project the client keys belong to.",
"description": "The id or slug of the project the client keys belong to.",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -79,9 +79,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project the client keys belong to.",
"description": "The id or slug of the project the client keys belong to.",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -175,9 +175,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project the client keys belong to.",
"description": "The id or slug of the project the client keys belong to.",
"required": true,
"schema": {
"type": "string"
Expand Down
8 changes: 4 additions & 4 deletions api-docs/paths/projects/service-hooks.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project the client keys belong to.",
"description": "The id or slug of the project the client keys belong to.",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -75,9 +75,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project the client keys belong to.",
"description": "The id or slug of the project the client keys belong to.",
"required": true,
"schema": {
"type": "string"
Expand Down
4 changes: 2 additions & 2 deletions api-docs/paths/projects/stats.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project.",
"description": "The id or slug of the project.",
"required": true,
"schema": {
"type": "string"
Expand Down
4 changes: 2 additions & 2 deletions api-docs/paths/projects/tag-values.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project.",
"description": "The id or slug of the project.",
"required": true,
"schema": {
"type": "string"
Expand Down
8 changes: 4 additions & 4 deletions api-docs/paths/projects/user-feedback.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project.",
"description": "The id or slug of the project.",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -81,9 +81,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project.",
"description": "The id or slug of the project.",
"required": true,
"schema": {
"type": "string"
Expand Down
4 changes: 2 additions & 2 deletions api-docs/paths/projects/users.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project.",
"description": "The id or slug of the project.",
"required": true,
"schema": {
"type": "string"
Expand Down
4 changes: 2 additions & 2 deletions api-docs/paths/releases/project-release-commits.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project the release belongs to.",
"description": "The id or slug of the project the release belongs to.",
"required": true,
"schema": {
"type": "string"
Expand Down
12 changes: 6 additions & 6 deletions api-docs/paths/releases/project-release-file.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project.",
"description": "The id or slug of the project.",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -99,9 +99,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project.",
"description": "The id or slug of the project.",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -198,9 +198,9 @@
}
},
{
"name": "project_slug",
"name": "project_id_or_slug",
"in": "path",
"description": "The slug of the project.",
"description": "The id or slug of the project.",
"required": true,
"schema": {
"type": "string"
Expand Down
Loading

0 comments on commit 8ec16e1

Please sign in to comment.