Update Internal API Documentation User Guide

Introduction

To keep your internal API documentation up to date, T-matic offers an integrated process that ensures your documentation reflects the latest changes made to your API specification. This guide will explain the steps you need to take to update your internal API documentation after regenerating a component with an updated API specification.

Preconditions:

Before updating the documentation, ensure that:

• The component linked to the API has been regenerated to reflect the latest changes in the API specification.

---

1. Access the View API Page:

• Begin by navigating to the "View API" page on the T-matic platform.

---

2. Navigate to the Component's Documentation:

• From the "View API" page, go to the "Components" tab.

• Here, you'll see a list of components associated with the API. Locate the component you've regenerated with the updated specification.

• Click on the component's name or link to view its details.

• Once inside the component's page, navigate to the "Docs" tab.

---

3. Review the Updated Documentation:

• Within the "Docs" tab, you will find the documentation auto-generated from the latest API specification.

• To ensure that your API's documentation is updated correctly, you should:

  • Check the models: Review the models for any changes, additions, or removals that match the updated API specification.

  • Verify the endpoints: Make sure all the endpoint changes, whether they're modifications, additions, or removals, are accurately reflected in the documentation.