Repository navigation
Docs/align 2026 05 25 surface - #3
Merged
Merged
Conversation
Correct integration-breaking and stale prose/samples; the openapi.json spec regen lands in a follow-up commit. - outbound: the `clientName`/`connectionName` value is the connection's human-readable NAME, not its `awsUserName` slug (verified against the BE InitOutboundUploadDto). The old Tip would 404 at init. Fixed in automated-flows/outbound.mdx and api-library/overview.mdx (x2). - schemas: examples use the JSON Schema `definition` object the API actually reads, not the ignored `fields` array (overview + sftp note). - connections: api-library overview now leads with `connections.*` (clients.* noted as the deprecated alias); added documents / files / notifications accordions + Zapier webhook methods, gated on @filefeed/sdk >= 2.5.0 via a <Note>. - sftp: replaced the fictional connection object with the real shape (id/name/type/sftpUsername/sftpServer, write-only credentials) and added a hosted-vs-self-hosted SFTP note. - quickstart: registration requires a company email. - changelog: backfilled the 2026-05-25 additive section through SDK 2.3.1 (static mappings), 2.4.0 (EMAIL connections), and 2.5.0 (documents / notifications / files / Zapier / schema definition). NOTE: email.mdx already used the correct inbound domain (@in.filefeed.io, per infra) and was left unchanged. openapi.json is unchanged here. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Bring the existing schemas in line with what the BE actually serves at
FileFeed-Version 2026-05-25 (no new endpoints yet — those follow):
- info.version 1.0.0 -> 2026-05-25; describe the FileFeed-Version header.
- Webhook: drop `secret` from the read shape (security — the BE strips
it; only returned once on create) and the phantom `workspaceId`. Add
CreateWebhookResponse (Webhook + secret) and point POST /webhooks at
it with 201.
- Schema: `fields[]`/SchemaField -> JSON Schema `definition` object;
add `isActive`; drop phantom `version`/`workspaceId`. Same for
CreateSchemaParams. Removed the now-unused SchemaField.
- FieldMapping: sourceField/targetField/defaultValue ->
source/target/transform/value (+ static-mapping semantics). Add a
PipelineMappings wrapper { fieldMappings, options?, validations? }.
- Pipeline: mappings -> PipelineMappings; add `webhooks[]`; drop phantom
`workspaceId`. CreatePipelineParams: add `isActive`.
- PipelineRun: add `client {name}`, `pipelineName`, `isPipelineDeleted`;
drop phantom `workspaceId`.
- ValidationResult.errors -> raw AJV error objects (no `field`).
- Connection: drop phantom `workspaceId`; add `sftpServer`
(SftpServerData) response; add self-hosted `sftpHost`/`sftpPort`/
`sftpRemotePath` request fields; correct the awsUserName description
(outbound resolves by the connection name, not the slug).
- WebhookDelivery: add `webhookName`/`webhookUrl`.
- Tags: Connections canonical, Clients (deprecated); declare Documents /
Files / Notifications tags for the routes added next.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Document the customer-callable routes the spec was missing at
2026-05-25 (17 new path items, ~30 new component schemas):
- Documents (12): browse, metadata, download, upload-url,
upload-complete, upload-abort, folders, move, rename, object/folder
delete, bulk-delete. Pipeline-folder protection surfaced as 403/409.
- Files (2): GET /files/json, POST /files/search.
- Notifications (2): GET/PUT /notifications/preferences/{clientId}.
- Webhooks (2): Zapier pipeline-run subscribe/unsubscribe.
Added the Forbidden/Conflict shared responses. Validated: JSON parses,
all 78 $refs resolve, every tag is declared and used.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.