In a newly created sprint branch, there is no content by default. This approach helps developers focus on the changes needed for the current sprint. You can add resources and make modifications using two main methods.Choosing Your Approach#
| Method | Best For | Key Benefit |
|---|
| Manual Changes | API-First development | Clear specification before development |
| OAS Import | Code-First development | Automatic comparison with main branch |
Apidog highly recommends the API-First approach (manual changes) for increased efficiency and lower collaboration costs.
Manual Changes#
Manually modifying content within a sprint branch allows you to define your API specifications clearly before diving into development.Forking Resources from the Main Branch#
When you need to modify existing endpoints, schemas, or response components based on current sprint requirements:1.
Use Fork from main to create a copy of required resources
2.
All parent folders are automatically imported
3.
Imported resources are marked with association indicators
Pulling Latest Changes from Main Branch#
While working in a sprint branch, urgent updates may require changes directly in the main branch. To synchronize:1.
You'll receive a notification when associated resources in the main branch are updated
2.
Click the notification to review changes
3.
Choose whether to pull updates or retain current sprint branch content
4.
Select desired content and confirm the update
Creating New Resources#
To create new endpoints, schemas, or response components for the current sprint:1.
Use the New feature to add resources to the current sprint branch
2.
If the required parent folder doesn't exist, use:Select Endpoint Folders: Choose existing folders
New Endpoint Folder: Create new folders
Reordering and Adjusting Folder Contents#
You can perform the same operations on imported or newly created resources as in the main branch:Imported folders with indicators:Deleting and Restoring Resources#
Sprint branches have a trash feature that works the same as the main branch:1.
Delete resources as needed
2.
View deleted resources in Trash
3.
Restore resources when needed
Repeatedly importing, deleting, and restoring the same main branch resource can lead to unexpected data issues. Minimize these operations to maintain data integrity.
Mocking, Comparing, and Collaborating#
Endpoints in a sprint branch have unique mock addresses specific to that branch, relying entirely on the current sprint branch's endpoint definitions.Comparing with main branch:Compare sprint branch resources with main branch counterparts to identify specific differences.Share sprint branch endpoints via collaboration links with other project members.When clicking a sprint branch endpoint collaboration link while in another branch, the system will prompt you to switch branches. Save any changes in your current branch before switching.
OAS Import#
Import OpenAPI Specification (OAS) files directly into a sprint branch using manual, scheduled, or API import methods.Importing OAS into Sprint Branch#
1.
Ensure the target branch is selected in the top-left corner
2.
Navigate to Project Settings β Import Data
3.
Import data into the current branch
Automatic Comparison with Main Branch#
When importing OAS into the sprint branch, the processing logic:1.
Compare each endpoint's "Path & Method" in the OAS file with the main branch
2.
If identical: Endpoint won't be imported
3.
If different: Endpoint is associated with main branch and imported
4.
If new: New endpoint is created in sprint branch
1.
Compare schema names in the OAS file with the main branch
2.
If identical: Schema won't be imported
3.
If different: Schema is associated with main branch and imported
4.
If new: New schema is created in sprint branch
Resources that are completely unchanged compared to the main branch will not be included in the sprint branch after import, helping developers focus on necessary changes.
