vimanam 1.4.2

OpenAPI/Swagger to Markdown documentation generator with grouping, filtering, and detail levels for docs and LLM context
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
//! The grouping views: one `generate_*` function per grouping mode, plus the
//! filtering and sorting helpers they share. Each renders the document preamble
//! (title, servers, auth) and delegates per-endpoint rendering to
//! [`write_endpoint`](super::endpoint::write_endpoint).

use std::collections::HashMap;
use std::io::Write;

use anyhow::Result;
use indexmap::IndexMap;

use crate::models::{ApiDocumentation, DocConfig, Endpoint, Service, SortMethod};
use crate::utils::clean_for_id;

use super::endpoint::{get_short_title, write_endpoint};
use super::schema::{SchemaContext, prediscover_rendered_endpoints, render_schema_definitions};

/// The in-document anchor for an endpoint heading. `prefix` (a service name)
/// scopes it so the same endpoint rendered under several services—as the
/// service-grouped view does for an operation carrying multiple tags—gets a
/// distinct anchor each time, keeping the table of contents unambiguous.
///
/// `method` + `path` already uniquely identify an endpoint, so the unscoped form
/// is collision-free for the views that render each endpoint once.
fn endpoint_anchor(prefix: Option<&str>, endpoint: &Endpoint) -> String {
    match prefix {
        Some(prefix) => clean_for_id(&format!("{} {} {}", prefix, endpoint.method, endpoint.path)),
        None => clean_for_id(&format!("{} {}", endpoint.method, endpoint.path)),
    }
}

/// Sorts endpoints in place using the configured method.
///
/// Every view sorts through this single function so that, within a document,
/// the table of contents and the body sections always share one ordering
/// (otherwise TOC anchor links can point to a different sequence than the
/// sections themselves).
fn sort_endpoints(endpoints: &mut [&Endpoint], sort_method: &SortMethod) {
    match sort_method {
        SortMethod::Alphabetical => {
            endpoints.sort_by(|a, b| a.path.cmp(&b.path).then(a.method.cmp(&b.method)));
        }
        SortMethod::PathLength => {
            endpoints.sort_by_key(|a| a.path.len());
        }
        SortMethod::None => {}
    }
}

/// Case-insensitive membership test for `--service-filter` against a service
/// (tag) name. Mirrors the case-insensitivity of `--method-filter` so that a
/// case mismatch doesn't silently produce empty output.
fn service_matches_filter(name: &str, filter: &[String]) -> bool {
    filter.iter().any(|entry| entry.eq_ignore_ascii_case(name))
}

/// Whether a service (tag) name is one the `--service-filter` keeps. Always true
/// when no service filter is set.
pub(crate) fn service_is_visible(name: &str, config: &DocConfig) -> bool {
    match &config.service_filter {
        Some(filter) => service_matches_filter(name, filter),
        None => true,
    }
}

/// The endpoints the rendered body contains, in the configured sort order:
/// every endpoint that survives `--exclude-deprecated`, `--method-filter`,
/// `--path-filter` and `--service-filter`, each listed once. This is the single
/// definition of "what the document covers" shared by the flat view and the
/// spec hygiene report, so the two can never disagree about scope.
pub(crate) fn visible_endpoints<'a>(
    doc: &'a ApiDocumentation,
    config: &DocConfig,
) -> Vec<&'a Endpoint> {
    let mut endpoints: Vec<&Endpoint> = doc
        .endpoints
        .iter()
        .filter(|endpoint| {
            passes_filters(endpoint, config) && passes_service_filter(endpoint, config)
        })
        .collect();

    sort_endpoints(&mut endpoints, &config.sort_method);
    endpoints
}

/// Whether an endpoint survives the deprecated, method, path and exact
/// operation (`--operation`/`--operation-id`) filters that every view applies.
/// The service filter is handled separately ([`passes_service_filter`]): the
/// service-grouped views narrow their service list instead of filtering
/// endpoints.
fn passes_filters(endpoint: &Endpoint, config: &DocConfig) -> bool {
    if let Some(selector) = &config.operation_selector
        && !selector.matches(endpoint)
    {
        return false;
    }
    rejecting_endpoint_filters(endpoint, config).is_empty()
}

/// The deprecated, method and path filters that reject `endpoint`, as the
/// flags a user would type, in a fixed order.
fn rejecting_endpoint_filters(endpoint: &Endpoint, config: &DocConfig) -> Vec<&'static str> {
    let mut filters = Vec::new();
    if config.exclude_deprecated && endpoint.deprecated {
        filters.push("--exclude-deprecated");
    }
    if let Some(methods) = &config.method_filter
        && !methods.contains(&endpoint.method)
    {
        filters.push("--method-filter");
    }
    if let Some(path_pattern) = &config.path_filter
        && !endpoint.path.contains(path_pattern)
    {
        filters.push("--path-filter");
    }
    filters
}

/// Every flag other than the exact operation selector that removes `endpoint`
/// from the document, in a fixed order; empty when it would be rendered. Used
/// to explain why a selected operation produced no output.
pub(crate) fn removing_filters(endpoint: &Endpoint, config: &DocConfig) -> Vec<&'static str> {
    let mut filters = rejecting_endpoint_filters(endpoint, config);
    if !passes_service_filter(endpoint, config) {
        filters.push("--service-filter");
    }
    filters
}

/// Whether an endpoint belongs to one of the `--service-filter` services. Always
/// true when no service filter is set.
fn passes_service_filter(endpoint: &Endpoint, config: &DocConfig) -> bool {
    match &config.service_filter {
        Some(filter) => endpoint
            .services
            .iter()
            .any(|s| service_matches_filter(s, filter)),
        None => true,
    }
}

/// Under `--operation`/`--operation-id`, keeps only the services that contain a
/// selected, visible endpoint. Without a selector the list is untouched, so
/// existing output never changes.
fn retain_selected_services(
    services: &mut Vec<&Service>,
    service_endpoints: &HashMap<&str, Vec<&Endpoint>>,
    config: &DocConfig,
) {
    if config.operation_selector.is_some() {
        services.retain(|service| service_endpoints.contains_key(service.name.as_str()));
    }
}

/// Writes the document preamble shared by every view: title, description, API
/// version, and—when `--include-auth` is set—the server URLs and authentication
/// schemes.
pub(super) fn write_preamble<W: Write>(
    writer: &mut W,
    doc: &ApiDocumentation,
    config: &DocConfig,
) -> Result<()> {
    writeln!(writer, "# {}", doc.title)?;
    if let Some(description) = &doc.description {
        writeln!(writer, "\n{}\n", description)?;
    }
    writeln!(writer, "API Version: {}\n", doc.version)?;

    // Add server URLs if available
    if !doc.servers.is_empty() && config.include_auth {
        writeln!(writer, "## Server URLs")?;
        for server in &doc.servers {
            writeln!(writer, "* {}", server)?;
        }
        writeln!(writer)?;
    }

    // Add security schemes if available
    if !doc.security_schemes.is_empty() && config.include_auth {
        writeln!(writer, "## Authentication")?;
        for (name, desc) in &doc.security_schemes {
            writeln!(writer, "* **{}**: {}", name, desc)?;
        }
        writeln!(writer)?;
    }

    Ok(())
}

/// Generates the `--detail summary` view: a compact list of services and their operations.
pub(super) fn generate_summary<W: Write>(
    writer: &mut W,
    doc: &ApiDocumentation,
    config: &DocConfig,
) -> Result<()> {
    write_preamble(writer, doc, config)?;

    // Filter services if needed (case-insensitive)
    let mut services = if let Some(filter) = &config.service_filter {
        doc.services
            .iter()
            .filter(|s| service_matches_filter(&s.name, filter))
            .collect::<Vec<_>>()
    } else {
        doc.services.iter().collect()
    };

    // Group endpoints by service
    let mut service_endpoints: HashMap<&str, Vec<&Endpoint>> = HashMap::new();
    for endpoint in &doc.endpoints {
        if !passes_filters(endpoint, config) {
            continue;
        }

        for service_name in &endpoint.services {
            service_endpoints
                .entry(service_name)
                .or_default()
                .push(endpoint);
        }
    }

    // An exact selection is about its operations, so services it leaves empty
    // are dropped instead of padding the output with empty sections.
    retain_selected_services(&mut services, &service_endpoints, config);

    // Write Services List
    writeln!(writer, "## Services")?;

    for service in &services {
        writeln!(writer, "- {}", service.name)?;

        // Add operation links under each service
        if let Some(endpoints) = service_endpoints.get(&service.name as &str) {
            let mut sorted_ops = endpoints.clone();
            sort_endpoints(&mut sorted_ops, &config.sort_method);

            for endpoint in sorted_ops {
                let op_name = if let Some(operation_id) = &endpoint.operation_id {
                    // Clean up the operation ID by removing the service name prefix if present
                    operation_id
                        .strip_prefix(&format!("{}_", service.name))
                        .unwrap_or(operation_id)
                        .to_string()
                } else {
                    // Fallback if no operation ID
                    format!("{} {}", endpoint.method, endpoint.path)
                };

                writeln!(writer, "  * {}", op_name)?;
            }
        }
    }

    Ok(())
}

