Browse Source

fix(docs) Update token placeholder in docs and improve titles (#10439)

Tokens do not need to be base64 encoded.

* Fix titles to be less ambiguous.
* Sync titles with latest TOC change
* Correct more titles
Mark Story 6 years ago
parent
commit
3a97746756

+ 1 - 1
api-docs/generator.py

@@ -321,7 +321,7 @@ def format_request(endpoint, scenario_map):
     lines = [
         u"{} {} HTTP/1.1".format(request['method'], request['path']),
         'Host: sentry.io',
-        'Authorization: Bearer {base64-encoded-key-here}',
+        'Authorization: Bearer <token>',
     ]
     lines.extend(format_headers(request['headers']))
     if request['data']:

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

@@ -25,8 +25,8 @@ class GroupEventsLatestEndpoint(GroupEndpoint):
     @attach_scenarios([get_latest_group_sample_scenario])
     def get(self, request, group):
         """
-        Retrieve Latest Event
-        `````````````````````
+        Retrieve the Latest Event for an Issue
+        ``````````````````````````````````````
 
         Retrieves the details of the latest event for an issue.
 

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

@@ -25,8 +25,8 @@ class GroupEventsOldestEndpoint(GroupEndpoint):
     @attach_scenarios([get_oldest_group_sample_scenario])
     def get(self, request, group):
         """
-        Retrieve Oldest Event
-        `````````````````````
+        Retrieve the Oldest Event for an Issue
+        ``````````````````````````````````````
 
         Retrieves the details of the oldest event for an issue.
 

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

@@ -23,8 +23,8 @@ class OrganizationReleaseFilesEndpoint(OrganizationReleasesBaseEndpoint):
 
     def get(self, request, organization, version):
         """
-        List a Release's Files
-        ``````````````````````
+        List an Organization Release's Files
+        ````````````````````````````````````
 
         Retrieve a list of files for a given release.
 

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

@@ -56,8 +56,8 @@ class ProjectReleaseFilesEndpoint(ProjectEndpoint):
     @attach_scenarios([list_files_scenario])
     def get(self, request, project, version):
         """
-        List a Release's Files
-        ``````````````````````
+        List a Project Release's Files
+        ``````````````````````````````
 
         Retrieve a list of files for a given release.