Skip to main content

Module models

Module models 

Source
Expand description

API model types.

This module contains all request and response types used by the SDK. Response types are deserialized from JSON automatically. Request types are serialized to JSON when passed to resource methods.

§Pagination

List responses (e.g., ListReposResponse) implement the Paginated trait, which is used by PageStream to automatically iterate through all pages.

Re-exports§

pub use pagination::Paginated;
pub use pagination::PaginationParams;

Modules§

pagination
Pagination types.

Structs§

ApiKey
An existing API key (without the secret).
ApiKeyCreated
Response returned when an API key is created (includes the secret).
Author
A commit author or committer.
Branch
A branch in a repository.
Commit
Full commit details.
CommitFile
A file change within a commit.
CommitSummary
Summary of a commit in a list response.
CreateApiKeyRequest
Request body for creating an API key.
CreateBranchRequest
Request body for creating a branch.
CreateCommitRequest
Request body for creating a commit.
CreateRepoRequest
Request body for creating a repository.
Diff
A diff between two refs.
DiffFile
A single file within a diff.
DiffStats
Summary statistics for a diff.
DirEntry
An entry within a directory listing.
ListApiKeysResponse
Response listing API keys.
ListBranchesResponse
Paginated list of branches.
ListCommitsResponse
Paginated list of commits.
ListReposResponse
Paginated list of repositories.
RenameRepoRequest
Request body for renaming a repository.
Repo
A repository.
SuccessResponse
A generic success response from the API.

Enums§

ApiKeyScope
A permission scope for an API key.
CommitFileAction
The action to perform on a file in a commit.
Content
Repository content — either a file or a directory.
DirEntryType
The type of a directory entry.