Skip to content

Conversation

@levindixon
Copy link
Contributor

@levindixon levindixon commented Aug 27, 2025

What's changing?

Refreshing our Postman collections to stay in sync with the latest API specifications, plus adding support for API v2.14.

Quick Summary

  • ✨ New: API v2.14 collection added
  • πŸ”„ Updated: Collections for v2.7 through v2.13 and Unstable
  • πŸ“š Docs: README files updated across all versions

Why?

Keeps our Postman collections current with recent API changes, ensuring developers have accurate testing tools.

How?

scripts/postman/update-postman-collection.js

Review Guide

This is mostly auto-generated content from our API specs. Key things to check:

  • New v2.14 collection structure looks correct
  • No sensitive data accidentally included
  • File formats are valid JSON

πŸ€– Generated with Claude Code

…4 and Unstable

## Summary
Comprehensive update to Intercom API Postman collections spanning multiple API versions,
including the introduction of API version 2.14 support.

## Changes by Version

### New Addition
- **v2.14**: Added complete Postman collection with environment configuration and documentation
  - `intercom-api.postman_collection.json`: Full API endpoint collection
  - `environment.json`: Pre-configured environment variables
  - `README.md`: Setup and usage documentation

### Updated Versions
- **v2.7** through **v2.13**: Updated existing Postman collections and README files
- **Unstable**: Updated collection to reflect latest API developments

## Impact
These updates ensure that:
- Developers have access to the latest API endpoints and request formats
- Collections are synchronized with current API specifications
- Documentation reflects current authentication methods and best practices
- Environment configurations are optimized for testing workflows

## Technical Details
- Collections follow Postman Collection Format v2.1
- Environment variables support multiple workspace configurations
- Request examples include proper authentication headers
- Response schemas aligned with OpenAPI specifications

## Testing Recommendations
Users should:
1. Import the collection matching their API version
2. Configure environment variables with their API credentials
3. Test endpoints in their preferred order using Postman Runner
4. Refer to version-specific README for migration notes

πŸ€– Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@levindixon levindixon requested a review from a team August 27, 2025 09:40
Copy link
Contributor

@VedranZoricic VedranZoricic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2.13: We added internal articles ( this is because they were not updated in OpenAPI spec previously)
Unstable: Looks good and no unexpected changes, added email, brands, and internal articles
2.14: Matches Unstable but without email, brands, and macros which is correct

@levindixon levindixon merged commit 05b2b1e into main Aug 27, 2025
6 checks passed
@levindixon levindixon deleted the levin.dixon/update-postman-collections branch August 27, 2025 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants