Move company notes API to Unstable and fix note schema #380
Open
Move company notes API to Unstable and fix note schema #380
Conversation
The createCompanyNote endpoint was implemented in the intercom/intercom backend as part of version 2.15 (via AddCompanyNotesApi versioning change) but was only documented in the Unstable spec (descriptions/0/). This adds the POST endpoint to the versioned 2.15 spec to match what the backend actually supports, keeping OpenAPI and developer-docs in sync. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
|
@efassor The PR description confuses me here. |
Contributor
Author
I added the endpoint to the OpenAPI spec in PR #374 but I missed the version-specific spec for 2.15 onward, which Claude assures me needs to be added also. |
- Revert 2.15 changes (feature moves to Unstable per versioning policy) - Fix path parameter name: id → company_id to match Rails route - Add company property to note schema - Update note schema description to mention companies Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
efassor
changed the title
efassor
changed the title
Contributor
Author
|
@VedranZoricic I updated the description to reflect what is actually happening |
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
2 participants
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.
Why?
Per API versioning policy, new features should ship to Unstable first. The
AddCompanyNotesApiversion change is being moved from 2.15 to Unstable in the monolith (intercom/intercom#486220), so the OpenAPI spec needs to match.How?
Revert the POST endpoint addition from
descriptions/2.15/, fix the Unstable spec (descriptions/0/) with the correctcompany_idpath parameter name, add thecompanyproperty to the note schema, and update the schema description to cover both contacts and companies.Related:
Generated with Claude Code