Просмотр исходного кода

fix(api-docs): Adding the limit to this endpoint's docs (#24657)

William Mak 4 лет назад
Родитель
Сommit
3cce71a780

+ 1 - 1
api-docs/paths/events/tag-values.json

@@ -1,7 +1,7 @@
 {
   "get": {
     "tags": ["Events"],
-    "description": "Returns details for given tag key related to an issue.",
+    "description": "Returns details for given tag key related to an issue. \n\nWhen [paginated](/api/pagination) can return at most 1000 values.",
     "operationId": "List a Tag's Values Related to an Issue",
     "parameters": [
       {

+ 1 - 1
api-docs/paths/projects/tag-values.json

@@ -1,7 +1,7 @@
 {
   "get": {
     "tags": ["Projects"],
-    "description": "Return a list of values associated with this key.  The `query`\nparameter can be used to to perform a \"contains\" match on\nvalues.",
+    "description": "Return a list of values associated with this key.  The `query`\nparameter can be used to to perform a \"contains\" match on\nvalues. \n\nWhen [paginated](/api/pagination) can return at most 1000 values.",
     "operationId": "List a Tag's Values",
     "parameters": [
       {

+ 1 - 0
src/sentry/api/endpoints/group_tagkey_values.py

@@ -14,6 +14,7 @@ class GroupTagKeyValuesEndpoint(GroupEndpoint, EnvironmentMixin):
         ```````````````````
 
         Return a list of values associated with this key for an issue.
+        When paginated can return at most 1000 values.
 
         :pparam string issue_id: the ID of the issue to retrieve.
         :pparam string key: the tag key to look the values up for.

+ 1 - 0
src/sentry/api/endpoints/project_tagkey_values.py

@@ -16,6 +16,7 @@ class ProjectTagKeyValuesEndpoint(ProjectEndpoint, EnvironmentMixin):
         Return a list of values associated with this key.  The `query`
         parameter can be used to to perform a "contains" match on
         values.
+        When paginated can return at most 1000 values.
 
         :pparam string organization_slug: the slug of the organization.
         :pparam string project_slug: the slug of the project.