Commit graph

19 commits

Author SHA1 Message Date
Nawaz Dhandala
ce7925f947
Add code tabs for multiple programming languages in API reference
- Implemented a dynamic code tab component using EJS for rendering code examples in various languages (cURL, JavaScript, Python, Go, Ruby, Rust, PowerShell).
- Added responsive design with tab switching functionality and copy-to-clipboard feature.
- Integrated local storage to remember user’s preferred programming language across sessions.
- Enhanced accessibility with ARIA roles and attributes for better screen reader support.
2025-12-18 21:56:10 +00:00
Nawaz Dhandala
aa0105a8e2
Refactor example formatting in database models for consistency
- Updated example strings in various database model files to use consistent line breaks for improved readability.
- Ensured that all example properties are formatted uniformly across models, enhancing maintainability and clarity.
2025-12-12 21:23:31 +00:00
Nawaz Dhandala
ca5c31fc32
Add example values to various fields in Telemetry and User models for better documentation
- Updated TelemetryException model with example values for Project, Telemetry Service, Exception Message, Stack Trace, Exception Type, Finger Print, Created by User, and more.
- Enhanced TelemetryIngestionKey model with example values for Project, Name, Description, Created by User, and more.
- Improved TelemetryUsageBilling model with example values for Project, Day, Product Type, Data Ingested, Total Cost, and more.
- Added example values to UserCall model for Project ID, Phone, User ID, Created by User ID, and more.
- Included example values in UserEmail model for Project ID, Email, User ID, Created by User ID, and more.
- Updated UserNotificationRule model with example values for Project ID, User ID, Created by User ID, and various notification types.
- Enhanced UserNotificationSetting model with example values for Project ID, User ID, and various notification settings.
- Improved UserOnCallLog model with example values for User ID, Project ID, On-Call Policy ID, and more.
- Added example values to UserSMS model for Project ID, Phone, User ID, Created by User ID, and more.
2025-12-12 21:10:10 +00:00
Nawaz Dhandala
e928328bbb
Add example values to various database models for improved API documentation
- Updated MonitorStatus, OnCallDutyPolicy, Probe, Project, ScheduledMaintenance, ScheduledMaintenanceInternalNote, ServiceCatalog, StatusPage, StatusPageAnnouncement, StatusPageDomain, StatusPageGroup, StatusPageHeaderLink, StatusPageResource, StatusPageSubscriber, Team, TelemetryService, User, and Workflow models to include example values for better clarity in API documentation.
- Added example fields to TableColumnMetadata interface to support documentation generation.
2025-12-12 20:49:28 +00:00
Nawaz Dhandala
380ecfa096
Refactor code for consistency and readability
- Updated array and object property access from single quotes to double quotes in Pagination.ts and Permissions.ts for consistency.
- Added missing commas in function parameters and object literals across multiple files in AlertService.ts, IncidentService.ts, MonitorService.ts, ScheduledMaintenanceService.ts, and WorkspaceNotificationRuleService.ts.
- Improved error logging messages in various services for better clarity.
- Removed unnecessary line breaks in Slack.ts and Workspace.ts for cleaner code.
- Ensured consistent formatting in Routes.ts by adding missing commas and adjusting line breaks.
2025-09-03 15:37:39 +01:00
Simon Larsen
e1cfe24a24
fix: Update pageData property access to bracket notation for consistency 2025-09-02 22:59:23 +01:00
Nawaz Dhandala
5ebdb1ef7d
fix: Refactor code for improved readability and maintainability in various components 2025-09-02 21:57:15 +01:00
Nawaz Dhandala
6504731025
refactor: Replace 'any' types with specific types for improved type safety across multiple files 2025-09-02 20:41:24 +01:00
Nawaz Dhandala
78d43e1a1c
fix: Clean up formatting and improve readability in DataType and MailService classes 2025-07-10 16:21:44 +01:00
Simon Larsen
c0909c68c8
feat: Add 'includes' functionality with documentation and example usage 2025-07-10 14:14:36 +01:00
Simon Larsen
53ff7ebc5c
fix: improve code formatting and readability in Routes and OpenAPI service files 2025-06-12 18:00:45 +01:00
Simon Larsen
8190ae0624
feat: add OpenAPI specification support and update navigation links 2025-06-12 17:57:27 +01:00
Simon Larsen
c1009a3361
fix: standardize formatting and improve readability in various schema and model files 2025-06-12 17:38:28 +01:00
Simon Larsen
3cdedee597
fix: filter out columns marked to be hidden in documentation from table columns 2025-06-12 11:51:54 +01:00
Simon Larsen
233bc1b70d
feat: Add LessThanOrNull and GreaterThanOrNull types with corresponding query helpers and examples 2025-05-15 20:10:53 +01:00
Simon Larsen
47a9de0dd3
Refactor and enhance OnCallDutyPolicy functionality
- Updated ServiceHandler to correctly handle Google Tag Manager enabling.
- Cleaned up whitespace in Serve.ts for better readability.
- Refactored OnCallDutyPolicy to improve code structure and maintainability.
- Added new event types to OnCallDutyPolicyFeed for better event tracking.
- Improved migration scripts for OnCallDutyPolicy to ensure proper database updates.
- Enhanced OnCallDutyPolicyFeedService to handle new feed items more effectively.
- Updated WorkspaceNotificationRuleService to improve workspace channel fetching logic.
- Cleaned up various files for consistent formatting and readability.
- Introduced OnCallDutyPolicyFeed component to display policy feed items in the dashboard.
- Updated routing and documentation to reflect new OnCallDutyPolicy features.
2025-04-16 13:39:25 +01:00
Simon Larsen
bd2f61e251
feat: integrate IsBillingEnabled for Google Tag Manager in service responses 2025-04-16 11:29:46 +01:00
Simon Larsen
45aed7de45
feat: add enableGoogleTagManager flag to service responses and views 2025-04-16 11:27:11 +01:00
Simon Larsen
68389cda85
Add API reference code examples and configuration files 2024-09-18 14:39:11 +01:00