Skip to content

Update OpenAPI spec (6e6d80d) #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
workos-sdk-automation wants to merge 1 commit into from
Closed

Update OpenAPI spec (6e6d80d) #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .last-synced-sha
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
590c93fe53a45b4c27a1e3ce3d0670cb2456c6a5
6e6d80dffb7a8e792bfb98885ada4f3af65aa606
309 changes: 309 additions & 0 deletions spec/open-api-spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11214,6 +11214,231 @@ paths:
summary: List authorized applications
tags:
- organizations.authorized-applications
/organizations/{organization_id}/it_contacts:
get:
description: Get the IT contacts for an organization.
operationId: ItContactsController_list
parameters:
- name: organization_id
required: true
in: path
description: The ID of the organization.
schema:
type: string
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
Comment on lines +11217 to +11228

@greptile-apps greptile-apps Bot Aug 17, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Pagination cursors lack inputs

The response exposes before and after cursors for navigating the IT-contact list, but this operation accepts only organization_id. Generated clients therefore cannot submit a returned cursor to navigate to another page; add the supported pagination parameters or use a non-paginated response shape.

Knowledge Base Used: WorkOS API OpenAPI specification

Prompt To Fix With AI 
This is a comment left during a code review.
Path: spec/open-api-spec.yaml
Line: 11217-11228

Comment:
**Pagination cursors lack inputs**

The response exposes `before` and `after` cursors for navigating the IT-contact list, but this operation accepts only `organization_id`. Generated clients therefore cannot submit a returned cursor to navigate to another page; add the supported pagination parameters or use a non-paginated response shape.

**Knowledge Base Used:** [WorkOS API OpenAPI specification](https://app.greptile.com/workos/-/custom-context/knowledge-base/workos/openapi-spec/-/docs/api-openapi-spec.md)

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ItContactList'
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: A human-readable description of the error.
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
required:
- message
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: A human-readable description of the error.
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
required:
- message
summary: List IT contacts
tags:
- organizations.it-contacts
post:
description: >-
Add an IT contact to an organization. No Admin Portal invitation is
sent, though the contact is notified if the organization has a
connection certificate nearing expiry.
operationId: ItContactsController_create
parameters:
- name: organization_id
required: true
in: path
description: The ID of the organization.
schema:
type: string
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateItContactDto'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/ItContact'
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: A human-readable description of the error.
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
required:
- message
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: A human-readable description of the error.
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
required:
- message
'409':
description: The email address is already an IT contact of the organization.
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: The error code identifying the type of error.
example: it_contact_already_exists
const: it_contact_already_exists
message:
type: string
description: A human-readable description of the error.
example: Request could not be processed.
required:
- code
- message
'422':
description: Unprocessable Entity
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: A human-readable description of the error.
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
required:
- message
'503':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: The error code identifying the type of error.
example: concurrent_request
const: concurrent_request
message:
type: string
description: A human-readable description of the error.
example: Request could not be processed.
required:
- code
- message
summary: Create an IT contact
tags:
- organizations.it-contacts
/organizations/{organization_id}/it_contacts/{contact_id}:
delete:
description: Remove an IT contact from an organization.
operationId: ItContactsController_delete
parameters:
- name: organization_id
required: true
in: path
description: The ID of the organization.
schema:
type: string
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
- name: contact_id
required: true
in: path
description: The ID of the IT contact.
schema:
type: string
example: it_contact_01HXYZ123456789ABCDEFGHIJ
responses:
'204':
description: No Content
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: A human-readable description of the error.
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
required:
- message
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: A human-readable description of the error.
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
required:
- message
'503':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: The error code identifying the type of error.
example: concurrent_request
const: concurrent_request
message:
type: string
description: A human-readable description of the error.
example: Request could not be processed.
required:
- code
- message
summary: Delete an IT contact
tags:
- organizations.it-contacts
/portal/generate_link:
post:
description: Generate a Portal Link scoped to an Organization.
Expand Down Expand Up @@ -19809,6 +20034,8 @@ tags:
description: Manage authorized applications for organizations.
- name: organizations.feature-flags
description: Manage organization-scoped feature flags.
- name: organizations.it-contacts
description: Manage IT contacts for organizations.
- name: permissions
description: Manage permissions.
- name: pipes
Expand Down Expand Up @@ -21115,6 +21342,16 @@ components:
example: '2030-01-01T00:00:00.000Z'
required:
- name
CreateItContactDto:
type: object
properties:
email:
type: string
format: email
description: The email address of the IT contact.
example: it-contact@example.com
required:
- email
OrganizationDomainDataDto:
type: object
properties:
Expand Down Expand Up @@ -35585,6 +35822,78 @@ components:
- created_at
- updated_at
- value
ItContact:
type: object
properties:
object:
type: string
description: The IT Contact object.
example: it_contact
const: it_contact
id:
type: string
description: The unique ID of the IT Contact.
example: it_contact_01HXYZ123456789ABCDEFGHIJ
email:
type: string
format: email
description: The email address of the IT Contact.
example: it-contact@example.com
created_at:
format: date-time
type: string
description: An ISO 8601 timestamp.
example: '2026-01-15T12:00:00.000Z'
updated_at:
format: date-time
type: string
description: An ISO 8601 timestamp.
example: '2026-01-15T12:00:00.000Z'
required:
- object
- id
- email
- created_at
- updated_at
ItContactList:
type: object
properties:
object:
type: string
description: Indicates this is a list response.
const: list
data:
type: array
items:
$ref: '#/components/schemas/ItContact'
description: The list of records for the current page.
list_metadata:
type: object
properties:
before:
type:
- string
- 'null'
description: >-
An object ID that defines your place in the list. When the ID is
not present, you are at the start of the list.
example: it_contact_01HXYZ123456789ABCDEFGHIJ
after:
type:
- string
- 'null'
description: >-
An object ID that defines your place in the list. When the ID is
not present, you are at the end of the list.
example: it_contact_01HXYZ987654321KJIHGFEDCBA
required:
- before
- after
description: Pagination cursors for navigating between pages of results.
required:
- object
- data
- list_metadata
Organization:
type: object
properties:
Expand Down
Loading