# Documentation review draft

Inspect each finding before changing documentation. This summary is not an applicable patch or an independent accuracy evaluation. Unverifiable claims remain unresolved.

[Open the evidence report](https://13-211-179-95.sslip.io/scan/example-fastapi-svc) · Revision `5b559ed74770a06859fe6e5450978b7c1ff31c05`

# Documentation health: 0/100

| Verdict | Count |
| --- | ---: |
| ok | 0 |
| missing | 1 |
| renamed | 3 |
| default_changed | 1 |
| invalid_command | 0 |
| unverifiable | 0 |

## README.md

**renamed · line 3** GET /users/{id}

```diff
- GET /users/{id}
+ GET /v2/users/{param}
```

<details><summary>Evidence</summary>

README.md:3

```text
GET /users/{id}
```

service.py:11

```text
GET /v2/users/{param}
```

service.py:1

```text
-    @app.get("/users/{id}")
+    @app.get("/v2/users/{id}")
```

2d94162 Move user lookup to v2 2026-10-02T09:00:00+00:00
</details>

**missing · line 4** POST /login

```diff
- POST /login
+ No indexed endpoint named POST /login was found. No close indexed candidates were found.
```

<details><summary>Evidence</summary>

README.md:4

```text
POST /login
```

a6da426 Remove the login endpoint 2026-10-03T09:00:00+00:00
</details>

**renamed · line 5** request_timeout

```diff
- request_timeout
+ timeout_seconds
```

<details><summary>Evidence</summary>

README.md:5

```text
request_timeout
```

service.py:1

```text
-    request_timeout: int = 30
+    timeout_seconds: int = 60
```

b7d9a6d Rename timeout setting and increase its default 2026-10-04T09:00:00+00:00
</details>

**default_changed · line 6** defaults to &#96;30&#96;

```diff
- defaults to `30`
+ timeout_seconds (default 60)
```

<details><summary>Evidence</summary>

README.md:6

```text
defaults to `30`
```

service.py:1

```text
-    request_timeout: int = 30
+    timeout_seconds: int = 60
```

b7d9a6d Rename timeout setting and increase its default 2026-10-04T09:00:00+00:00
</details>

**renamed · line 7** create_app

```diff
- create_app
+ build_app
```

<details><summary>Evidence</summary>

README.md:7

```text
create_app
```

service.py:1

```text
-def create_app():
+def build_app():
```

5b559ed Rename the application factory 2026-10-05T09:00:00+00:00
</details>