/// Generates documentation grouped by service (tag), one `##` section per service.
pub(super) fn generate_by_service<W: Write>(
    writer: &mut W,
    doc: &ApiDocumentation,
    config: &DocConfig,
) -> Result<Vec<String>> {
    write_preamble(writer, doc, config)?;

    // Filter services if needed (case-insensitive)
    let mut services = if let Some(filter) = &config.service_filter {
        doc.services
            .iter()
            .filter(|s| service_matches_filter(&s.name, filter))
            .collect::<Vec<_>>()
    } else {
        doc.services.iter().collect()
    };

    // Group endpoints by service - MOVED THIS UP before TOC generation
    let mut service_endpoints: HashMap<&str, Vec<&Endpoint>> = HashMap::new();
    for endpoint in &doc.endpoints {
        if !passes_filters(endpoint, config) {
            continue;
        }

        for service_name in &endpoint.services {
            service_endpoints
                .entry(service_name)
                .or_default()
                .push(endpoint);
        }
    }

    // As in the summary view, services an exact selection leaves empty are
    // dropped.
    retain_selected_services(&mut services, &service_endpoints, config);

    // Table of Contents (if enabled)
    if config.include_toc {
        writeln!(writer, "## Services\n")?;
        for service in &services {
            let anchor = clean_for_id(&service.name);
            writeln!(writer, "- [{}](#{anchor})", service.name)?;

            // Add operation links under each service
            if let Some(endpoints) = service_endpoints.get(&service.name as &str) {
                let mut sorted_ops = endpoints.clone();
                sort_endpoints(&mut sorted_ops, &config.sort_method);

                for endpoint in sorted_ops {
                    // Extract a shorter title for the TOC entry
                    let op_title = get_short_title(endpoint);
                    let op_anchor = endpoint_anchor(Some(&service.name), endpoint);
                    writeln!(writer, "  * [{}](#{op_anchor})", op_title)?;
                }
            }
        }
        writeln!(writer)?;
    }

    // Write each service section
    let mut schema_ctx = SchemaContext::configured(doc, config, false);
    prediscover_rendered_endpoints(
        &mut schema_ctx,
        config,
        services.iter().flat_map(|service| {
            service_endpoints
                .get(service.name.as_str())
                .into_iter()
                .flatten()
                .copied()
        }),
    );
    for service in &services {
        // Create anchor but use it directly in the writeln! call
        let anchor = clean_for_id(&service.name);
        writeln!(writer, "## {} {{#{}}}", service.name, anchor)?;

        if let Some(description) = &service.description {
            writeln!(writer, "\n{}", description)?;
        }

        // Get endpoints for this service
        if let Some(endpoints) = service_endpoints.get(&service.name as &str) {
            // Sort endpoints as configured
            let mut sorted_endpoints = endpoints.clone();
            sort_endpoints(&mut sorted_endpoints, &config.sort_method);

            for endpoint in sorted_endpoints {
                let anchor = endpoint_anchor(Some(&service.name), endpoint);
                write_endpoint(writer, endpoint, config, Some(&anchor), &mut schema_ctx)?;
            }
        } else {
            writeln!(writer, "\nNo endpoints found for this service.\n")?;
        }
    }

    render_schema_definitions(writer, &mut schema_ctx)?;

    Ok(schema_ctx.take_omissions())
}

