Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Branches
  • Apidog Learning Center
  • Getting Started
    • Introduction to Apidog
    • Basic Concepts in Apidog
    • Navigating Apidog
    • Quick Start
      • Overview
      • Creating an Endpoint
      • Making a Request
      • Adding an Assertion
      • Creating Test Scenarios
      • Sharing API Documentation
      • Explore More
    • Migration to Apidog
      • Overview
      • Manual Import
      • Scheduled Import (Bind Data Sources)
      • Import Options
      • Export Data
      • Import From
        • Import from Postman
        • Import OpenAPI Spec
        • Import cURL
        • Import Markdowns
        • Import from Insomnia
        • Import from apiDoc
        • Import .har File
        • Import WSDL
  • Design APIs
    • Overview
    • Create a New API Project
    • Endpoint Basics
    • APl Design Guidelines
    • Module
    • Configure Multiple Request Body Examples
    • Components
    • Common Fields
    • Global Parameters
    • Endpoint Change History
    • Comments
    • Batch Endpoint Management
    • Custom Protocol API
    • Schemas
      • Overview
      • Create a New Schema
      • Build a Schema
      • Generate Schemas from JSON Etc
      • oneOf, allOf, anyOf
      • Using Discriminator
    • Security Schemes
      • Overview
      • Create a Security Scheme
      • Use the Security Scheme
      • Security Scheme in Online Documentation
    • Advanced Features
      • Custom Endpoint Fields
      • Associated Test Scenarios
      • Endpoint Status
      • Appearance of Parameter Lists
      • Endpoint Unique Identification
  • Develop and Debug APIs
    • Overview
    • Generating Requests
    • Sending Requests
    • Debugging Cases
    • Test Cases
    • Dynamic Values
    • Validating Responses
    • Design-First vs Request-First
    • Generating Code
    • Environments & Variables
      • Overview
      • Environment Management
      • Using Variables
    • Vault Secrets
      • Overview
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Pre and Post Processors
      • Assertion
      • Extract Variable
      • Wait
      • Overview
      • Database Operations
        • Overview
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • Using Scripts
        • Overview
        • Pre Processor Scripts
        • Post Processor Scripts
        • Public Scripts
        • Postman Scripts Reference
        • Calling Other Programming Languages
        • Using JS Libraries
        • Visualizing Responses
        • Script Examples
          • Assertion Scripts
          • Using Variables
          • Modifying Requests
          • Other Examples
    • Dynamic Values Modules
  • Mock API Data
    • Overview
    • Smart Mock
    • Custom Mock
    • Mock Priority Sequence
    • Mock Scripts
    • Cloud Mock
    • Self-Hosted Runner Mock
    • Mock Language (Locales)
  • API Testing
    • Overview
    • Test Scenarios
      • Create a Test Scenario
      • Pass Data Between Requests
      • Flow Control Conditions
      • Sync Data from Endpoints and Endpoint Cases
      • Import Endpoints and Endpoint Cases from Other Projects
      • Export Test Scenarios
    • Run Test Scenarios
      • Run a Test Scenario
      • Run Test Scenarios in Batch
      • Manage Runtime Environment of APIs from Other Projects
      • Data-Driven Testing
      • Scheduled Tasks
    • Test Suite
      • Overview
      • Create A Test Suite
      • Orchestrate Test Suite
      • Run Test Suites Locally
      • Run Test Suites Via CLI
      • Scheduled tasks
    • Test Reports
      • Test Reports
    • Test APIs
      • Integration Testing
      • Performance Testing
      • End-to-End Testing
      • Regression Testing
      • Contract Testing
    • Apidog CLI
      • Overview
      • Installing and Running Apidog CLI
      • Apidog CLI Options
    • CI CD
      • Overview
      • Integrate with Gitlab
      • Integrate with Jenkins
      • Trigger Test by Git Commit
      • Integrate with Github Actions
  • Publish API Docs
    • Overview
    • API Technologies Supported
    • Quick Share
    • Viewing API Documentation
    • Markdown Documentation
    • Publishing Documentation Sites
    • Custom Layouts
    • Custom CSS, JavaScript, HTML
    • Custom Domain
    • LLM-Friendly Features
    • SEO Settings
    • Advanced Settings
      • Documentation Search
      • CORS Proxy
      • Integrating Google Analytics with Doc Sites
      • Folder Tree Settings
      • Visibility Settings
      • Embedding Values in Document URLs
    • API Versions
      • Overview
      • Creating API Versions
      • Publishing API Versions
      • Sharing Endpoints with API Versions
  • Send Requests
    • Overview
    • SSE Debugging
    • MCP Client
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP or WebService
    • GraphQL
    • gRPC
    • Use Request Proxy Agents for Debugging
    • Create Requests
      • Request History
      • Request Basics
      • Parameters and Body
      • Request Headers
      • Request Settings
      • Debug Requests
      • Saving Requests as Endpoints
      • HTTP/2
    • Response and Cookies
      • Viewing API Responses
      • Managing Cookies
      • Overview
    • Authentication and Authorization
      • Overview
      • CA and Client Certificates
      • Authorization Types
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
  • Branches
    • Overview
    • Creating a Sprint Branch
    • Testing APIs in a Branch
    • Designing APIs in a Branch
    • Merging Sprint Branches
    • Managing Sprint Branches
  • AI Features
    • Overview
    • Enabling AI Features
    • Generating Test Cases
    • Modifying Schemas with AI
    • Endpoint Compliance Check
    • API Documentation Completeness Check
    • AI-Powered Field Naming
    • FAQs
  • Apidog MCP Server
    • Overview
    • Connect Apidog Project to AI
    • Connect Published Documentation to AI
    • Connect OpenAPI Files to AI
  • Best Practices
    • Handling API Signatures
    • Accessing OAuth 2.0 Protected APIs
    • Collaboration Workflow
    • Managing Authentication State
  • Offline Space
    • Overview
  • Administration
    • Managing Teams
      • Managing Teams
      • Managing Team Members
      • Member Roles & Permission Settings
      • Team Activities
      • Team Resources
        • General Runner
        • Team Variables
        • Request Proxy Agent
      • Real-time Collaborations
        • Team Collaboration
    • Onboarding Checklist
      • Basic Concepts
      • Onboarding Guide
    • Managing Projects
      • Managing Projects
      • Managing Project Members
      • Notification Settings
      • Project Resources
        • Database Connection
        • Git Connection
    • Managing Organization
      • Managing Organization
      • Single Sign-On (SSO)
        • SSO Overview
        • Configuring Microsoft Entra ID
        • Configuring Okta
        • Configuring SSO for an Organization
        • Managing User Accounts
        • Mapping Groups to Teams
      • SCIM Provisioning
        • Introduction to SCIM Provisioning
        • Microsoft Entra ID
        • Okta
      • Plans Management
        • Billing Managers in Organizations
      • Organization Resources
        • Self-Hosted Runner
  • Billing
    • Overview
    • Credits
    • Alternative Payment Methods
    • Managing Subscriptions
    • Upgrading Your Plan
    • Moving Paid Teams to Organizations
  • Data & Security
    • Data Storage and Security
    • User Data Privacy and Security
    • Request Routing and Data Security
  • Add-ons
    • API Hub
    • Apidog Intellij IDEA Plugin
    • Browser Extension
      • Chrome
      • Microsoft Edge
    • Request Proxy
      • Request Proxy in Web
      • Request Proxy in Shared Docs
      • Request Proxy in Client
  • Account & Preferences
    • Account Settings
    • Generating OpenAPI Access Token
    • Notification
    • Language Settings
    • Hot Keys
    • Network Proxy Configuration
    • Backing Up Data
    • Updating Apidog
    • Deleting Account
    • Experimental Features
  • References
    • API Design-First Approach
    • Apidog OpenAPI Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Installing Java Environment
    • Runner Deployment Environment
    • Apidog flavored Markdown
  • Apidog Europe
    • Apidog Europe
  • Support Center
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Branches

