Add DataHUB documentation and API reference
- Introduced new documentation for the DataHUB service, including purpose, roles, and business case. - Added detailed API reference for Quotes and Visits, including search endpoints and response structures. - Created sections for service records, time reports, and visits in the CustomerHUB documentation. - Implemented a change log and test plan for the DataHUB project. - Updated the introduction to include links to the new DataHUB documentation. - Modified navbar configuration to reflect changes in documentation structure.
This commit is contained in:
1 parent
d1251a5f05
commit
928a4451f7
38 files changed
+1725
-3
No files matched your search
@@ -0,0 +1,44 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
title: Performance & AO Considerations
|
||||
---
|
||||
|
||||
# Performance & Application Objects (AO) Considerations
|
||||
|
||||
## Performance Considerations
|
||||
|
||||
### Data Rate Considerations
|
||||
|
||||
To ensure platform stability, predictable performance, and fair usage across consumers, the DataHUB service may implement configurable data rate limits at the service account level.
|
||||
|
||||
Rate limiting can be used to:
|
||||
|
||||
- Prevent excessive or unintended API consumption.
|
||||
- Protect HUB and DataHUB resources from large-volume extraction requests.
|
||||
- Ensure consistent performance for all API consumers.
|
||||
- Support differentiated access models for service accounts with varying data consumption requirements.
|
||||
|
||||
Rate limits may be based on factors such as:
|
||||
|
||||
- Requests per minute/hour.
|
||||
- Number of records returned per request.
|
||||
- Maximum date range for incremental extraction requests.
|
||||
- Concurrent requests per service account.
|
||||
|
||||
Specific thresholds will be determined during implementation and may be configured on a per-service-account basis according to business requirements and expected data volumes.
|
||||
|
||||
---
|
||||
|
||||
## Application Objects (AO) Considerations
|
||||
|
||||
The proposed DataHUB solution is expected to introduce approximately 10 new Application Objects (AOs).
|
||||
|
||||
Current estimates include:
|
||||
|
||||
- 6 REST API AOs to expose the planned DataHUB endpoints.
|
||||
- 1 Entity AO to manage Service Account configuration, permissions, API keys, and rate-limiting settings.
|
||||
- Additional supporting AOs for business logic, security, monitoring, and future extensibility.
|
||||
|
||||
Although the initial implementation is currently estimated at 7 primary AOs, a planning estimate of 10 AOs is recommended to accommodate implementation refinements, supporting components, and unforeseen requirements identified during development.
|
||||
|
||||
This estimate provides sufficient flexibility while ensuring the solution remains scalable and maintainable.
|
||||
Reference in new issue
Block a user