Skip to content

Commit f8c34a0

Browse files
committed
chore: Update OpenAPI specs
1 parent fc9cca8 commit f8c34a0

File tree

2 files changed

+221
-0
lines changed

2 files changed

+221
-0
lines changed

fern/apis/beta/openapi-beta.yaml

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4801,6 +4801,13 @@ components:
48014801
enum:
48024802
- last_n_days
48034803
- next_n_days
4804+
definedness:
4805+
type: string
4806+
description: Indicates whether this evaluation can change in the future.
4807+
enum:
4808+
- immutable
4809+
- mutable
4810+
- undefined
48044811
delete-rev-users-personal-data-request:
48054812
type: object
48064813
description: Request object to delete a contact's information.
@@ -8701,6 +8708,32 @@ components:
87018708
- incident
87028709
title: incidents-update-response
87038710
x-go-name: IncidentsUpdateResponseBody
8711+
instant-evaluation:
8712+
type: object
8713+
properties:
8714+
at:
8715+
type: string
8716+
description: The time instant evaluated.
8717+
example: "2023-01-01T12:00:00.000Z"
8718+
format: date-time
8719+
definedness:
8720+
$ref: '#/components/schemas/definedness'
8721+
is_active:
8722+
type: boolean
8723+
description: |
8724+
Active state of the organization schedule at the time instant.
8725+
next_transition:
8726+
type: string
8727+
description: |
8728+
Next instant at which the active state of the organization schedule
8729+
changes, for example, if the schedule is currently off, the next
8730+
instant at which it will be on.
8731+
example: "2023-01-01T12:00:00.000Z"
8732+
format: date-time
8733+
required:
8734+
- at
8735+
- definedness
8736+
title: instant-evaluation
87048737
issue:
87058738
allOf:
87068739
- $ref: '#/components/schemas/work-base'
@@ -9917,6 +9950,38 @@ components:
99179950
- org_schedule
99189951
title: org-schedules-create-response
99199952
x-go-name: OrgSchedulesCreateResponseBody
9953+
org-schedules-evaluate-request:
9954+
type: object
9955+
properties:
9956+
id:
9957+
type: string
9958+
description: Organization schedule ID.
9959+
instants:
9960+
type: array
9961+
description: Time instants to evaluate the organization schedule for.
9962+
example:
9963+
- "2023-01-01T12:00:00.000Z"
9964+
items:
9965+
type: string
9966+
format: date-time
9967+
minItems: 1
9968+
required:
9969+
- id
9970+
- instants
9971+
title: org-schedules-evaluate-request
9972+
org-schedules-evaluate-response:
9973+
type: object
9974+
properties:
9975+
instant_evaluations:
9976+
type: array
9977+
description: |
9978+
The evaluations for the given time instants in the requested order.
9979+
items:
9980+
$ref: '#/components/schemas/instant-evaluation'
9981+
required:
9982+
- instant_evaluations
9983+
title: org-schedules-evaluate-response
9984+
x-go-name: OrgSchedulesEvaluateResponseBody
99209985
org-schedules-get-request:
99219986
type: object
99229987
properties:
@@ -25041,6 +25106,86 @@ paths:
2504125106
x-fern-audiences:
2504225107
- docs
2504325108
- sdks
25109+
/org-schedules.evaluate:
25110+
get:
25111+
description: Evaluates an organization's schedule at specified instants.
25112+
operationId: org-schedules-evaluate
25113+
parameters:
25114+
- description: Organization schedule ID.
25115+
explode: false
25116+
in: query
25117+
name: id
25118+
required: true
25119+
schema:
25120+
type: string
25121+
- description: Time instants to evaluate the organization schedule for.
25122+
explode: false
25123+
in: query
25124+
name: instants
25125+
required: true
25126+
schema:
25127+
type: array
25128+
example:
25129+
- "2023-01-01T12:00:00.000Z"
25130+
items:
25131+
type: string
25132+
format: date-time
25133+
minItems: 1
25134+
responses:
25135+
"200":
25136+
content:
25137+
application/json:
25138+
schema:
25139+
$ref: '#/components/schemas/org-schedules-evaluate-response'
25140+
"400":
25141+
$ref: '#/components/responses/bad-request'
25142+
"401":
25143+
$ref: '#/components/responses/unauthorized'
25144+
"403":
25145+
$ref: '#/components/responses/forbidden'
25146+
"429":
25147+
$ref: '#/components/responses/too-many-requests'
25148+
"500":
25149+
$ref: '#/components/responses/internal-server-error'
25150+
"503":
25151+
$ref: '#/components/responses/service-unavailable'
25152+
tags:
25153+
- schedules
25154+
x-fern-audiences:
25155+
- docs
25156+
x-request-name: OrgSchedulesEvaluateQuery
25157+
post:
25158+
description: Evaluates an organization's schedule at specified instants.
25159+
operationId: org-schedules-evaluate-post
25160+
requestBody:
25161+
content:
25162+
application/json:
25163+
schema:
25164+
$ref: '#/components/schemas/org-schedules-evaluate-request'
25165+
required: true
25166+
responses:
25167+
"200":
25168+
content:
25169+
application/json:
25170+
schema:
25171+
$ref: '#/components/schemas/org-schedules-evaluate-response'
25172+
"400":
25173+
$ref: '#/components/responses/bad-request'
25174+
"401":
25175+
$ref: '#/components/responses/unauthorized'
25176+
"403":
25177+
$ref: '#/components/responses/forbidden'
25178+
"429":
25179+
$ref: '#/components/responses/too-many-requests'
25180+
"500":
25181+
$ref: '#/components/responses/internal-server-error'
25182+
"503":
25183+
$ref: '#/components/responses/service-unavailable'
25184+
tags:
25185+
- schedules
25186+
x-fern-audiences:
25187+
- docs
25188+
- sdks
2504425189
/org-schedules.get:
2504525190
get:
2504625191
description: Gets an organization schedule.
@@ -30848,6 +30993,44 @@ paths:
3084830993
x-fern-audiences:
3084930994
- docs
3085030995
- sdks
30996+
/webhooks.event:
30997+
post:
30998+
description: |
30999+
Describes a webhook invocation for an event from DevRev to a webhook's
31000+
target URL, where the receiving handler must implement the specified
31001+
protocol. Note the documented endpoint is for exposition and not
31002+
provided by DevRev.
31003+
operationId: webhooks-event
31004+
requestBody:
31005+
content:
31006+
application/json:
31007+
schema:
31008+
$ref: '#/components/schemas/webhook-event-request'
31009+
required: true
31010+
responses:
31011+
"200":
31012+
content:
31013+
application/json:
31014+
schema:
31015+
$ref: '#/components/schemas/webhook-event-response'
31016+
"400":
31017+
$ref: '#/components/responses/bad-request'
31018+
"401":
31019+
$ref: '#/components/responses/unauthorized'
31020+
"403":
31021+
$ref: '#/components/responses/forbidden'
31022+
"429":
31023+
$ref: '#/components/responses/too-many-requests'
31024+
"500":
31025+
$ref: '#/components/responses/internal-server-error'
31026+
"503":
31027+
$ref: '#/components/responses/service-unavailable'
31028+
tags:
31029+
- webhooks
31030+
x-fern-audiences:
31031+
- docs
31032+
- sdks
31033+
x-fern-webhook: true
3085131034
/webhooks.fetch:
3085231035
post:
3085331036
description: Fetches an object via webhook.

