-
Notifications
You must be signed in to change notification settings - Fork 4
Home
This is a Wiki contains documentation and materials related to Qubership-APIHUB product and its ecosystem.
Here we store User documentation, design articles, test cases architecture notes and so on.
Please see table of content on the right side.
Application status: Production ready
APIHUB itself is an application (k8s native, microservice architecture based) implements Dev Portal functionality in API Management domain.
For more details please refer to main APIHUB application repository: https://github.com/Netcracker/qubership-apihub
During APIHUB development and evolution some extra applications were created.
Overall architecture diagram:

Under construction (Opensource adaptation in progress)
qubership-apihub-agent is a golang application (microservice) providing the following features:
Designed for k8s deployment, Requires ClusterView permissions Using k8s API able to execute REST calls to any service Discovers API specificiations (OpenAPI, GQL) exposed by services Integrates with Qubership-APIHUB application
https://github.com/Netcracker/qubership-apihub-agent
Under construction (Development preview)
The qubership-api-linter-service is a Golang-based microservice that provides a REST API endpoint for linting and validating OpenAPI Specification (OAS) files. It serves as a quality control tool for API definitions, helping developers maintain consistency and adhere to best practices in their API documentation.
https://github.com/Netcracker/qubership-api-linter-service
Under construction (code published, PoC quality. Development planned for R25.3)
"Cloud Wireshark". Contains two parts:
sniffer-agent - DaemonSet for k8s which works on hostNetwork level and collects all network packets to S3 storage
traffic-analyzer - A service to load, analyze and make reports on the captured packet data. qubership-apihub-traffic-analyzer is intended to use as web-service in connection with qubership-apihub-sniffer-agent.
- https://github.com/Netcracker/qubership-apihub-sniffer-agent
- https://github.com/Netcracker/qubership-apihub-traffic-analyzer

Comprehensive description of aspects of Qubership APIHUB development.
Mandatory for reading for new team members.
TODO
Processes description
Technical articles
Design Items
- Navigation to APIHUB (log in / log out)
- Create Workspace
- Create Group
- Create Package
- Favorite packages, dashboards, groups, workspaces
- Shared Packages
- Activity History in Main Page
- Personal private workspace
- Version summary
- Revision History
- Package Activity History
- Manage Manual Operations Group
- Export Operations Group (reduced source specifications)
- Export Operations Group (combined specification)
- Export List of Operations in Excel
- Search and Filter Operations
- List of Operations
- List of Operations Groups
- Manage REST Path Prefix Group
- Activity History
- List of Deprecated Operations
- Export List of Changes in Excel
- Human‐readable description for deprecated items for OpenAPI 3.0
- List of Documents
- OpenAPI Document Overview
- Copy Package Version
- Export Package Version
- Export Document from Package Version
- Export List of Deprecated Operations in Excel
- API Quality Validation Result
- Export of discrepancy analysis results for arbitrary package versions in Excel
- AI Recommendations Tab
- General Settings
- Package versions list
- Access Tokens Management
- Delete Package
- Default Release Version
- Define Release Version Pattern