Skip to content
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.

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

Update nullables in spec to be on references, not on schemas #187

Merged
merged 1 commit into from
Dec 26, 2024
Merged
Changes from all commits
Commits
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
23 changes: 9 additions & 14 deletions descriptions/2.11/api.intercom.io.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3348,8 +3348,7 @@
content:
application/json:
schema:
oneOf:
- "$ref": "#/components/schemas/update_contact_request"
"$ref": "#/components/schemas/update_contact_request"
examples:
successful:
summary: successful
Expand Down Expand Up @@ -4015,8 +4014,7 @@
content:
application/json:
schema:
oneOf:
- "$ref": "#/components/schemas/create_contact_request"
"$ref": "#/components/schemas/create_contact_request"
examples:
successful:
summary: successful
Expand Down Expand Up @@ -10975,7 +10973,7 @@
description: A sentence or two describing the activity.
example: Admin updated the app's name to "My App".
required:
- id

Check warning on line 10976 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

10976:9 [indentation] wrong indentation: expected 6 but found 8
- performed_by
- activity_type
activity_log_list:
Expand All @@ -10998,7 +10996,7 @@
items:
"$ref": "#/components/schemas/activity_log"
required:
- type

Check warning on line 10999 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

10999:9 [indentation] wrong indentation: expected 6 but found 8
- activity_logs
activity_log_metadata:
title: Activity Log Metadata
Expand Down Expand Up @@ -11073,7 +11071,7 @@
description: Url to get more company resources for this contact
example: "/contacts/5ba682d23d7cf92bef87bfd4/notes"
required:
- type

Check warning on line 11074 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11074:9 [indentation] wrong indentation: expected 6 but found 8
- id
- url
admin:
Expand All @@ -11083,7 +11081,7 @@
- Admins
description: Admins are teammate accounts that have access to a workspace.
required:
- id

Check warning on line 11084 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11084:9 [indentation] wrong indentation: expected 6 but found 8
- name
- email
- job_title
Expand Down Expand Up @@ -11162,7 +11160,7 @@
items:
"$ref": "#/components/schemas/admin"
required:
- type

Check warning on line 11163 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11163:9 [indentation] wrong indentation: expected 6 but found 8
- admins
admin_priority_level:
title: Admin Priority Level
Expand Down Expand Up @@ -11375,7 +11373,7 @@
nullable: true
description: App that the admin belongs to.
required:
- type

Check warning on line 11376 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11376:9 [indentation] wrong indentation: expected 6 but found 8
- id
- name
- email
Expand Down Expand Up @@ -11444,7 +11442,7 @@
content_sources:
"$ref": "#/components/schemas/content_sources_list"
required:
- source_type

Check warning on line 11445 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11445:9 [indentation] wrong indentation: expected 6 but found 8
app:
title: App
type: object
Expand Down Expand Up @@ -11480,7 +11478,7 @@
description: Whether or not the app uses identity verification.
example: false
required:
- type

Check warning on line 11481 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11481:9 [indentation] wrong indentation: expected 6 but found 8
- id_code
- name
- region
Expand Down Expand Up @@ -11550,7 +11548,7 @@
description: The URL of the article.
example: http://intercom.test/help/en/articles/3-default-language
required:
- type

Check warning on line 11551 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11551:9 [indentation] wrong indentation: expected 6 but found 8
- title
- description
- body
Expand Down Expand Up @@ -11579,7 +11577,7 @@
items:
"$ref": "#/components/schemas/article_list_item"
required:
- type

Check warning on line 11580 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11580:9 [indentation] wrong indentation: expected 6 but found 8
- total_count
- data
article_list_item:
Expand Down Expand Up @@ -12022,6 +12020,7 @@
example: 6329bd9ffe4e2e91dac76188
customer:
"$ref": "#/components/schemas/customer_request"
nullable: true
required:
- intercom_user_id
- title: User ID
Expand All @@ -12033,6 +12032,7 @@
example: 6329bd9ffe4e2e91dac76188
customer:
"$ref": "#/components/schemas/customer_request"
nullable: true
required:
- user_id
- title: Email
Expand All @@ -12044,6 +12044,7 @@
example: [email protected]
customer:
"$ref": "#/components/schemas/customer_request"
nullable: true
required:
- email
close_conversation_request:
Expand Down Expand Up @@ -13349,6 +13350,7 @@
"$ref": "#/components/schemas/conversation_first_contact_reply"
sla_applied:
"$ref": "#/components/schemas/sla_applied"
nullable: true
statistics:
"$ref": "#/components/schemas/conversation_statistics"
conversation_parts:
Expand Down Expand Up @@ -14568,6 +14570,7 @@
example: 1
next:
"$ref": "#/components/schemas/starting_after_paging"
nullable: true
per_page:
type: integer
description: Number of results per page
Expand Down Expand Up @@ -14621,7 +14624,6 @@
- type
customer_request:
type: object
nullable: true
oneOf:
- title: Intercom User ID
properties:
Expand Down Expand Up @@ -16089,7 +16091,6 @@
title: Phone Switch
type: object
description: Phone Switch Response
nullable: true
properties:
type:
type: string
Expand Down Expand Up @@ -16185,6 +16186,7 @@
title: multiple filter search request
pagination:
"$ref": "#/components/schemas/starting_after_paging"
nullable: true
required:
- query
segment:
Expand Down Expand Up @@ -16292,7 +16294,6 @@
sla_applied:
title: Applied SLA
type: object
nullable: true
description: |
The SLA Applied object contains the details for which SLA has been applied to this conversation.
Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null.
Expand Down Expand Up @@ -16371,7 +16372,6 @@
starting_after_paging:
title: 'Pagination: Starting After'
type: object
nullable: true
properties:
per_page:
type: integer
Expand Down Expand Up @@ -16661,7 +16661,6 @@
x-tags:
- Tickets
description: Tickets are how you track requests from your users.
nullable: true
properties:
type:
type: string
Expand Down Expand Up @@ -16700,6 +16699,7 @@
example: submitted
ticket_type:
"$ref": "#/components/schemas/ticket_type"
nullable: true
contacts:
"$ref": "#/components/schemas/ticket_contacts"
admin_assignee_id:
Expand Down Expand Up @@ -17047,7 +17047,6 @@
- Tickets
description: A ticket type, used to define the data fields to be captured in
a ticket.
nullable: true
properties:
type:
type: string
Expand Down Expand Up @@ -17114,7 +17113,6 @@
type: object
description: Ticket type attribute, used to define each data field to be captured
in a ticket.
nullable: true
properties:
type:
type: string
Expand Down Expand Up @@ -17311,7 +17309,6 @@
description: You can Update an Article
type: object
title: Update Article Request Payload
nullable: true
properties:
title:
type: string
Expand Down Expand Up @@ -17588,7 +17585,6 @@
You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)
type: object
title: Update Ticket Type Request Payload
nullable: true
properties:
name:
type: string
Expand Down Expand Up @@ -17660,7 +17656,6 @@
not yet been identified. They usually represent website visitors. Visitors
are not visible in Intercom platform. The Visitors resource provides methods
to fetch, update, convert and delete.
nullable: true
properties:
type:
type: string
Expand Down
Loading