docs(source-granola): update API key model and retry behavior - #84283
Merged
Conversation
Co-Authored-By: bot_apk <apk@cognition.ai>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
👋 Greetings, Airbyte Team Member!Here are some helpful tips and reminders for your convenience. 💡 Show Tips and TricksPR Slash CommandsAirbyte Maintainers (that's you!) can execute the following slash commands on your PR:
📚 Show Repo GuidanceHelpful Resources
|
Contributor
|
Deploy preview for airbyte-docs ready!
Deployed with vercel-action |
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.
Triggering Context
Run triggered by: Merged connector commit
fe24599079e8df4686d82384a616c5b1eef78a73onmaster(source-granola 0.2.12), delivered to this session by the autodoc workflow.Relevant context: fix(source-granola): retry throttled and server-error responses with backoff (#84278)
Confidence impact: The trigger is a small, merged, single-connector change with an unambiguous scope, so the Triggering Context score is high.
Documentation Confidence Assessment
Overall Confidence: 4/5
manifest.yamlandmetadata.yaml, with no custom components in the documented path.ql: 100/sl: 100.413ondetailed_notesis reasoned from the manifest plus the documented API response.Adjustments based on code comprehension
include=transcript, API budget, error handler) is declared inmanifest.yaml.language:manifest-onlyinmetadata.yaml.413response appear both in Granola's OpenAPI document and its help-center pages.What I Verified vs. What I Inferred
max_retries: 5,WaitTimeFromHeaderonRetry-Aftercapped at 60s,ExponentialBackoffStrategyas the fallback (manifest.yamlbase_requester.error_handler); the 25 requests / 5sHTTPAPIBudget;created_atcursor withstep: P30Dand noupdated_atcursor;detailed_notesalways sendsinclude=transcript.413withTRANSCRIPT_TOO_LARGEwhen a transcript can't be returned inline.413responses cause the affecteddetailed_notesrecords to fail rather than be skipped — the manifest has no response filter for413and no fallback to/v1/notes/{note_id}/transcript, so the request is not handled gracefully, but I did not run a sync against an oversized transcript. Also inferred: that long meetings are the likeliest trigger for that limit.Areas of Concern
api_keydescription inmanifest.yamlstill describes the old "Enterprise API key" flow (Settings > API > Create new key) and the "Allow personal API keys" toggle. That's connector code, not docs, so I left it alone — it needs a separate connector PR to match this page and Granola's current UI.detailed_notesremains full refresh, so oversized-transcript notes affect every sync until the connector adopts the paged transcript endpoint.What
Brings the Granola source docs back in line with Granola's current API and with connector behavior as of 0.2.12:
How
Corrections
429 Too Many Requestsresponse is received" with the actual behavior from the newDefaultErrorHandler: up to 5 retries on429and5xx, honoringRetry-Afterup to 60 seconds and otherwise backing off exponentially.Additions
413/TRANSCRIPT_TOO_LARGEcase fordetailed_notes, since the connector always requests the inline transcript and has no fallback to Granola's paged transcript endpoint.created_atcursor means edits to already-synced notes aren't picked up incrementally.Review guide
docs/integrations/sources/granola.md, Prerequisites and Setup guide: check the key types and menu paths against Granola's API help-center page.413paragraph is the one claim with an inferred consequence.base_requester.error_handlerinmanifest.yaml.User Impact
Users setting up the connector today were being sent to a key-creation flow that no longer exists, and had no way to know their sync retries server errors or can stall on very large transcripts. No connector behavior changes.
Can this PR be safely reverted and rolled back?
Devin session