Merging Sprint Branches

Once endpoint definitions are developed and deployed within a sprint branch, you can merge some or all of the changes into the main branch.

Accessing Merge Functions#

For APIs#

Option 1: Click Merge in the branch switch next to APIs
Option 2: Click Merge to main at the right bottom of APIs
Merging sprint branches entry point

For Test Scenarios#

Test scenarios require separate merging and do not merge automatically with resources in APIs.
While in a sprint branch, hover over the ... button next to a test scenario in automated testing to see the Merge to Main option.
Merging test scenario entry point

Merging into Unprotected Main Branch#

If the main branch is not protected, users with project merge permissions can review changes and directly merge them into the main branch.

Overview of Pending Merges#

Clicking Merge opens the merge overview popup with key elements:
ElementDescription
FilterView only modified resources or all resources in the current sprint branch
Merging PreviewDisplays final effect on main branch directory after merging
Resource StatusColor-coded dots (gray: unchanged, orange: modified, green: new)
Post-Merge StatusChoose how to adjust merged resource status: Follow Current Branch, Follow Main, or Specified Status
Merge overview

Detailed Review of Pending Merges#

Click a resource to expand the popup and show detailed content for merge decision-making.

New Resources#

Resources created in the current sprint branch, not present in the main branch
If merged, the resource will be created in the main branch at the specified location
Click to view complete content
New resource details

