Update Akeneo PIM API.postman_collection.json#1216
Open
hemm00 wants to merge 1 commit into
Open
Conversation
## Summary
Comprehensive quality pass on the Akeneo PIM API Postman collection — fixing functional bugs, aligning with official documentation, and restructuring for discoverability.
## Changes
### Bug fixes (functional)
- **Auth variables**: `{{basicAuthUsername}}`/`{{basicAuthPassword}}` → `{{clientId}}`/`{{secret}}` to match collection-level variable definitions
- **Prerequest script**: `pm.environment.get/set` → `pm.collectionVariables.get/set` so auto-auth works without a separate Postman environment
- **Hardcoded credentials**: Replaced `"admin"/"admin"` in auth body with `{{username}}`/`{{password}}` variables
- **Product media file upload**: Fixed formdata `file` field from `type: "text"` → `type: "file"`
- **Submit draft body**: Made all 3 "Submit a draft for approval" requests (Product identifier, UUID, Product model) consistent — body, headers, and structure now match
- **Typo**: `"occured"` → `"occurred"` in prerequest script error message
### Response example corrections
- 6 endpoints with empty-body 200 responses corrected to **204 No Content** (Extensions update, job launches, mapping schema update, workflow task update) — confirmed against docs
- Added **Location header** to 7 `201 Created` responses that were missing it (catalogs, extensions, draft submissions, data architect agent)
### Directory restructure (docs-aligned)
Reorganized from a flat list of 38 folders into 9 top-level groups matching the [official API reference](https://api.akeneo.com/api-reference-index.html):
| Group | Subfolders |
|---|---|
| Products | Product [uuid], Product [identifier], Product model, Product media file |
| Jobs | Jobs |
| Catalog structure | Family, Family variant, Attribute, Attribute option, Attribute group, Association type, Category |
| Utilities | Authentication, Overview, System, Rule definition, Permissions, Extensions, Data Architect Agent |
| Target market settings | Channel, Locale, Currency, Measurement family |
| Reference entities | Reference entity, Reference entity attribute, Reference entity attribute option, Reference entity record, Reference entity media file |
| Asset Manager | Asset family, Asset attribute, Asset attribute option, Asset media file, Asset |
| Catalogs for Apps | Catalogs, Catalog products, Mapping schema for products |
| Workflows | Workflows, Workflow executions, Workflow tasks |
### What was intentionally NOT changed
- Endpoint names left as-is (verified against docs — naming varies by section intentionally)
- HTTP methods left as-is (e.g. "Update a UI extension with file upload" is POST per docs)
- All 150 requests and their URLs, query params, test scripts, and JSON schemas preserved
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.
Summary
Comprehensive quality pass on the Akeneo PIM API Postman collection — fixing functional bugs, aligning with official documentation, and restructuring for discoverability.
Changes
Bug fixes (functional)
{{basicAuthUsername}}/{{basicAuthPassword}}→{{clientId}}/{{secret}}to match collection-level variable definitionspm.environment.get/set→pm.collectionVariables.get/setso auto-auth works without a separate Postman environment"admin"/"admin"in auth body with{{username}}/{{password}}variablesfilefield fromtype: "text"→type: "file""occured"→"occurred"in prerequest script error messageResponse example corrections
201 Createdresponses that were missing it (catalogs, extensions, draft submissions, data architect agent)Directory restructure (docs-aligned)
Reorganized from a flat list of 38 folders into 9 top-level groups matching the official API reference:
What was intentionally NOT changed