Skip to content

Commit df49bb3

Browse files
author
Lukas Geiger
committed
docs: sharpen ApiProber discovery context
1 parent ce34ec2 commit df49bb3

4 files changed

Lines changed: 36 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Changelog
22

3+
## 2026-06-06
4+
5+
- Added a README start table and smoke-test badge for clearer GitHub entry.
6+
- Expanded `llms.txt` with search phrases and disambiguation context.
7+
- Corrected private vulnerability reporting links after the move to `dev-bricks/apiprober`.
8+
39
## 2026-06-01
410

511
- Fixed repository metadata after the move to `dev-bricks/apiprober`.

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
# ApiProber -- Passive API Discovery and Documentation Tool
66

7+
[![ApiProber smoke tests](https://github.com/dev-bricks/apiprober/actions/workflows/tests.yml/badge.svg)](https://github.com/dev-bricks/apiprober/actions/workflows/tests.yml)
8+
79
ApiProber is a zero-dependency Python CLI for passive API discovery. It helps
810
developers and maintainers map undocumented REST services, compare live
911
behavior with API documentation, persist observations in SQLite, and export
@@ -13,6 +15,18 @@ Markdown or JSON documentation.
1315

1416
---
1517

18+
## Start Here
19+
20+
| Goal | Command or File |
21+
|---|---|
22+
| Try the CLI | `python api_prober.py --help` |
23+
| Map an authorized API | `python api_prober.py probe <base-url>` |
24+
| Export documentation | `python api_prober.py export <service> --format md` |
25+
| Read machine context | [`llms.txt`](llms.txt) |
26+
| Report a vulnerability privately | [`SECURITY.md`](SECURITY.md) |
27+
28+
---
29+
1630
## Best Fit
1731

1832
- Internal REST services where no OpenAPI file exists
@@ -180,7 +194,12 @@ ApiProber/
180194

181195
`passive API discovery`, `REST API documentation generator`, `OpenAPI detection`,
182196
`HATEOAS link crawler`, `local-first API reconnaissance`, `zero-dependency Python
183-
CLI`, `SQLite API inventory`, `ethical API probing`
197+
CLI`, `SQLite API inventory`, `ethical API probing`, `authorized API inventory`,
198+
`REST endpoint mapper`
199+
200+
ApiProber is unrelated to Cloudprober, probe-rs, code-search probe tools, and
201+
active uptime monitoring systems. Its focus is local, rate-limited REST API
202+
surface documentation for systems you own or are explicitly allowed to assess.
184203

185204
---
186205

SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
If you find a security vulnerability, please report it responsibly:
66

77
1. **Do NOT open a public issue**
8-
2. **Use GitHub's [private vulnerability reporting](https://github.com/lukisch/apiprober/security/advisories/new)**
8+
2. **Use GitHub's [private vulnerability reporting](https://github.com/dev-bricks/apiprober/security/advisories/new)**
99
3. Include: description, steps to reproduce, potential impact
1010

1111
### How to Report
1212

13-
1. Go to: https://github.com/lukisch/apiprober/security/advisories/new
13+
1. Go to: https://github.com/dev-bricks/apiprober/security/advisories/new
1414
2. Fill out the form (title, description, severity, affected versions)
1515
3. Submit privately (not visible to public until disclosed)
1616

llms.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,11 @@ python api_prober.py probe https://jsonplaceholder.typicode.com --depth 0 --dela
6767

6868
passive API discovery, REST API documentation generator, OpenAPI detection,
6969
HATEOAS link crawler, local-first API reconnaissance, zero-dependency Python CLI,
70-
SQLite API inventory, ethical API probing
70+
SQLite API inventory, ethical API probing, authorized API inventory, REST endpoint
71+
mapper, undocumented REST API documentation, local OpenAPI discovery
72+
73+
## Disambiguation
74+
75+
ApiProber is not Cloudprober, probe-rs, an uptime monitor, a hardware debug
76+
probe, or a semantic code-search engine. It is a local Python CLI for documenting
77+
authorized REST API surfaces with read-only probing and SQLite persistence.

0 commit comments

Comments
 (0)