Modified Resources#

Resources forked from the main branch and associated with main branch resources
If merged, the main branch resource will be overwritten
Click to see changes compared with main branch resource and complete content
Modified resource details

Unchanged Resources#

Resources forked from the main branch without modifications
Cannot be selected for merging (and don't need to be)
No detailed content shown
Unchanged resource details
If a parent resource is not selected, none of its child resources can be merged individually.
Merge confirmation:
Merge confirmation popup
Merge completion:
After merging, a summary popup shows changes made to the main branch.
Merge completion popup

Viewing Merge Details and Reverting Merges#

In the main branch, access Change History of a resource to:
View content modified through merges
Compare content with other versions
Track and rollback changes
Main branch resource history
Resource history comparison

Merging into Protected Main Branch#

When merging into a protected main branch, users with editing permissions must create a merge request for administrator review and approval.

Creating a Merge Request#

1.
Click Merge in the project
2.
View all changes in the current branch
3.
Select specific resources to merge
4.
Click Create Merge Request at the bottom-right
Creating merge request

Reviewing a Merge Request#

Reviewers see a notification in Project Overview indicating a new merge request.
To review:
1.
Go to Project Overview β†’ Merge Requests
2.
View list of requests with detailed information
Merge requests list
3.
Click a pending merge request to evaluate contents
4.
Compare content before and after merge
5.
Click Merge to approve and merge changes
Merge request review
Merge completion:
Modification overview
Merged status:
Merged request status

Modifying a Submitted Merge Request#

After submitting a merge request, if changes are needed:
1.
Directly modify content in the sprint branch
2.
Changes automatically sync with the existing merge request
3.
No need to create a new request
4.
Modifications are indicated on the review page
Modifying submitted merge request

Rejecting a Merge Request#

If a merge request is not suitable:
1.
Click Reject on the merge request review page
2.
Request is marked as Closed
3.
To make changes and merge again, create a new merge request
Rejecting merge request
Closed request details:
Closed merge request details

Merging Automated Test Scenarios#

Automated test scenarios and endpoints are merged independently and separately. Test scenarios need individual merging without an overall merge page.
Important Notes
1.
Merge APIs first: Merge resources in APIs before merging test scenarios. Failing to do so may cause related test scenarios in the main branch to run abnormally.
2.
Administrator access: Currently, only project administrators can merge test scenarios into protected main branches. A feature for merge requests for test scenarios is planned for the future.
Merging test scenarios:
Hover over the ... button of a test scenario in automated testing to see the Merge to Main option.
Merging test scenario
Test scenario merge popup displays:
InformationDescription
Basic InformationSprint branch test scenario and associated main branch scenario (if any)
Last Run ResultLast manual run result (hover for summary). Ensure scenario passes before merging
Merge ActionOverwrite (if forked from main) or Add (if new)
Test scenario merge popup
Modified atΒ 2026-01-23 07:17:04
Previous
Designing APIs in a Branch
Next
Managing Sprint Branches
Built with