Struct PatchConfig 

pub struct PatchConfig<'a> { /* private fields */ }

Configuration for the OpenAPI patch pipeline.

Controls which transforms run and their parameters. Construct with PatchConfig::new and configure via with_project_config (file-based) or individual builder methods (programmatic).

Example

let config = PatchConfig::new(&metadata)
    .unimplemented_methods(&["SetupMfa", "DisableMfa"])
    .public_methods(&["Login", "SignUp"])
    .error_schema_ref("#/components/schemas/ErrorResponse");

Implementations

impl<'a> PatchConfig<'a>

pub fn new(metadata: &'a ProtoMetadata) -> Self

Create a new config with all transforms enabled and default settings.

pub fn with_project_config(self, project: &ProjectConfig) -> Self

Apply settings from a ProjectConfig.

Copies method lists, error schema ref, transform toggles, and endpoint settings from the config into this builder. Builder methods called after this will override config values.

Example

let project = ProjectConfig::load(Path::new("config.yaml"))?;
let config = PatchConfig::new(&metadata).with_project_config(&project);

pub fn unimplemented_methods(self, methods: &[&str]) -> Self

Set proto method names of endpoints that return UNIMPLEMENTED.

Method names are resolved to gnostic operation IDs at patch() time. Invalid names will produce an error when patch() is called.

pub fn public_methods(self, methods: &[&str]) -> Self

Set proto method names of endpoints that do not require authentication.

Method names are resolved to gnostic operation IDs at patch() time. Invalid names will produce an error when patch() is called.

pub fn error_schema_ref(self, ref_path: &str) -> Self

Set the $ref path for the REST error response schema.

pub fn upgrade_to_3_1(self, enabled: bool) -> Self

Enable or disable the 3.0 → 3.1 upgrade transform.

pub fn annotate_sse(self, enabled: bool) -> Self

Enable or disable SSE streaming annotation.

pub fn inject_validation(self, enabled: bool) -> Self

Enable or disable validation constraint injection.

pub fn add_security(self, enabled: bool) -> Self

Enable or disable security scheme addition.

pub fn inline_request_bodies(self, enabled: bool) -> Self

Enable or disable request body inlining.

pub fn flatten_uuid_refs(self, enabled: bool) -> Self

Enable or disable UUID wrapper flattening.

pub fn normalize_line_endings(self, enabled: bool) -> Self

Enable or disable CRLF → LF normalization.

pub fn skip_upgrade(self) -> Self

Skip the 3.0 → 3.1 upgrade transform.

pub fn skip_sse(self) -> Self

Skip SSE streaming annotation.

pub fn skip_validation(self) -> Self

Skip validation constraint injection.

pub fn skip_security(self) -> Self

Skip security scheme addition.

pub fn skip_inline_request_bodies(self) -> Self

Skip request body inlining.

pub fn skip_uuid_flattening(self) -> Self

Skip UUID wrapper flattening.

pub fn skip_line_ending_normalization(self) -> Self

Skip CRLF → LF normalization.

pub fn bearer_description(self, description: &str) -> Self

Set a custom description for the Bearer auth scheme.

When None, defaults to "Bearer authentication token".

pub fn plain_text_endpoints(self, endpoints: &[PlainTextEndpoint]) -> Self

Set endpoints that should use text/plain content type.

pub fn metrics_path(self, path: &str) -> Self

Set the metrics endpoint path for response header enrichment.

pub fn readiness_path(self, path: &str) -> Self

Set the readiness probe path for 503 response addition.

Trait Implementations

impl<'a> Debug for PatchConfig<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.