Struct HttpApi 

pub struct HttpApi {
    pub(crate) http: Http,
}

Forgejo’s HTTP implementation of Api.

Debug is derived, which stays safe because the transport’s token redacts itself.

Fields

http: Http

Implementations

impl HttpApi

pub(crate) async fn tag_commit( &self, repository: &RepoRef, tag: &str, ) -> Result<Option<String>, ForgeError>

The commit tag points at, with an annotated tag peeled.

pub(crate) async fn release_by_tag( &self, repository: &RepoRef, tag: &str, ) -> Result<Option<ReleaseWire>, ForgeError>

pub(crate) async fn create_draft_release( &self, repository: &RepoRef, tag: &str, target_commit: &str, title: &str, notes: &str, ) -> Result<u64, ForgeError>

pub(crate) async fn release_assets( &self, repository: &RepoRef, release_id: u64, ) -> Result<Vec<AssetWire>, ForgeError>

pub(crate) async fn upload_asset( &self, repository: &RepoRef, release_id: u64, filename: &str, bytes: Vec<u8>, ) -> Result<(), ForgeError>

pub(crate) async fn delete_asset( &self, repository: &RepoRef, release_id: u64, asset_id: u64, ) -> Result<(), ForgeError>

pub(crate) async fn publish_release( &self, repository: &RepoRef, release_id: u64, ) -> Result<(), ForgeError>

pub(crate) async fn open_pull_request( &self, repository: &RepoRef, head: &str, ) -> Result<Option<Pull>, ForgeError>

pub(crate) async fn ensure_pull_request( &self, repository: &RepoRef, head: &str, base: &str, title: &str, body: &str, ) -> Result<(), ForgeError>

impl HttpApi

pub fn new(forge_url: &Url, token: Token) -> Result<Self, TransportBuildError>

Build an adapter for the Forgejo instance at forge_url.

Errors

Fails when the HTTP stack cannot be built.

pub fn with_retry(self, retry: RetryPolicy) -> Self

Replace the retry policy, which keeps tests from sleeping.

async fn send_write( &self, method: Method, path: &str, body: Option<&str>, ) -> Result<(), ForgeError>

Send a write whose only Forgejo-specific status meaning is 423 (archived repository).

async fn paged<T: for<'a> Facet<'a>>( &self, path: &str, ) -> Result<Vec<T>, ForgeError>

Trait Implementations

impl AccessApi for HttpApi

async fn teams(&self, repo: &RepoRef) -> Result<Vec<Team>, ForgeError>

GET /repos/{owner}/{repo}/teams.

async fn current_user(&self) -> Result<String, ForgeError>

GET /user, the login of the authenticated user.

async fn user_teams(&self) -> Result<Vec<Team>, ForgeError>

GET /user/teams, every page.

async fn organization_teams( &self, organization: &str, ) -> Result<Vec<Team>, ForgeError>

GET /orgs/{org}/teams, every page.

async fn add_team( &self, repo: &RepoRef, team: &TeamName, _: Permission, ) -> Result<(), ForgeError>

PUT /repos/{owner}/{repo}/teams/{team}.

async fn remove_team( &self, repo: &RepoRef, team: &str, ) -> Result<(), ForgeError>

DELETE /repos/{owner}/{repo}/teams/{team}.

async fn collaborators( &self, repo: &RepoRef, ) -> Result<Vec<Collaborator>, ForgeError>

GET /repos/{owner}/{repo}/collaborators, every page, then GET /repos/{owner}/{repo}/collaborators/{collaborator}/permission for each user.

async fn add_collaborator( &self, repo: &RepoRef, user: &UserName, permission: Permission, ) -> Result<(), ForgeError>

PUT /repos/{owner}/{repo}/collaborators/{collaborator}.

async fn remove_collaborator( &self, repo: &RepoRef, user: &str, ) -> Result<(), ForgeError>

DELETE /repos/{owner}/{repo}/collaborators/{collaborator}.

impl ActionsVariablesApi for HttpApi

async fn actions_variables( &self, repo: &RepoRef, ) -> Result<Vec<ActionVariable>, ForgeError>

GET /repos/{owner}/{repo}/actions/variables, every page.

async fn create_actions_variable( &self, repo: &RepoRef, name: &str, body: &CreateVariableOption, ) -> Result<(), ForgeError>

POST /repos/{owner}/{repo}/actions/variables/{name}.

async fn update_actions_variable( &self, repo: &RepoRef, name: &str, body: &UpdateVariableOption, ) -> Result<(), ForgeError>

PUT /repos/{owner}/{repo}/actions/variables/{name}.

async fn delete_actions_variable( &self, repo: &RepoRef, name: &str, ) -> Result<(), ForgeError>

DELETE /repos/{owner}/{repo}/actions/variables/{name}.

