Skip to main content

Crate zixcel_github

Crate zixcel_github 

Source
Expand description

§zixcel-github

Typed GitHub API request planning, validation and receipt parsing with an injected execution backend. Use this library to keep repository observation and explicitly allowed changes behind a reviewable provider boundary.

§Install

[dependencies]
zixcel-github = "0.1.1"

This dependency uses crates.io; no private registry is required.

§Capabilities

  • Parse connector configuration and build capability-aware plans.
  • Validate supported API requests and target expectations.
  • Parse snapshot, text and workflow-input artifacts into typed results.

§Example

use zixcel_github::{CONNECTOR, PROVIDER};

assert_eq!(CONNECTOR, "zixcel-github");
assert_eq!(PROVIDER, "github");

§Features and requirements

Requires Rust 1.97 or newer. The crate is a reusable library, not a command-line application.

§Boundaries

The caller supplies authentication and the transport backend. Creation, deletion and other changes require explicit target permissions. This crate does not store tokens or choose application policy.

§Development

cargo fmt --all -- --check
cargo test --locked --all-features
cargo clippy --locked --all-targets --all-features -- -D warnings

§Documentation and license

API documentation · Source · Usage guide

Apache-2.0. Retain the package LICENSE and NOTICE; see the source repository for security reporting and contribution guidelines. Policy-neutral typed GitHub API wrapper boundary.

Structs§

CapabilityReport
ConnectorConfig
ConnectorError
ConnectorPlan
DoctorReport
GitHubApiReceipt
GitHubApiRequest
GitHubBackendReceipt
GitHubSnapshotArtifact
GitHubSnapshotFile
GitHubTextArtifact
GitHubWorkflowInputsArtifact
PermissionRequirement
PlanStep
RequestValidationReport
ValidationReport

Enums§

GitHubAction
GitHubRemoteExpectation

Constants§

API_RECEIPT_SCHEMA
API_REQUEST_SCHEMA
CONFIG_SCHEMA
CONNECTOR
PLAN_SCHEMA
PROVIDER

Traits§

GitHubBackend

Functions§

build_plan
capabilities
doctor
execute_api_request
execute_configured_request
Execute only after the explicit local connection/target/action ceiling passes.
parse_api_request_json
parse_config
parse_snapshot_artifact
Parses a complete immutable source snapshot for the Git Data API.
parse_text_artifact
Parses one bounded UTF-8 text artifact.
parse_workflow_inputs_artifact
Parses one bounded workflow-input map.
validate_api_request
validation_report