diff --git a/fern/apis/api/openapi.json b/fern/apis/api/openapi.json index db61683..1a6dfb2 100644 --- a/fern/apis/api/openapi.json +++ b/fern/apis/api/openapi.json @@ -1291,17 +1291,12 @@ { "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO", "title": "CustomKnowledgeBaseDTO" - }, - { - "$ref": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", - "title": "CanonicalKnowledgeBaseDTO" } ], "discriminator": { "propertyName": "provider", "mapping": { "trieve": "#/components/schemas/CreateTrieveKnowledgeBaseDTO", - "canonical": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", "custom-knowledge-base": "#/components/schemas/CreateCustomKnowledgeBaseDTO" } } @@ -1323,18 +1318,13 @@ { "$ref": "#/components/schemas/CustomKnowledgeBase", "title": "CustomKnowledgeBase" - }, - { - "$ref": "#/components/schemas/CanonicalKnowledgeBase", - "title": "CanonicalKnowledgeBase" } ], "discriminator": { "propertyName": "provider", "mapping": { "trieve": "#/components/schemas/TrieveKnowledgeBase", - "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase", - "canonical": "#/components/schemas/CanonicalKnowledgeBase" + "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase" } } } @@ -1463,18 +1453,13 @@ { "$ref": "#/components/schemas/CustomKnowledgeBase", "title": "CustomKnowledgeBase" - }, - { - "$ref": "#/components/schemas/CanonicalKnowledgeBase", - "title": "CanonicalKnowledgeBase" } ], "discriminator": { "propertyName": "provider", "mapping": { "trieve": "#/components/schemas/TrieveKnowledgeBase", - "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase", - "canonical": "#/components/schemas/CanonicalKnowledgeBase" + "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase" } } } @@ -1521,18 +1506,13 @@ { "$ref": "#/components/schemas/CustomKnowledgeBase", "title": "CustomKnowledgeBase" - }, - { - "$ref": "#/components/schemas/CanonicalKnowledgeBase", - "title": "CanonicalKnowledgeBase" } ], "discriminator": { "propertyName": "provider", "mapping": { "trieve": "#/components/schemas/TrieveKnowledgeBase", - "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase", - "canonical": "#/components/schemas/CanonicalKnowledgeBase" + "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase" } } } @@ -1576,18 +1556,13 @@ { "$ref": "#/components/schemas/CustomKnowledgeBase", "title": "CustomKnowledgeBase" - }, - { - "$ref": "#/components/schemas/CanonicalKnowledgeBase", - "title": "CanonicalKnowledgeBase" } ], "discriminator": { "propertyName": "provider", "mapping": { "trieve": "#/components/schemas/TrieveKnowledgeBase", - "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase", - "canonical": "#/components/schemas/CanonicalKnowledgeBase" + "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase" } } } @@ -1631,18 +1606,13 @@ { "$ref": "#/components/schemas/CustomKnowledgeBase", "title": "CustomKnowledgeBase" - }, - { - "$ref": "#/components/schemas/CanonicalKnowledgeBase", - "title": "CanonicalKnowledgeBase" } ], "discriminator": { "propertyName": "provider", "mapping": { "trieve": "#/components/schemas/TrieveKnowledgeBase", - "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase", - "canonical": "#/components/schemas/CanonicalKnowledgeBase" + "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase" } } } @@ -4836,35 +4806,6 @@ "type" ] }, - "CreateCanonicalKnowledgeBaseDTO": { - "type": "object", - "properties": { - "provider": { - "type": "string", - "description": "This knowledge base is provided by Canonical.", - "enum": [ - "canonical" - ] - }, - "topK": { - "type": "number", - "description": "This is the top K value for the knowledge base.", - "minimum": 1, - "maximum": 10 - }, - "fileIds": { - "description": "These are the file ids that can be used by the knowledge base.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "provider", - "fileIds" - ] - }, "CreateCustomKnowledgeBaseDTO": { "type": "object", "properties": { @@ -4969,10 +4910,6 @@ "knowledgeBase": { "description": "These are the options for the knowledge base.", "oneOf": [ - { - "$ref": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", - "title": "Canonical" - }, { "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO", "title": "Custom" @@ -5076,10 +5013,6 @@ "knowledgeBase": { "description": "These are the options for the knowledge base.", "oneOf": [ - { - "$ref": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", - "title": "Canonical" - }, { "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO", "title": "Custom" @@ -5191,10 +5124,6 @@ "knowledgeBase": { "description": "These are the options for the knowledge base.", "oneOf": [ - { - "$ref": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", - "title": "Canonical" - }, { "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO", "title": "Custom" @@ -5313,10 +5242,6 @@ "knowledgeBase": { "description": "These are the options for the knowledge base.", "oneOf": [ - { - "$ref": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", - "title": "Canonical" - }, { "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO", "title": "Custom" @@ -5420,10 +5345,6 @@ "knowledgeBase": { "description": "These are the options for the knowledge base.", "oneOf": [ - { - "$ref": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", - "title": "Canonical" - }, { "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO", "title": "Custom" @@ -5534,10 +5455,6 @@ "knowledgeBase": { "description": "These are the options for the knowledge base.", "oneOf": [ - { - "$ref": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", - "title": "Canonical" - }, { "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO", "title": "Custom" @@ -5653,10 +5570,6 @@ "knowledgeBase": { "description": "These are the options for the knowledge base.", "oneOf": [ - { - "$ref": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", - "title": "Canonical" - }, { "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO", "title": "Custom" @@ -5763,10 +5676,6 @@ "knowledgeBase": { "description": "These are the options for the knowledge base.", "oneOf": [ - { - "$ref": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", - "title": "Canonical" - }, { "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO", "title": "Custom" @@ -5949,10 +5858,6 @@ "knowledgeBase": { "description": "These are the options for the knowledge base.", "oneOf": [ - { - "$ref": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", - "title": "Canonical" - }, { "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO", "title": "Custom" @@ -6056,10 +5961,6 @@ "knowledgeBase": { "description": "These are the options for the knowledge base.", "oneOf": [ - { - "$ref": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", - "title": "Canonical" - }, { "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO", "title": "Custom" @@ -6163,10 +6064,6 @@ "knowledgeBase": { "description": "These are the options for the knowledge base.", "oneOf": [ - { - "$ref": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", - "title": "Canonical" - }, { "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO", "title": "Custom" @@ -6270,10 +6167,6 @@ "knowledgeBase": { "description": "These are the options for the knowledge base.", "oneOf": [ - { - "$ref": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", - "title": "Canonical" - }, { "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO", "title": "Custom" @@ -6392,10 +6285,6 @@ "knowledgeBase": { "description": "These are the options for the knowledge base.", "oneOf": [ - { - "$ref": "#/components/schemas/CreateCanonicalKnowledgeBaseDTO", - "title": "Canonical" - }, { "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO", "title": "Custom" @@ -13045,45 +12934,6 @@ "orgId" ] }, - "CanonicalKnowledgeBase": { - "type": "object", - "properties": { - "provider": { - "type": "string", - "description": "This knowledge base is provided by Canonical.", - "enum": [ - "canonical" - ] - }, - "topK": { - "type": "number", - "description": "This is the top K value for the knowledge base.", - "minimum": 1, - "maximum": 10 - }, - "fileIds": { - "description": "These are the file ids that can be used by the knowledge base.", - "type": "array", - "items": { - "type": "string" - } - }, - "id": { - "type": "string", - "description": "This is the id of the knowledge base." - }, - "orgId": { - "type": "string", - "description": "This is the org id of the knowledge base." - } - }, - "required": [ - "provider", - "fileIds", - "id", - "orgId" - ] - }, "CreateTrieveKnowledgeBaseDTO": { "type": "object", "properties": { @@ -15701,6 +15551,35 @@ "updatedAt" ] }, + "OAuth2AuthenticationPlan": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "oauth2" + ] + }, + "url": { + "type": "string", + "description": "This is the OAuth2 URL." + }, + "clientId": { + "type": "string", + "description": "This is the OAuth2 client ID." + }, + "clientSecret": { + "type": "string", + "description": "This is the OAuth2 client secret." + } + }, + "required": [ + "type", + "url", + "clientId", + "clientSecret" + ] + }, "CustomLLMCredential": { "type": "object", "properties": { @@ -15715,6 +15594,14 @@ "maxLength": 10000, "description": "This is not returned in the API." }, + "authenticationPlan": { + "description": "This is the authentication plan. Currently supports OAuth2 RFC 6749. To use Bearer authentication, use apiKey", + "allOf": [ + { + "$ref": "#/components/schemas/OAuth2AuthenticationPlan" + } + ] + }, "id": { "type": "string", "description": "This is the unique identifier for the credential." @@ -17006,6 +16893,57 @@ "apiKey" ] }, + "WebhookCredential": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "enum": [ + "webhook" + ] + }, + "authenticationPlan": { + "description": "This is the authentication plan. Currently supports OAuth2 RFC 6749.", + "allOf": [ + { + "$ref": "#/components/schemas/OAuth2AuthenticationPlan" + } + ] + }, + "id": { + "type": "string", + "description": "This is the unique identifier for the credential." + }, + "orgId": { + "type": "string", + "description": "This is the unique identifier for the org that this credential belongs to." + }, + "createdAt": { + "format": "date-time", + "type": "string", + "description": "This is the ISO 8601 date-time string of when the credential was created." + }, + "updatedAt": { + "format": "date-time", + "type": "string", + "description": "This is the ISO 8601 date-time string of when the assistant was last updated." + }, + "name": { + "type": "string", + "description": "This is the name of credential. This is just for your reference.", + "minLength": 1, + "maxLength": 40 + } + }, + "required": [ + "provider", + "authenticationPlan", + "id", + "orgId", + "createdAt", + "updatedAt" + ] + }, "XAiCredential": { "type": "object", "properties": { @@ -17371,6 +17309,14 @@ "maxLength": 10000, "description": "This is not returned in the API." }, + "authenticationPlan": { + "description": "This is the authentication plan. Currently supports OAuth2 RFC 6749. To use Bearer authentication, use apiKey", + "allOf": [ + { + "$ref": "#/components/schemas/OAuth2AuthenticationPlan" + } + ] + }, "name": { "type": "string", "description": "This is the name of credential. This is just for your reference.", @@ -18032,6 +17978,35 @@ "apiKey" ] }, + "CreateWebhookCredentialDTO": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "enum": [ + "webhook" + ] + }, + "authenticationPlan": { + "description": "This is the authentication plan. Currently supports OAuth2 RFC 6749.", + "allOf": [ + { + "$ref": "#/components/schemas/OAuth2AuthenticationPlan" + } + ] + }, + "name": { + "type": "string", + "description": "This is the name of credential. This is just for your reference.", + "minLength": 1, + "maxLength": 40 + } + }, + "required": [ + "provider", + "authenticationPlan" + ] + }, "CreateXAiCredentialDTO": { "type": "object", "properties": { @@ -18375,6 +18350,14 @@ "maxLength": 10000, "description": "This is not returned in the API." }, + "authenticationPlan": { + "description": "This is the authentication plan. Currently supports OAuth2 RFC 6749. To use Bearer authentication, use apiKey", + "allOf": [ + { + "$ref": "#/components/schemas/OAuth2AuthenticationPlan" + } + ] + }, "name": { "type": "string", "description": "This is the name of credential. This is just for your reference.",