impl BranchRulesApi for HttpApi

async fn branch_protections( &self, repo: &RepoRef, ) -> Result<Vec<BranchProtection>, ForgeError>

GET /repos/{owner}/{repo}/branch_protections.

async fn branch_protection( &self, repo: &RepoRef, rule: &str, ) -> Result<Option<BranchProtection>, ForgeError>

GET /repos/{owner}/{repo}/branch_protections/{rule}.

async fn create_branch_protection( &self, repo: &RepoRef, body: &CreateBranchProtectionOption, ) -> Result<(), ForgeError>

POST /repos/{owner}/{repo}/branch_protections.

async fn patch_branch_protection( &self, repo: &RepoRef, rule: &str, body: &EditBranchProtectionOption, ) -> Result<(), ForgeError>

PATCH /repos/{owner}/{repo}/branch_protections/{rule}.

async fn delete_branch_protection( &self, repo: &RepoRef, rule: &str, ) -> Result<(), ForgeError>

DELETE /repos/{owner}/{repo}/branch_protections/{rule}.

impl Clone for HttpApi

fn clone(&self) -> HttpApi

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HttpApi

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

Formats the value using the given formatter.

impl DeployKeysApi for HttpApi

async fn deploy_keys( &self, repo: &RepoRef, ) -> Result<Vec<DeployKey>, ForgeError>

GET /repos/{owner}/{repo}/keys, every page.

async fn create_deploy_key( &self, repo: &RepoRef, body: &CreateKeyOption, ) -> Result<(), ForgeError>

POST /repos/{owner}/{repo}/keys.

async fn delete_deploy_key( &self, repo: &RepoRef, id: i64, ) -> Result<(), ForgeError>

DELETE /repos/{owner}/{repo}/keys/{id}.

impl LabelsApi for HttpApi

async fn labels(&self, repo: &RepoRef) -> Result<Vec<Label>, ForgeError>

GET /repos/{owner}/{repo}/labels, every page.

async fn create_label( &self, repo: &RepoRef, body: &CreateLabelOption, ) -> Result<(), ForgeError>

POST /repos/{owner}/{repo}/labels.

async fn patch_label( &self, repo: &RepoRef, id: i64, body: &EditLabelOption, ) -> Result<(), ForgeError>

PATCH /repos/{owner}/{repo}/labels/{id}.

async fn delete_label(&self, repo: &RepoRef, id: i64) -> Result<(), ForgeError>

DELETE /repos/{owner}/{repo}/labels/{id}.

impl RepositoryApi for HttpApi

async fn repository(&self, repo: &RepoRef) -> Result<Repository, ForgeError>

GET /repos/{owner}/{repo}.

async fn patch_repository( &self, repo: &RepoRef, body: &EditRepoOption, ) -> Result<(), ForgeError>

PATCH /repos/{owner}/{repo}.

async fn topics(&self, repo: &RepoRef) -> Result<Vec<String>, ForgeError>

GET /repos/{owner}/{repo}/topics.

async fn replace_topics( &self, repo: &RepoRef, topics: &[String], ) -> Result<(), ForgeError>

PUT /repos/{owner}/{repo}/topics.

impl TagProtectionApi for HttpApi

async fn tag_protections( &self, repo: &RepoRef, ) -> Result<Vec<TagProtection>, ForgeError>

GET /repos/{owner}/{repo}/tag_protections.

async fn create_tag_protection( &self, repo: &RepoRef, body: &CreateTagProtectionOption, ) -> Result<(), ForgeError>

POST /repos/{owner}/{repo}/tag_protections.

async fn patch_tag_protection( &self, repo: &RepoRef, id: i64, body: &EditTagProtectionOption, ) -> Result<(), ForgeError>

PATCH /repos/{owner}/{repo}/tag_protections/{id}.

async fn delete_tag_protection( &self, repo: &RepoRef, id: i64, ) -> Result<(), ForgeError>

DELETE /repos/{owner}/{repo}/tag_protections/{id}.

impl WebhooksApi for HttpApi

async fn webhooks(&self, repo: &RepoRef) -> Result<Vec<Hook>, ForgeError>

GET /repos/{owner}/{repo}/hooks, every page.

async fn create_webhook( &self, repo: &RepoRef, body: &CreateHookOption, ) -> Result<(), ForgeError>

POST /repos/{owner}/{repo}/hooks.

async fn patch_webhook( &self, repo: &RepoRef, id: i64, body: &EditHookOption, ) -> Result<(), ForgeError>

PATCH /repos/{owner}/{repo}/hooks/{id}.

async fn delete_webhook( &self, repo: &RepoRef, id: i64, ) -> Result<(), ForgeError>

DELETE /repos/{owner}/{repo}/hooks/{id}.