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).
- ApiKey
Created - 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.
- Commit
File - A file change within a commit (legacy struct-based approach).
- Commit
LfsFile - A file change that references LFS content.
- Commit
Summary - Summary of a commit in a list response.
- Create
ApiKey Request - Request body for creating an API key.
- Create
Branch Request - Request body for creating a branch.
- Create
Commit Request - Request body for creating a commit.
- Create
Commit With LfsRequest - Request body for creating a commit with flexible file types.
- Create
Repo Request - Request body for creating a repository.
- Diff
- A diff between two refs.
- Diff
File - A single file within a diff.
- Diff
Stats - Summary statistics for a diff.
- DirEntry
- An entry within a directory listing.
- LfsFile
Ref - An LFS file reference for creating commits.
- LfsObject
Error - Error details for a single LFS object.
- LfsObject
Spec - Specification for an LFS object.
- LfsObject
Status - Status of a single LFS object upload request.
- List
ApiKeys Response - Response listing API keys.
- List
Branches Response - Paginated list of branches.
- List
Commits Response - Paginated list of commits.
- List
Repos Response - Paginated list of repositories.
- Rename
Repo Request - Request body for renaming a repository.
- Repo
- A repository.
- Success
Response - A generic success response from the API.
- Upload
LfsObjects Request - Request to upload LFS objects.
- Upload
LfsObjects Response - Response from LFS upload request.
Enums§
- ApiKey
Scope - A permission scope for an API key.
- Commit
File Action - The action to perform on a file in a commit.
- Commit
File Change - A file change that can be content, delete, or LFS reference.
- Content
- Repository content — either a file or a directory.
- DirEntry
Type - The type of a directory entry.