flutter/apidash
1
0
Fork 0
mirror of https://github.com/foss42/apidash.git synced 2025-12-01 18:28:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: add detailed documentation on unsupported cURL flags in CurlImportService

Browse Source
This commit is contained in:
Udhay-Adithya
2025-09-24 20:06:32 +05:30
parent 2b10325bb8
commit cf69d4e352
1 changed files with 30 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
lib/dashbot/core/services/curl_import_service.dart
View File

@@ -1,6 +1,36 @@
import 'dart:convert';
import 'package:curl_parser/curl_parser.dart';
/// NOTE: Unsupported cURL flags and rationale for current models
///
/// The `Curl` parser recognizes several flags that are not represented in
/// our `HttpRequestModel` / `RequestModel`. Those models intentionally focus on
/// the request description (method, URL, headers, params, body, form-data),
/// not transport/runtime behavior or output concerns. As a result, these flags
/// are currently ignored by `CurlImportService` and cannot be applied to the
/// request model:
///
/// - `-k`, `--insecure`: TLS validation behavior (transport concern). No field
/// exists to control certificate verification in `HttpRequestModel`.
/// - `-L`, `--location`: redirect-following behavior (transport concern). Not
/// a property of a single request; our model describes one request only.
/// - `--compressed`: response compression negotiation/output. While this often
/// implies adding `Accept-Encoding`, the parser does not expose this flag on
/// `Curl`; and we avoid mutating headers implicitly without a model field.
/// - `-i`, `--include`: include response headers in output (output concern).
/// - `-o`, `--output`: write response body to a file (output concern).
/// - `-s`, `--silent`: suppress CLI progress/errors (CLI UX concern).
/// - `-v`, `--verbose`: verbose logging (CLI UX concern).
/// - `--connect-timeout`: connection timeout (transport concern). No timeout
/// fields exist on `HttpRequestModel`.
/// - `--retry`: retry policy (transport concern). No retry fields exist on
/// `HttpRequestModel`.
/// - `-c`, `--cookie-jar`: persist response cookies to a file (output/state
/// concern). Not part of request description.
/// - `--globoff`: parsing behavior for the curl CLI; irrelevant post-parse.
/// Service to parse cURL commands and produce
/// a standard action message map understood by Dashbot.
class CurlImportService {