Skip to content

Commit 3312991

Browse files
authored
chore: Update OpenAPI specs (again) (#184)
1 parent 041ec80 commit 3312991

File tree

4 files changed

+278
-54
lines changed

4 files changed

+278
-54
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
### Dev Users
3+
- Added new endpoint [`/dev-users.merge`](/beta/api-reference/dev-users/merge) for merging Dev users
4+
5+
### Groups
6+
- Added `member_rev_org` property to member objects returned by:
7+
- [`/groups.members.list`](/beta/api-reference/groups/group-members-list-post) (both GET and POST methods)
8+
9+
### Parts
10+
- Added `stage_validation_options` property to request body of:
11+
- [`/parts.create`](/beta/api-reference/parts/create)
12+
- [`/parts.update`](/beta/api-reference/parts/update)
13+
- Added `custom_fields` parameter to:
14+
- [`/parts.list`](/beta/api-reference/parts/list-post) (both GET and POST methods)
15+
16+
### Question Answers
17+
- Added `sources` property to question-answer object

fern/apis/beta/openapi-beta.yaml

Lines changed: 123 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6411,21 +6411,22 @@ components:
64116411
custom-schema-spec:
64126412
type: object
64136413
description: |
6414-
Requested custom schemas described abstractly. Every provided schema's
6415-
custom field must be specified, otherwise a bad request error is
6416-
returned. If a new custom schema specifier is provided, then it will be
6417-
added to the work, otherwise if a custom schema is omitted from the
6418-
specifier, it remains unmodified.
6414+
Custom schemas described using identifiers. Each custom field in the
6415+
request must have the corresponding schema specified; omission results
6416+
in a Bad Request error. If a custom schema is not included in the
6417+
specifier, it remains unchanged. For surfaces with human interactors,
6418+
it is recommended to provide tenant_fragment: true and
6419+
validate_required_fields: true.
64196420
properties:
64206421
apps:
64216422
type: array
6422-
description: List of apps that are requested.
6423+
description: List of apps.
64236424
items:
64246425
type: string
64256426
format: text
64266427
subtype:
64276428
type: string
6428-
description: Name of the subtype requested.
6429+
description: Name of the subtype.
64296430
format: text
64306431
tenant_fragment:
64316432
type: boolean
@@ -7712,6 +7713,28 @@ components:
77127713
- dev_users
77137714
title: dev-users-list-response
77147715
x-go-name: DevUsersListResponseBody
7716+
dev-users-merge-request:
7717+
type: object
7718+
description: Request object for merging Dev users.
7719+
properties:
7720+
primary_user:
7721+
type: string
7722+
description: The unique ID of the primary user.
7723+
format: id
7724+
secondary_user:
7725+
type: string
7726+
description: The unique ID of the secondary user.
7727+
format: id
7728+
required:
7729+
- primary_user
7730+
- secondary_user
7731+
title: dev-users-merge-request
7732+
dev-users-merge-response:
7733+
type: object
7734+
additionalProperties: false
7735+
description: Response object for request to merge Dev users.
7736+
title: dev-users-merge-response
7737+
x-go-name: DevUsersMergeResponseBody
77157738
dev-users-self-request:
77167739
type: object
77177740
additionalProperties: false
@@ -10895,6 +10918,8 @@ components:
1089510918
properties:
1089610919
member:
1089710920
$ref: '#/components/schemas/member-summary'
10921+
member_rev_org:
10922+
$ref: '#/components/schemas/rev-org-summary'
1089810923
required:
1089910924
- member
1090010925
title: group-members-list-response-member
@@ -14288,6 +14313,12 @@ components:
1428814313
items:
1428914314
type: string
1429014315
format: id
14316+
stage_validation_options:
14317+
type: array
14318+
description: |
14319+
The type of stage validations options when creating a part.
14320+
items:
14321+
$ref: '#/components/schemas/stage-validation-option-for-create'
1429114322
tags:
1429214323
type: array
1429314324
description: Tags associated with the part.
@@ -14428,6 +14459,9 @@ components:
1442814459
The cursor to resume iteration from. If not provided, then
1442914460
iteration starts from the beginning.
1443014461
format: text
14462+
custom_fields:
14463+
type: object
14464+
description: Filters for custom fields.
1443114465
limit:
1443214466
type: integer
1443314467
description: |
@@ -14533,6 +14567,13 @@ components:
1453314567
format: text
1453414568
owned_by:
1453514569
$ref: '#/components/schemas/parts-update-request-owned-by'
14570+
stage_validation_options:
14571+
type: array
14572+
description: |
14573+
The type of stage validations options when updating the stage or
14574+
the stage diagram of an object.
14575+
items:
14576+
$ref: '#/components/schemas/stage-validation-option-for-update'
1453614577
tags:
1453714578
$ref: '#/components/schemas/parts-update-request-tags'
1453814579
required:
@@ -14719,6 +14760,13 @@ components:
1471914760
type: string
1472014761
description: The Question.
1472114762
format: text
14763+
sources:
14764+
type: array
14765+
description: |
14766+
Details of the sources from which the question answer was
14767+
generated.
14768+
items:
14769+
$ref: '#/components/schemas/atom-summary'
1472214770
status:
1472314771
$ref: '#/components/schemas/question-answer-status'
1472414772
suggested_answer:
@@ -17678,7 +17726,9 @@ components:
1767817726
format: date-time
1767917727
snippet:
1768017728
type: string
17681-
description: Text snippet where the search hit occurred.
17729+
description: |
17730+
Concatenated text snippets from all search hits for this object.
17731+
This may contain duplicate content.
1768217732
format: text
1768317733
title: search-summary-base
1768417734
send-notification:
@@ -29008,9 +29058,8 @@ paths:
2900829058
Creates a new enterprise authentication connection for a Dev
2900929059
organization. This authentication connection will not be enabled by
2901029060
default for the organization and the user will need to explicitly
29011-
enable this. Keep in mind that at a time, only one authentication
29012-
connection can be enabled for a Dev organization. At present, only 5
29013-
enterprise connections can be created by an organization.
29061+
enable this. Only 5 authentication connections can be created by an
29062+
organization.
2901429063
operationId: dev-org-auth-connections-create
2901529064
requestBody:
2901629065
content:
@@ -29246,10 +29295,8 @@ paths:
2924629295
post:
2924729296
description: |
2924829297
Enable or disable an authentication connection for a Dev organization.
29249-
Currently, only 1 authentication connection can be enabled at a time.
29250-
When a new authentication connection is enabled, the connection which
29251-
is currently enabled for the Dev organization is automatically
29252-
disabled.
29298+
Atleast one authentication connection must be enabled for a Dev
29299+
organization.
2925329300
operationId: dev-org-auth-connections-toggle
2925429301
requestBody:
2925529302
content:
@@ -29790,6 +29837,48 @@ paths:
2979029837
x-fern-audiences:
2979129838
- docs
2979229839
- sdks
29840+
/dev-users.merge:
29841+
post:
29842+
description: |
29843+
Merges the identity of a secondary Dev user with the primary Dev user.
29844+
The account of the secondary Dev user will be deactivated and will no
29845+
longer be able to log into DevRev. All objects - issues, tickets, parts
29846+
etc. owned by the secondary Dev user will be transferred to the primary
29847+
Dev user.
29848+
operationId: dev-users-merge
29849+
requestBody:
29850+
content:
29851+
application/json:
29852+
schema:
29853+
$ref: '#/components/schemas/dev-users-merge-request'
29854+
required: true
29855+
responses:
29856+
"200":
29857+
content:
29858+
application/json:
29859+
schema:
29860+
$ref: '#/components/schemas/dev-users-merge-response'
29861+
description: Response object for request to merge Dev users.
29862+
"400":
29863+
$ref: '#/components/responses/bad-request'
29864+
"401":
29865+
$ref: '#/components/responses/unauthorized'
29866+
"403":
29867+
$ref: '#/components/responses/forbidden'
29868+
"404":
29869+
$ref: '#/components/responses/not-found'
29870+
"429":
29871+
$ref: '#/components/responses/too-many-requests'
29872+
"500":
29873+
$ref: '#/components/responses/internal-server-error'
29874+
"503":
29875+
$ref: '#/components/responses/service-unavailable'
29876+
summary: Merge Dev Users
29877+
tags:
29878+
- dev-users
29879+
x-fern-audiences:
29880+
- docs
29881+
- sdks
2979329882
/dev-users.self:
2979429883
get:
2979529884
description: Gets the authenticated user's information.
@@ -34483,6 +34572,12 @@ paths:
3448334572
schema:
3448434573
type: string
3448534574
format: text
34575+
- description: Filters for custom fields.
34576+
explode: false
34577+
in: query
34578+
name: custom_fields
34579+
schema:
34580+
type: object
3448634581
- description: |
3448734582
The maximum number of parts to return. The default is '50'.
3448834583
explode: false
@@ -37841,7 +37936,7 @@ paths:
3784137936
$ref: '#/components/responses/internal-server-error'
3784237937
"503":
3784337938
$ref: '#/components/responses/service-unavailable'
37844-
summary: Get Sla Tracker
37939+
summary: Get SLA Tracker
3784537940
tags:
3784637941
- slas
3784737942
x-fern-audiences:
@@ -37877,7 +37972,7 @@ paths:
3787737972
$ref: '#/components/responses/internal-server-error'
3787837973
"503":
3787937974
$ref: '#/components/responses/service-unavailable'
37880-
summary: Get Sla Tracker (POST)
37975+
summary: Get SLA Tracker (POST)
3788137976
tags:
3788237977
- slas
3788337978
x-fern-audiences:
@@ -37998,7 +38093,7 @@ paths:
3799838093
$ref: '#/components/responses/internal-server-error'
3799938094
"503":
3800038095
$ref: '#/components/responses/service-unavailable'
38001-
summary: List Sla Trackers
38096+
summary: List SLA Trackers
3800238097
tags:
3800338098
- slas
3800438099
x-fern-audiences:
@@ -38032,7 +38127,7 @@ paths:
3803238127
$ref: '#/components/responses/internal-server-error'
3803338128
"503":
3803438129
$ref: '#/components/responses/service-unavailable'
38035-
summary: List Sla Trackers (POST)
38130+
summary: List SLA Trackers (POST)
3803638131
tags:
3803738132
- slas
3803838133
x-fern-audiences:
@@ -38069,7 +38164,7 @@ paths:
3806938164
$ref: '#/components/responses/internal-server-error'
3807038165
"503":
3807138166
$ref: '#/components/responses/service-unavailable'
38072-
summary: Remove-Metric Sla Trackers
38167+
summary: Remove SLA Tracker Metric
3807338168
tags:
3807438169
- slas
3807538170
x-fern-audiences:
@@ -38106,7 +38201,7 @@ paths:
3810638201
$ref: '#/components/responses/internal-server-error'
3810738202
"503":
3810838203
$ref: '#/components/responses/service-unavailable'
38109-
summary: Assign Slas
38204+
summary: Assign SLAs
3811038205
tags:
3811138206
- slas
3811238207
x-fern-audiences:
@@ -38141,7 +38236,7 @@ paths:
3814138236
$ref: '#/components/responses/internal-server-error'
3814238237
"503":
3814338238
$ref: '#/components/responses/service-unavailable'
38144-
summary: Create Sla
38239+
summary: Create SLA
3814538240
tags:
3814638241
- slas
3814738242
x-fern-audiences:
@@ -38181,7 +38276,7 @@ paths:
3818138276
$ref: '#/components/responses/internal-server-error'
3818238277
"503":
3818338278
$ref: '#/components/responses/service-unavailable'
38184-
summary: Get Sla
38279+
summary: Get SLA
3818538280
tags:
3818638281
- slas
3818738282
x-fern-audiences:
@@ -38217,7 +38312,7 @@ paths:
3821738312
$ref: '#/components/responses/internal-server-error'
3821838313
"503":
3821938314
$ref: '#/components/responses/service-unavailable'
38220-
summary: Get Sla (POST)
38315+
summary: Get SLA (POST)
3822138316
tags:
3822238317
- slas
3822338318
x-fern-audiences:
@@ -38312,7 +38407,7 @@ paths:
3831238407
$ref: '#/components/responses/internal-server-error'
3831338408
"503":
3831438409
$ref: '#/components/responses/service-unavailable'
38315-
summary: List Slas
38410+
summary: List SLAs
3831638411
tags:
3831738412
- slas
3831838413
x-fern-audiences:
@@ -38346,7 +38441,7 @@ paths:
3834638441
$ref: '#/components/responses/internal-server-error'
3834738442
"503":
3834838443
$ref: '#/components/responses/service-unavailable'
38349-
summary: List Slas (POST)
38444+
summary: List SLAs (POST)
3835038445
tags:
3835138446
- slas
3835238447
x-fern-audiences:
@@ -38383,7 +38478,7 @@ paths:
3838338478
$ref: '#/components/responses/internal-server-error'
3838438479
"503":
3838538480
$ref: '#/components/responses/service-unavailable'
38386-
summary: Transition Slas
38481+
summary: Transition SLAs
3838738482
tags:
3838838483
- slas
3838938484
x-fern-audiences:
@@ -38420,7 +38515,7 @@ paths:
3842038515
$ref: '#/components/responses/internal-server-error'
3842138516
"503":
3842238517
$ref: '#/components/responses/service-unavailable'
38423-
summary: Update Sla
38518+
summary: Update SLA
3842438519
tags:
3842538520
- slas
3842638521
x-fern-audiences:
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
2+
### Groups
3+
- [`/groups.members.list`](/public/api-reference/groups/group-members-list-post): Added new property `member_rev_org` to response schema for both GET and POST methods
4+
5+
### Parts
6+
Added new property `stage_validation_options` to request body for:
7+
- [`/parts.create`](/public/api-reference/parts/create)
8+
- [`/parts.update`](/public/api-reference/parts/update)

0 commit comments

Comments
 (0)