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

feat(docs): Update retrieve event (#21551)

NisanthanNanthakumar 4 лет назад
Родитель
Сommit
970108da00

+ 1 - 1
api-docs/paths/events/project-event-details.json

@@ -25,7 +25,7 @@
       {
         "name": "event_id",
         "in": "path",
-        "description": "The ID of the event to retrieve (either the numeric primary-key or the hexadecimal ID as reported by the client)",
+        "description": "The ID of the event to retrieve. It is the hexadecimal ID as reported by the client.",
         "required": true,
         "schema": {
           "type": "string"

+ 2 - 2
src/sentry/api/endpoints/project_event_details.py

@@ -21,8 +21,8 @@ class ProjectEventDetailsEndpoint(ProjectEndpoint):
                                           event belongs to.
         :pparam string project_slug: the slug of the project the event
                                      belongs to.
-        :pparam string event_id: the id of the event to retrieve (either the
-                                 numeric primary-key or the hexadecimal id as
+        :pparam string event_id: the id of the event to retrieve.
+                                 It is the hexadecimal id as
                                  reported by the raven client)
         :auth: required
         """

+ 1 - 1
tests/apidocs/openapi-derefed.json

@@ -8559,7 +8559,7 @@
           {
             "name": "event_id",
             "in": "path",
-            "description": "The ID of the event to retrieve (either the numeric primary-key or the hexadecimal ID as reported by the client)",
+            "description": "The ID of the event to retrieve. It is the hexadecimal ID as reported by the client.",
             "required": true,
             "schema": {
               "type": "string"