Struct ProjectConfig 

pub struct ProjectConfig {
    pub error_schema_ref: String,
    pub unimplemented_methods: Vec<String>,
    pub public_methods: Vec<String>,
    pub deprecated_methods: Vec<String>,
    pub plain_text_endpoints: Vec<PlainTextEndpoint>,
    pub metrics_path: Option<String>,
    pub readiness_path: Option<String>,
    pub servers: Vec<ServerEntry>,
    pub info: InfoOverrides,
    pub write_only_fields: Vec<String>,
    pub read_only_fields: Vec<String>,
    pub transforms: TransformConfig,
}

Project-level OpenAPI generation config.

Loaded from a YAML file via ProjectConfig::load, then applied to a PatchConfig via PatchConfig::with_project_config.

Fields

error_schema_ref: String

$ref path for the REST error response schema.

unimplemented_methods: Vec<String>

Proto method short names for endpoints returning UNIMPLEMENTED.

public_methods: Vec<String>

Proto method short names for public (no-auth) endpoints.

deprecated_methods: Vec<String>

Proto method short names for deprecated endpoints.

plain_text_endpoints: Vec<PlainTextEndpoint>

Endpoints that should use text/plain instead of application/json.

metrics_path: Option<String>

Metrics endpoint path for response header enrichment (e.g., /metrics).

readiness_path: Option<String>

Readiness probe path for adding 503 response (e.g., /health/ready).

servers: Vec<ServerEntry>

Server entries for the servers block.

info: InfoOverrides

OpenAPI info block overrides (contact, license, external docs).

write_only_fields: Vec<String>

Additional field name patterns to mark as writeOnly.

read_only_fields: Vec<String>

Additional field name patterns to mark as readOnly.

transforms: TransformConfig

Transform toggles.

Implementations

impl ProjectConfig

pub fn load(path: &Path) -> Result<Self>

Load config from a YAML file.

Errors

Returns an error if the file cannot be read or parsed.

Trait Implementations

impl Debug for ProjectConfig

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

Formats the value using the given formatter.

impl Default for ProjectConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProjectConfig

where ProjectConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.