Making Changes and Commits

APIGit provides an intuitive interface for editing files and committing changes to your API repositories. This guide walks you through the process of making changes and creating commits.

Step 1: Select a File and Enter Edit Mode

In your API Repository, navigate to the file you want to edit. Different file types will open in specialized visual editors based on the file’s content and purpose.

For example, to edit an API Specification:

1. Navigate to the “API Document” tab
2. Select the specification file
3. Click the “Edit” icon button in the bottom left corner to enter the API Spec editor

Within the editor, you can switch between different views to facilitate your editing process. In this example, we’re adding a new path to an API specification.

Step 2: Review Your Changes

After completing your edits, switch to the diff viewer mode to review all changes before committing. This allows you to verify that only intended modifications are included in your commit.

Step 3: Submit Your Changes

When you’re satisfied with your changes:

1. Click the “Commit” button in the upper left corner
2. Add a descriptive commit message that explains the purpose of your changes
3. Submit to commit your changes to the APIGit backend

Once successfully committed, a new commit record will be generated in your repository’s history, just like a regular Git commit.

Handling Conflicts

If there are any conflicts with your changes (for instance, if someone else modified the same file), APIGit will display a dialog prompting you to resolve these conflicts. You can:

1. Review the conflicting changes
2. Make necessary adjustments to resolve the conflicts
3. Re-submit your commit

This workflow ensures that all changes are properly tracked and integrated into your repository’s history.