Hello, how can we help?
Choose a category to quickly find the help you need or contact us
Getting Started
Get help with first stepsCreate an Account: Click on the 'Sign Up' button.
Log In: Use your username or email to log in to the GST Hub platform.
The Home View provides an overview of your account:
- The number of projects.
- The number of catalogs under each project.
- The specific OpenAPIs associated with each catalog.
- View latest changes made in business fields projects, and OpenAPIs.
Profile Setup:
Access profile and settings by clicking on the profile icon on the search bar.
My profile
Access all your personal data or delete your account.
Settings- Change your password.
- Generate an API/CLI token.
- View your recent activity, including sources and devices used.
A Project serves as an abstraction for a tenant in a multi-tenant or multi-project setup.
A Catalog is a subcategory within a project, offering support for various environment settings such as environment URLs, links to developer portals, and more.
In future versions, catalogs will play a crucial role in defining deployment environments and general settings. These settings will include shared headers and query parameters for OpenAPI operations, as well as shared responses for errors and exceptions.
Add new project
- Navigate to Projects.
- Click on Add New Project.
- Enter a name and an optional description.
- Press the Add button.
Add new Catalog
-
Navigate to Projects and click on the project name to go to the catalogs.
-
Click on Add Catalog
-
Fill the form and press Add button
Currently, the catalog can accommodate only OpenAPI resources. It is the sole way to add, access, and modify OpenAPI resources.
Business Fields
Primitive type fields are essential for maintaining clear and precise data models, which are crucial for both data governance and application development.A primitive type Business Field refers to a field that is defined with a specific, primitive data type.
This type of field ensures data consistency and integrity by restricting the field to accept only one type of data.
Key Characteristics:
-
Data Consistency: Enforce a single data type, to ensure that the data entered is always consistent and predictable.
-
Data Integrity: By limiting the field to one type of data, you reduce the risk of errors and data corruption.
-
Simplified Validation: Easier to validate and enforce rules on the data entered into these fields.
New fields can be added on the business fields view or in the process of creating a schema.
To add a new field go to Resources -> Business Fields -> click Add Business Field
This will give access to all supported options for the specific field.
Now you can click edit and add the name and the propreties and press save.
Business Schemas
Using business schemas, organizations can ensure data consistency, accuracy and compliance across various systems and departments.Define the organization, rules and constraints of your business data by modeling business objects.
Define a blueprint for how data is stored, organized and validated within your applications and services.
Key Characteristics:
-
Structured Data Representation: Provides a clear and organized way to represent your business data, making it easier to understand and use.
-
Validation Rules: Defines rules and constraints to ensure the data conforms to required formats and business logic.
-
Interoperability: Facilitates seamless data exchange and integration between different systems and services.
-
Documentation: Serves as a comprehensive documentation of your data models, making it easier for new team members to understand and for stakeholders to review.
To learn more about adding new schema see Schema editor section.
OpenAPI Services
A centralized hub for managing and accessing all your OpenAPI specifications.This section is designed to streamline the organization and retrieval of your OpenAPIs, making it easier for you to find and utilize the APIs you need.
Key Characteristics:
-
View All Catalogs: Access a comprehensive list of all your API catalogs in one place.
Each catalog lists OpenAPIs reated to the existing catalogs, helping you maintain an organized and structured API ecosystem. -
Browse OpenAPIs by Catalog: Within each catalog, you can view all the OpenAPI specifications it contains. This allows you to quickly navigate through your APIs based on their functional or business grouping.
-
Search Functionality: If you don't remember the specific catalog that an OpenAPI belongs to, use the search bar feature to find the OpenAPI directly.
Simply enter the API name or keywords related to the OpenAPI you are looking for, and GST Hub will locate it for you.
Change history
View of all modifications made to your:- business fields
- business objects/schemas
- projects
- catalogs
- OpenAPIs
Track changes efficiently and return to previous points of interest.
Key Characteristics:
-
View All Changes:
Access a detailed log of changes across all your business fields, objects/schemas, projects, catalogs, and OpenAPIs.
Each change entry includes information about what was modified, who made the change, and when it occurred. -
Categorized Change Logs:
Changes are categorized based on the type of entity (e.g., business fields, schemas, projects) to help you quickly find the information you need. -
Quick Reversion and version operetions:
Future version will enable user to easily copmpare with previous version and revert to previous versions of any entity.
This feature will allow you to undo changes and restore previous states, ensuring that you can quickly correct mistakes or revert to a known good configuration.
About us
IntroductionOur state-of-the-art tools make it easy to create and manage schemas, ensuring seamless integration with your deployment pipelines and CI/CD processes.
OpenAPI editor
3.0Whether you're defining new APIs or updating existing ones, the OpenAPI Editor provides an intuitive interface that caters to both technical and non-technical users, ensuring that everyone can contribute to your API development process.
- User-Friendly Interface:
The editor features a clean and intuitive interface that makes it easy to create and modify OpenAPI specifications without needing deep technical knowledge. - Autocomplete and Suggestions:
Speed up your workflow with intelligent autocomplete and suggestions that help you fill in API details quickly and accurately. -
Schema Integration:
Seamlessly integrate business schemas into your OpenAPI specifications, ensuring consistency and reusability across your projects. - Future development will include more user frenadly options, Real-Time Validation, Version Control and Collaboration Tools
-
Catalog Options
To add a new API you must first go to Projects choose a project or create one and add a new catalog or select an existing one.
On the catalog view you can choose from three options:
1. Clone from Existing here you can clone, any OpenAPI as a new version from your environoment, to the specific catalog.
2. Add New OpenAPI Service here you can crate an OpenAPI from scratch.
3. Import from Raw text here you can import an existing OpenAPI artifact.
Add new API
Declare a first new path, path operations and path parameters and submit.