fern/apis/public/openapi-public.yaml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11115,6 +11115,44 @@ paths:
1111511115
x-fern-audiences:
1111611116
- docs
1111711117
- sdks
11118+
/webhooks.event:
11119+
post:
11120+
description: |
11121+
Describes a webhook invocation for an event from DevRev to a webhook's
11122+
target URL, where the receiving handler must implement the specified
11123+
protocol. Note the documented endpoint is for exposition and not
11124+
provided by DevRev.
11125+
operationId: webhooks-event
11126+
requestBody:
11127+
content:
11128+
application/json:
11129+
schema:
11130+
$ref: '#/components/schemas/webhook-event-request'
11131+
required: true
11132+
responses:
11133+
"200":
11134+
content:
11135+
application/json:
11136+
schema:
11137+
$ref: '#/components/schemas/webhook-event-response'
11138+
"400":
11139+
$ref: '#/components/responses/bad-request'
11140+
"401":
11141+
$ref: '#/components/responses/unauthorized'
11142+
"403":
11143+
$ref: '#/components/responses/forbidden'
11144+
"429":
11145+
$ref: '#/components/responses/too-many-requests'
11146+
"500":
11147+
$ref: '#/components/responses/internal-server-error'
11148+
"503":
11149+
$ref: '#/components/responses/service-unavailable'
11150+
tags:
11151+
- webhooks
11152+
x-fern-audiences:
11153+
- docs
11154+
- sdks
11155+
x-fern-webhook: true
1111811156
/webhooks.get:
1111911157
get:
1112011158
description: Gets the requested webhook's information.

0 commit comments

Comments
 (0)