scout-api-testing

Official

Streamline Kibana API test development.

Authorelastic
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill simplifies the creation, debugging, and review of API tests for Kibana's Scout framework, ensuring robust and efficient testing of API endpoints.

Core Features & Use Cases

  • API Test Creation: Write and structure API tests using the apiTest fixture.
  • Authentication Handling: Choose between API keys (requestAuth) for api/* endpoints and cookies (samlAuth) for internal/* endpoints.
  • Assertion Library: Utilize custom matchers for status codes, headers, and response bodies.
  • Service Integration: Leverage apiServices for server-side helpers and kbnClient for direct Elasticsearch interaction.
  • Use Case: When developing a new API endpoint in Kibana, use this Skill to write comprehensive tests that cover authentication, request/response validation, and side effects.

Quick Start

Use the scout-api-testing skill to write a new API test for the /api/my_plugin/users endpoint, authenticating with an API key.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: scout-api-testing
Download link: https://github.com/elastic/kibana/archive/main.zip#scout-api-testing

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.