Skip to content

Commit e08bbc1

Browse files
committed
Add operation ids
1 parent 9578952 commit e08bbc1

File tree

4 files changed

+323
-306
lines changed

4 files changed

+323
-306
lines changed

openapi.yaml

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ servers:
77
paths:
88
/users/@me:
99
get:
10+
summary: Get information about the authenticated user
11+
operationId: getAuthenticatedUser
1012
tags:
1113
- users
1214
responses:
@@ -26,9 +28,10 @@ paths:
2628
- BearerAuth: [ ]
2729
/search:
2830
post:
31+
summary: Search for projects by name or description
32+
operationId: searchProjects
2933
tags:
3034
- projects
31-
summary: Search for projects by name or description
3235
requestBody:
3336
required: true
3437
content:
@@ -44,9 +47,10 @@ paths:
4447
$ref: '#/components/schemas/ProjectListResponse'
4548
/projects:
4649
get:
50+
summary: List all projects
51+
operationId: listProjects
4752
tags:
4853
- projects
49-
summary: List all projects
5054
responses:
5155
'200':
5256
description: A list of projects
@@ -56,9 +60,10 @@ paths:
5660
$ref: '#/components/schemas/ProjectListResponse'
5761
/project/{name}:
5862
get:
63+
summary: Get a single project by name
64+
operationId: getProject
5965
tags:
6066
- projects
61-
summary: Get a single project by name
6267
parameters:
6368
- name: name
6469
in: path
@@ -77,9 +82,10 @@ paths:
7782
$ref: '#/components/responses/ProjectNotFound'
7883
/builds/{project}:
7984
get:
85+
summary: List builds for a project
86+
operationId: getProjectBuilds
8087
tags:
8188
- builds
82-
summary: List builds for a project
8389
parameters:
8490
- name: project
8591
in: path
@@ -98,9 +104,10 @@ paths:
98104
$ref: '#/components/responses/ProjectNotFound'
99105
/builds/{project}/{channel}/:
100106
get:
107+
summary: Get all builds for a project in a specific release channel
108+
operationId: getProjectBuildsInChannel
101109
tags:
102110
- builds
103-
summary: Get all builds for a project in a specific release channel
104111
parameters:
105112
- name: project
106113
in: path
@@ -125,9 +132,10 @@ paths:
125132
$ref: '#/components/responses/ProjectOrChannelNotFound'
126133
/builds/{project}/{channel}/latest:
127134
get:
135+
summary: Get the latest build for a project in a specific release channel
136+
operationId: getLatestProjectBuildInChannel
128137
tags:
129138
- builds
130-
summary: Get the latest build for a project in a specific release channel
131139
parameters:
132140
- name: project
133141
in: path
@@ -152,9 +160,10 @@ paths:
152160
$ref: '#/components/responses/ProjectOrChannelNotFound'
153161
/builds/{project}/{channel}/{build}:
154162
get:
163+
summary: Get a specific build by its build ID for a project in a specific release channel
164+
operationId: getProjectBuild
155165
tags:
156166
- builds
157-
summary: Get a specific build by its build ID for a project in a specific release channel
158167
parameters:
159168
- name: project
160169
in: path

0 commit comments

Comments
 (0)