/// Generates documentation grouped by HTTP method, one `##` section per method.
pub(super) fn generate_by_method<W: Write>(
    writer: &mut W,
    doc: &ApiDocumentation,
    config: &DocConfig,
) -> Result<Vec<String>> {
    write_preamble(writer, doc, config)?;

    // Group endpoints by method
    let mut method_endpoints: HashMap<&str, Vec<&Endpoint>> = HashMap::new();
    for endpoint in &doc.endpoints {
        if !passes_filters(endpoint, config) || !passes_service_filter(endpoint, config) {
            continue;
        }

        method_endpoints
            .entry(&endpoint.method)
            .or_default()
            .push(endpoint);
    }

    // Table of Contents (if enabled)
    if config.include_toc {
        writeln!(writer, "## HTTP Methods\n")?;
        for method in [
            "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD", "TRACE",
        ] {
            if let Some(endpoints) = method_endpoints.get(method)
                && !endpoints.is_empty()
            {
                let anchor = clean_for_id(method);
                writeln!(writer, "- [{}](#{anchor})", method)?;
            }
        }
        writeln!(writer)?;
    }

    // Write each method section
    let mut schema_ctx = SchemaContext::configured(doc, config, false);
    prediscover_rendered_endpoints(
        &mut schema_ctx,
        config,
        [
            "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD", "TRACE",
        ]
        .iter()
        .filter_map(|method| method_endpoints.get(method))
        .flatten()
        .copied(),
    );
    for method in [
        "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD", "TRACE",
    ] {
        if let Some(endpoints) = method_endpoints.get(method)
            && !endpoints.is_empty()
        {
            let anchor = clean_for_id(method);
            writeln!(writer, "## {} {{#{}}}", method, anchor)?;

            // Sort endpoints as configured
            let mut sorted_endpoints = endpoints.clone();
            sort_endpoints(&mut sorted_endpoints, &config.sort_method);

            for endpoint in sorted_endpoints {
                let anchor = endpoint_anchor(None, endpoint);
                write_endpoint(writer, endpoint, config, Some(&anchor), &mut schema_ctx)?;
            }
        }
    }

    render_schema_definitions(writer, &mut schema_ctx)?;

    Ok(schema_ctx.take_omissions())
}

/// Generates documentation grouped by path (`--group-by path`), one `##`
/// section per path with its methods listed underneath. Paths appear in spec
/// order (first appearance), preserving the output-determinism invariant.
pub(super) fn generate_by_path<W: Write>(
    writer: &mut W,
    doc: &ApiDocumentation,
    config: &DocConfig,
) -> Result<Vec<String>> {
    write_preamble(writer, doc, config)?;

    // Group endpoints by path. IndexMap keeps first-appearance (spec) order.
    let mut path_endpoints: IndexMap<&str, Vec<&Endpoint>> = IndexMap::new();
    for endpoint in &doc.endpoints {
        if !passes_filters(endpoint, config) || !passes_service_filter(endpoint, config) {
            continue;
        }

        path_endpoints
            .entry(endpoint.path.as_str())
            .or_default()
            .push(endpoint);
    }

    // Table of Contents (if enabled)
    if config.include_toc {
        writeln!(writer, "## Paths\n")?;
        for (path, endpoints) in &path_endpoints {
            let anchor = clean_for_id(path);
            writeln!(writer, "- [{}](#{anchor})", path)?;

            let mut sorted_ops = endpoints.clone();
            sort_endpoints(&mut sorted_ops, &config.sort_method);
            for endpoint in sorted_ops {
                let op_title = get_short_title(endpoint);
                let op_anchor = endpoint_anchor(None, endpoint);
                writeln!(writer, "  * [{}](#{op_anchor})", op_title)?;
            }
        }
        writeln!(writer)?;
    }

    // Write each path section
    let mut schema_ctx = SchemaContext::configured(doc, config, false);
    prediscover_rendered_endpoints(
        &mut schema_ctx,
        config,
        path_endpoints.values().flatten().copied(),
    );
    for (path, endpoints) in &path_endpoints {
        let anchor = clean_for_id(path);
        writeln!(writer, "## {} {{#{}}}", path, anchor)?;

        let mut sorted_endpoints = endpoints.clone();
        sort_endpoints(&mut sorted_endpoints, &config.sort_method);
        for endpoint in sorted_endpoints {
            let anchor = endpoint_anchor(None, endpoint);
            write_endpoint(writer, endpoint, config, Some(&anchor), &mut schema_ctx)?;
        }
    }

    render_schema_definitions(writer, &mut schema_ctx)?;

    Ok(schema_ctx.take_omissions())
}

/// Generates a flat endpoint list (`--flat`) with no grouping hierarchy.
pub(super) fn generate_flat<W: Write>(
    writer: &mut W,
    doc: &ApiDocumentation,
    config: &DocConfig,
) -> Result<Vec<String>> {
    write_preamble(writer, doc, config)?;

    // Collect endpoints, applying the same filters as the grouped views
    let endpoints = visible_endpoints(doc, config);

    writeln!(writer, "## Endpoints\n")?;
    let mut schema_ctx = SchemaContext::configured(doc, config, false);
    prediscover_rendered_endpoints(&mut schema_ctx, config, endpoints.iter().copied());
    for endpoint in endpoints {
        let anchor = endpoint_anchor(None, endpoint);
        write_endpoint(writer, endpoint, config, Some(&anchor), &mut schema_ctx)?;
    }

    render_schema_definitions(writer, &mut schema_ctx)?;

    Ok(schema_ctx.take_omissions())
}