Skip to content

Conversation

@PedroAntunesCosta
Copy link
Contributor

Summary

This PR adds a new endpoint to the Budgets API that allows updating the linked entity of an allocation.

Changes

  • Added new PUT endpoint: /api/budgets/{contextType}/{contextId}/{budgetId}/allocations/{allocationId}/linked-entity
  • Updated API documentation index to include the new endpoint
  • Implemented full OpenAPI specification including:
    • Request schema with linkedEntityId and linkedEntityType parameters
    • Response schemas with success and error cases
    • Proper authentication and permission documentation

Why

This endpoint was requested in ticket EDU-17265 to support updating the linked entity property of an allocation without having to recreate the entire allocation. This provides more flexibility in managing budget allocations.

Key Files Affected

  • VTEX - Budgets API.json - Added new endpoint specification and updated documentation index

@PedroAntunesCosta PedroAntunesCosta added the documentation Improvements or additions to documentation label Jan 28, 2026
@PedroAntunesCosta PedroAntunesCosta self-assigned this Jan 28, 2026
@github-actions
Copy link

Thanks for your contribution. The .json file will be checked now with Spectral.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants