skills.rest
TencentBlueKing
TencentBlueKingOFFICIAL
Explore all skills by this author →
WebsiteGitHub

bklog-api-services

Map BKLog API services, entry points, and data flow into a navigable reference.

88|138|Updated Oct 26, 2023
Search Tags:#documentation#api#reference#map#services#data-flow#bklog
One-click install
npx skills add https://github.com/TencentBlueKing/bk-monitor --skill bklog-api-services
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bklog-api-services
Source: https://github.com/TencentBlueKing/bk-monitor/tree/main/bklog/web/.ai-shared/skills/bklog-api-services
Command: npx skills add https://github.com/TencentBlueKing/bk-monitor --skill bklog-api-services

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill maps BKLog API services and their entry points into a cohesive, navigable reference.

Core Features & Use Cases

  • Centralized map of API entry points, services, and HTTP interfaces
  • Documentation of data flow and change impact across services to guide integration and maintenance
  • Use case: A developer reviews API surface before updating a service to understand downstream impact

Quick Start

Use the bklog-api-services skill to explore the API service map and read the api-reference.md for endpoint details.

Frequently Asked Questions about bklog-api-services

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is a BKLog API service map and how does it help developers?▼

A BKLog API service map provides a centralized reference of API entry points and HTTP interfaces. It helps frontend and backend developers understand data flow and change impact across services to guide integration and maintenance.

How do I check the downstream impact before updating a BKLog API service?▼

To check the downstream impact of updating a BKLog API service, review the ChangeImpact section of the API documentation. It details how modifications affect interconnected services and the HTTP layer.

How do I navigate BKLog API entry points for frontend and backend integration?▼

You navigate BKLog API entry points by using the centralized API service map, which organizes exposed HTTP interfaces and data flow details. This structured reference anchors documentation to sections like Map, DataFlow, and Boundaries for consistent loading.

Does the BKLog API reference require a specific documentation format for services?▼

Yes, the BKLog API reference enforces a frontmatter schema requiring name and description fields. This anchors the documentation content to specific sections like Map, DataFlow, ChangeImpact, Boundaries, and Refs, ensuring consistent loading and navigation.

What are the limitations of using a centralized API map for BKLog service maintenance?▼

The centralized API map focuses on mapping entry points, data flow, and boundaries for BKLog services, so it serves as a navigable reference rather than an automated testing tool. It does not dynamically execute changes but guides manual integration and maintenance.

Related Skills

Explore More Software Engineering Skills→
riezriez
1

conventions-docs

Define documentation conventions for CLAUDE.md, README.md, and diff formats.

Community
Intermediate
saleorsaleor
29

analyzing-test-coverage

Generate and analyze Vitest-based tests with MSW-driven network mocks.

Official
Advanced
erhankaraarslanerhankaraarslan

codebase-research

Analyze a codebase to reveal architecture, data flow, and entry points.

Community
Intermediate
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate