Generating Code Component User Guide
Introduction
This user guide aims to assist Product Managers in generating and downloading SDKs via the T-Matic User Interface (UI). Follow the step-by-step guide below to seamlessly navigate through the SDK creation process.
Prerequisites
A pre-existing API entity under the "API Catalog"
Step-by-Step Guide
Step 1: Navigate to the API Entity Page
Log in to the T-Matic.
Under the "API Catalog" tab, locate and click on your desired API Entity, for example, "metrics-api"
Step 2: Initiate SDK Creation
On the "metrics-api" page, locate the section titled "Generate Code"
Choose your desired template such as "Typescript - Push to Github."
Step 3: Provide Component General Information
"Create New Component" form will appear.
Auto-filled fields like 'SDK Name' and 'Owner' will appear based on your selected template and current user data. Add or edit the 'Description' field.
Click "Next Step:"
Step 4: Repo Information
For GitHub templates, you will need to login to GitHub in order to perform code commits on behalf of your account
Click Log In and authorize OAuth app for actions
Confirm via entering password
Additional fields like 'Organization' (owner) and 'Repository' (name) will appear. Fill these in as well. Add organization prefix for npm package if necessary.
Proceed to Next step
Step 5: Generate Code Component
Click on the "Create" button located at the bottom of the form.
A "Task Activity" will display, showing steps like 'Generating Metadata', 'Generating SDK', and 'Registering into Catalog.'
If an error occurs, the chart will highlight the step where it happened and display an 'Error Message.'
Step 6: Review and merge pull request
Upon successful Component generation, a pull request will appear in the repository that was created to store the component. It requires merging in order to finalize component creation and package generation. Click on "View Pull Request" link
Merge the pull request
Step 7: Review Component
Click on "Open Component in catalog" link
Review Component page
Not npm package block which will be updated with npm package data once Workflow for publishing the package will be finished. You can review workflow status in the appropriate block on Component page
Attachments:
[image2023-10-26_9-14-16.png](attachments/123932706/137069222.png) (image/png) [image2023-10-26_9-14-42.png](attachments/123932706/137069223.png) (image/png) [image2023-10-26_9-19-37.png](attachments/123932706/137069224.png) (image/png) [image2023-10-26_21-46-33.png](attachments/123932706/137069252.png) (image/png) [Authorize application 2023-10-26 21-40-41.png](attachments/123932706/137069254.png) (image/png) [image2023-10-26_21-48-1.png](attachments/123932706/137069255.png) (image/png) [image2023-10-26_21-49-41.png](attachments/123932706/137069256.png) (image/png) [image2023-10-26_21-50-55.png](attachments/123932706/137069257.png) (image/png) [image2023-10-26_21-54-12.png](attachments/123932706/137069258.png) (image/png) [image2023-10-26_22-35-56.png](attachments/123932706/137069266.png) (image/png) [image2023-10-26_22-49-7.png](attachments/123932706/137069269.png) (image/png) [image2023-10-26_23-1-50.png](attachments/123932706/137069270.png) (image/png)
Last updated