openapi: Set summary for paths

This shows up in e.g. reDoc, while the description does not. We will add
more detailed descriptions later.

Signed-off-by: Stephen Finucane <[email protected]>

Author: stephenfin

docs/api/schemas/latest/patchwork.yaml

@@ -17,7 +17,7 @@ info:
 paths:
   /api:
     get:
-      description: List API resources.
+      summary: List API resources.
       operationId: api_list
       parameters: []
       responses:
@@ -31,7 +31,7 @@ paths:
         - api
   /api/bundles:
     get:
-      description: List bundles.
+      summary: List bundles.
       operationId: bundles_list
       parameters:
         - $ref: '#/components/parameters/Page'
@@ -74,7 +74,7 @@ paths:
       tags:
         - bundles
     post:
-      description: Create a bundle.
+      summary: Create a bundle.
       operationId: bundles_create
       security:
         - basicAuth: []
@@ -112,7 +112,7 @@ paths:
           title: ID
           type: integer
     get:
-      description: Show a bundle.
+      summary: Show a bundle.
       operationId: bundles_read
       responses:
         '200':
@@ -130,7 +130,7 @@ paths:
       tags:
         - bundles
     patch:
-      description: Update a bundle (partial).
+      summary: Update a bundle (partial).
       operationId: bundles_partial_update
       security:
         - basicAuth: []
@@ -165,7 +165,10 @@ paths:
       tags:
         - bundles
     put:
-      description: Update a bundle.
+      summary: Update a bundle.
+      description:
+        Update an existing bundle.
+        The bundle must be owned by the currently authenticated user.
       operationId: bundles_update
       security:
         - basicAuth: []
@@ -201,7 +204,7 @@ paths:
         - bundles
   /api/covers:
     get:
-      description: List cover letters.
+      summary: List cover letters.
       operationId: covers_list
       parameters:
         - $ref: '#/components/parameters/Page'
@@ -262,7 +265,7 @@ paths:
           title: ID
           type: integer
     get:
-      description: Show a cover letter.
+      summary: Show a cover letter.
       operationId: covers_read
       responses:
         '200':
@@ -290,7 +293,7 @@ paths:
           title: ID
           type: integer
     get:
-      description: List comments
+      summary: List cover letter comments
       operationId: cover_comments_list
       parameters:
         - $ref: '#/components/parameters/Page'
@@ -334,7 +337,7 @@ paths:
           title: Comment ID
           type: integer
     get:
-      description: Show a cover comment.
+      summary: Show a cover letter comment.
       operationId: cover_comments_read
       responses:
         '200':
@@ -352,7 +355,7 @@ paths:
       tags:
         - comments
     patch:
-      description: Update a cover comment (partial).
+      summary: Update a cover letter comment (partial).
       operationId: cover_comments_partial_update
       requestBody:
         $ref: '#/components/requestBodies/Comment'
@@ -385,7 +388,7 @@ paths:
         - comments
   /api/events:
     get:
-      description: List events.
+      summary: List events.
       operationId: events_list
       parameters:
         - $ref: '#/components/parameters/Page'
@@ -481,7 +484,7 @@ paths:
         - events
   /api/patches:
     get:
-      description: List patches.
+      summary: List patches.
       operationId: patches_list
       parameters:
         - $ref: '#/components/parameters/Page'
@@ -570,7 +573,7 @@ paths:
           title: ID
           type: integer
     get:
-      description: Show a patch.
+      summary: Show a patch.
       operationId: patches_read
       responses:
         '200':
@@ -588,7 +591,7 @@ paths:
       tags:
         - patches
     patch:
-      description: Update a patch (partial).
+      summary: Update a patch (partial).
       operationId: patches_partial_update
       security:
         - basicAuth: []
@@ -679,7 +682,7 @@ paths:
           title: ID
           type: integer
     get:
-      description: List comments
+      summary: List comments
       operationId: patch_comments_list
       parameters:
         - $ref: '#/components/parameters/Page'
@@ -723,7 +726,7 @@ paths:
           title: Comment ID
           type: integer
     get:
-      description: Show a patch comment.
+      summary: Show a patch comment.
       operationId: patch_comments_read
       responses:
         '200':
@@ -741,7 +744,7 @@ paths:
       tags:
         - comments
     patch:
-      description: Update a patch comment (partial).
+      summary: Update a patch comment (partial).
       operationId: patch_comments_partial_update
       requestBody:
         $ref: '#/components/requestBodies/Comment'
@@ -782,7 +785,7 @@ paths:
           title: Patch ID
           type: integer
     get:
-      description: List checks.
+      summary: List checks.
       operationId: checks_list
       parameters:
         - $ref: '#/components/parameters/Page'
@@ -835,7 +838,7 @@ paths:
       tags:
         - checks
     post:
-      description: Create a check.
+      summary: Create a check.
       operationId: checks_create
       security:
         - basicAuth: []
@@ -886,7 +889,7 @@ paths:
           title: Check ID
           type: integer
     get:
-      description: Show a check.
+      summary: Show a check.
       operationId: checks_read
       responses:
         '200':
@@ -905,7 +908,7 @@ paths:
         - checks
   /api/people:
     get:
-      description: List people.
+      summary: List people.
       operationId: people_list
       security:
         - basicAuth: []
@@ -945,7 +948,7 @@ paths:
           title: ID
           type: integer
     get:
-      description: Show a person.
+      summary: Show a person.
       operationId: people_read
       security:
         - basicAuth: []
@@ -973,7 +976,7 @@ paths:
         - people
   /api/projects:
     get:
-      description: List projects.
+      summary: List projects.
       operationId: projects_list
       parameters:
         - $ref: '#/components/parameters/Page'
@@ -1005,7 +1008,7 @@ paths:
           # TODO: Add regex?
           type: string
     get:
-      description: Show a project.
+      summary: Show a project.
       operationId: projects_read
       responses:
         '200':
@@ -1023,7 +1026,7 @@ paths:
       tags:
         - projects
     patch:
-      description: Update a project (partial).
+      summary: Update a project (partial).
       operationId: projects_partial_update
       security:
         - basicAuth: []
@@ -1094,7 +1097,7 @@ paths:
         - projects
   /api/series:
     get:
-      description: List series.
+      summary: List series.
       operationId: series_list
       parameters:
         - $ref: '#/components/parameters/Page'
@@ -1139,7 +1142,7 @@ paths:
           title: ID
           type: integer
     get:
-      description: Show a series.
+      summary: Show a series.
       operationId: series_read
       responses:
         '200':
@@ -1158,7 +1161,7 @@ paths:
         - series
   /api/users:
     get:
-      description: List users.
+      summary: List users.
       operationId: users_list
       security:
         - basicAuth: []
@@ -1198,7 +1201,7 @@ paths:
           title: ID
           type: integer
     get:
-      description: Show a user.
+      summary: Show a user.
       operationId: users_read
       security:
         - basicAuth: []
@@ -1225,7 +1228,7 @@ paths:
       tags:
         - users
     patch:
-      description: Update a user (partial).
+      summary: Update a user (partial).
       operationId: users_partial_update
       security:
         - basicAuth: []