dochia-list

name	dochia-list
description	List available Dochia resources including playbooks, mutators, OpenAPI paths, formats, and profiles. Use when the user wants to discover what test playbooks are available, inspect OpenAPI contract paths, see available mutators and formats, or explore what Dochia can test. Also use before running dochia test or dochia fuzz to help the user pick specific playbooks, paths, or methods.
metadata	{"triggers":"list dochia playbooks\nwhat playbooks are available\nshow API paths\nlist mutators\nwhat can dochia test\nshow available tests\ninspect openapi contract\nlist endpoints\n","examples":"dochia list --playbooks\ndochia list --playbooks --json\ndochia list --mutators\ndochia list --paths -c openapi.yml\n"}

Overview

dochia list displays available playbooks, mutators, OpenAPI paths, formats, profiles, and fuzzing strategies.

Basic Usage

# List all available playbooks
dochia list --playbooks

# List all playbooks in JSON format
dochia list --playbooks --json

# List all mutators
dochia list --mutators

# List all registered profiles
dochia list --profiles

# List supported OpenAPI formats
dochia list --formats

# List paths from an OpenAPI contract
dochia list --paths -c openapi.yml

# List details for a specific path
dochia list --paths -c openapi.yml --path /api/users

# List paths filtered by tag
dochia list --paths -c openapi.yml --tag users

Common Options

Option	Description
-f, --playbooks	List all registered playbooks
-m, --mutators	List all registered mutators
--profiles	List all registered profiles
--formats	List supported OpenAPI formats
-p, --paths	List paths from an OpenAPI contract
-c, --contract	OpenAPI contract file (required for --paths)
--path	Show details for a specific path
--tag	Filter paths by OpenAPI tag
-j, --json	Output in JSON format

Understanding Resource Dependencies

Use --paths to inspect the API structure before running tests. This helps identify resource dependencies that require a specific testing order:

# List all paths to understand the resource hierarchy
dochia list --paths -c openapi.yml

# Inspect a specific path to see its query parameters, http headers, response codes, and methods
dochia list --paths -c openapi.yml --path /pet/{petId}

Look for patterns like:

• POST /resource (creates) → GET/PUT/DELETE /resource/{id} (needs the created ID)
• POST /resource/{id}/subresource (needs parent resource ID first)

This is important because Dochia is stateless. When testing endpoints that require existing resource IDs, you should first create resources using the HappyPath playbook on creation endpoints, then supply the IDs via -R or --reference-data. See the dochia-test skill for the full stateful testing workflow.

Documentation

Full reference: https://docs.dochia.dev/cli/list