gitea_openapi 0.1.1

  • Readme
  • Changelog
  • Installing
  • new37

openapi #

This documentation describes the Gitea API.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 1.1.1
  • Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements #

Dart 2.0 or later

Installation & Usage #

Github #

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local #

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    path: /path/to/openapi

Tests #

TODO

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:gitea_openapi/api.dart';

// TODO Configure API key authorization: AccessToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('AccessToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('AccessToken').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: AuthorizationHeaderToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('AuthorizationHeaderToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('AuthorizationHeaderToken').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: BasicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: SudoHeader
//defaultApiClient.getAuthentication<ApiKeyAuth>('SudoHeader').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('SudoHeader').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: SudoParam
//defaultApiClient.getAuthentication<ApiKeyAuth>('SudoParam').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('SudoParam').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: Token
//defaultApiClient.getAuthentication<ApiKeyAuth>('Token').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Token').apiKeyPrefix = 'Bearer';

var api_instance = AdminApi();
var username = username_example; // String | username of the user that will own the created organization
var organization = CreateOrgOption(); // CreateOrgOption | 

try {
    var result = api_instance.adminCreateOrg(username, organization);
    print(result);
} catch (e) {
    print("Exception when calling AdminApi->adminCreateOrg: $e\n");
}

Documentation for API Endpoints #

All URIs are relative to http://localhost/api/v1

ClassMethodHTTP requestDescription
AdminApiadminCreateOrgPOST /admin/users/{username}/orgsCreate an organization
AdminApiadminCreatePublicKeyPOST /admin/users/{username}/keysAdd a public key on behalf of a user
AdminApiadminCreateRepoPOST /admin/users/{username}/reposCreate a repository on behalf of a user
AdminApiadminCreateUserPOST /admin/usersCreate a user
AdminApiadminDeleteUserDELETE /admin/users/{username}Delete a user
AdminApiadminDeleteUserPublicKeyDELETE /admin/users/{username}/keys/{id}Delete a user's public key
AdminApiadminEditUserPATCH /admin/users/{username}Edit an existing user
AdminApiadminGetAllOrgsGET /admin/orgsList all organizations
AdminApiadminGetAllUsersGET /admin/usersList all users
IssueApiissueAddLabelPOST /repos/{owner}/{repo}/issues/{index}/labelsAdd a label to an issue
IssueApiissueAddSubscriptionPUT /repos/{owner}/{repo}/issues/{index}/subscriptions/{user}Subscribe user to issue
IssueApiissueAddTimePOST /repos/{owner}/{repo}/issues/{index}/timesAdd tracked time to a issue
IssueApiissueClearLabelsDELETE /repos/{owner}/{repo}/issues/{index}/labelsRemove all labels from an issue
IssueApiissueCreateCommentPOST /repos/{owner}/{repo}/issues/{index}/commentsAdd a comment to an issue
IssueApiissueCreateIssuePOST /repos/{owner}/{repo}/issuesCreate an issue. If using deadline only the date will be taken into account, and time of day ignored.
IssueApiissueCreateLabelPOST /repos/{owner}/{repo}/labelsCreate a label
IssueApiissueCreateMilestonePOST /repos/{owner}/{repo}/milestonesCreate a milestone
IssueApiissueDeleteCommentDELETE /repos/{owner}/{repo}/issues/comments/{id}Delete a comment
IssueApiissueDeleteCommentDeprecatedDELETE /repos/{owner}/{repo}/issues/{index}/comments/{id}Delete a comment
IssueApiissueDeleteCommentReactionDELETE /repos/{owner}/{repo}/issues/comments/{id}/reactionsRemove a reaction from a comment of an issue
IssueApiissueDeleteIssueReactionDELETE /repos/{owner}/{repo}/issues/{index}/reactionsRemove a reaction from an issue
IssueApiissueDeleteLabelDELETE /repos/{owner}/{repo}/labels/{id}Delete a label
IssueApiissueDeleteMilestoneDELETE /repos/{owner}/{repo}/milestones/{id}Delete a milestone
IssueApiissueDeleteStopWatchDELETE /repos/{owner}/{repo}/issues/{index}/stopwatch/deleteDelete an issue's existing stopwatch.
IssueApiissueDeleteSubscriptionDELETE /repos/{owner}/{repo}/issues/{index}/subscriptions/{user}Unsubscribe user from issue
IssueApiissueDeleteTimeDELETE /repos/{owner}/{repo}/issues/{index}/times/{id}Delete specific tracked time
IssueApiissueEditCommentPATCH /repos/{owner}/{repo}/issues/comments/{id}Edit a comment
IssueApiissueEditCommentDeprecatedPATCH /repos/{owner}/{repo}/issues/{index}/comments/{id}Edit a comment
IssueApiissueEditIssuePATCH /repos/{owner}/{repo}/issues/{index}Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.
IssueApiissueEditIssueDeadlinePOST /repos/{owner}/{repo}/issues/{index}/deadlineSet an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.
IssueApiissueEditLabelPATCH /repos/{owner}/{repo}/labels/{id}Update a label
IssueApiissueEditMilestonePATCH /repos/{owner}/{repo}/milestones/{id}Update a milestone
IssueApiissueGetCommentGET /repos/{owner}/{repo}/issues/comments/{id}Get a comment
IssueApiissueGetCommentReactionsGET /repos/{owner}/{repo}/issues/comments/{id}/reactionsGet a list of reactions from a comment of an issue
IssueApiissueGetCommentsGET /repos/{owner}/{repo}/issues/{index}/commentsList all comments on an issue
IssueApiissueGetIssueGET /repos/{owner}/{repo}/issues/{index}Get an issue
IssueApiissueGetIssueReactionsGET /repos/{owner}/{repo}/issues/{index}/reactionsGet a list reactions of an issue
IssueApiissueGetLabelGET /repos/{owner}/{repo}/labels/{id}Get a single label
IssueApiissueGetLabelsGET /repos/{owner}/{repo}/issues/{index}/labelsGet an issue's labels
IssueApiissueGetMilestoneGET /repos/{owner}/{repo}/milestones/{id}Get a milestone
IssueApiissueGetMilestonesListGET /repos/{owner}/{repo}/milestonesGet all of a repository's opened milestones
IssueApiissueGetRepoCommentsGET /repos/{owner}/{repo}/issues/commentsList all comments in a repository
IssueApiissueListIssuesGET /repos/{owner}/{repo}/issuesList a repository's issues
IssueApiissueListLabelsGET /repos/{owner}/{repo}/labelsGet all of a repository's labels
IssueApiissuePostCommentReactionPOST /repos/{owner}/{repo}/issues/comments/{id}/reactionsAdd a reaction to a comment of an issue
IssueApiissuePostIssueReactionPOST /repos/{owner}/{repo}/issues/{index}/reactionsAdd a reaction to an issue
IssueApiissueRemoveLabelDELETE /repos/{owner}/{repo}/issues/{index}/labels/{id}Remove a label from an issue
IssueApiissueReplaceLabelsPUT /repos/{owner}/{repo}/issues/{index}/labelsReplace an issue's labels
IssueApiissueResetTimeDELETE /repos/{owner}/{repo}/issues/{index}/timesReset a tracked time of an issue
IssueApiissueSearchIssuesGET /repos/issues/searchSearch for issues across the repositories that the user has access to
IssueApiissueStartStopWatchPOST /repos/{owner}/{repo}/issues/{index}/stopwatch/startStart stopwatch on an issue.
IssueApiissueStopStopWatchPOST /repos/{owner}/{repo}/issues/{index}/stopwatch/stopStop an issue's existing stopwatch.
IssueApiissueSubscriptionsGET /repos/{owner}/{repo}/issues/{index}/subscriptionsGet users who subscribed on an issue.
IssueApiissueTrackedTimesGET /repos/{owner}/{repo}/issues/{index}/timesList an issue's tracked times
MiscellaneousApigetSigningKeyGET /signing-key.gpgGet default signing-key.gpg
MiscellaneousApigetVersionGET /versionReturns the version of the Gitea application
MiscellaneousApirenderMarkdownPOST /markdownRender a markdown document as HTML
MiscellaneousApirenderMarkdownRawPOST /markdown/rawRender raw markdown as HTML
NotificationApinotifyGetListGET /notificationsList users's notification threads
NotificationApinotifyGetRepoListGET /repos/{owner}/{repo}/notificationsList users's notification threads on a specific repo
NotificationApinotifyGetThreadGET /notifications/threads/{id}Get notification thread by ID
NotificationApinotifyNewAvailableGET /notifications/newCheck if unread notifications exist
NotificationApinotifyReadListPUT /notificationsMark notification threads as read
NotificationApinotifyReadRepoListPUT /repos/{owner}/{repo}/notificationsMark notification threads as read on a specific repo
NotificationApinotifyReadThreadPATCH /notifications/threads/{id}Mark notification thread as read by ID
OrganizationApicreateOrgRepoPOST /orgs/{org}/reposCreate a repository in an organization
OrganizationApicreateOrgRepoDeprecatedPOST /org/{org}/reposCreate a repository in an organization
OrganizationApiorgAddTeamMemberPUT /teams/{id}/members/{username}Add a team member
OrganizationApiorgAddTeamRepositoryPUT /teams/{id}/repos/{org}/{repo}Add a repository to a team
OrganizationApiorgConcealMemberDELETE /orgs/{org}/public_members/{username}Conceal a user's membership
OrganizationApiorgCreatePOST /orgsCreate an organization
OrganizationApiorgCreateHookPOST /orgs/{org}/hooks/Create a hook
OrganizationApiorgCreateTeamPOST /orgs/{org}/teamsCreate a team
OrganizationApiorgDeleteDELETE /orgs/{org}Delete an organization
OrganizationApiorgDeleteHookDELETE /orgs/{org}/hooks/{id}Delete a hook
OrganizationApiorgDeleteMemberDELETE /orgs/{org}/members/{username}Remove a member from an organization
OrganizationApiorgDeleteTeamDELETE /teams/{id}Delete a team
OrganizationApiorgEditPATCH /orgs/{org}Edit an organization
OrganizationApiorgEditHookPATCH /orgs/{org}/hooks/{id}Update a hook
OrganizationApiorgEditTeamPATCH /teams/{id}Edit a team
OrganizationApiorgGetGET /orgs/{org}Get an organization
OrganizationApiorgGetAllGET /orgsGet list of organizations
OrganizationApiorgGetHookGET /orgs/{org}/hooks/{id}Get a hook
OrganizationApiorgGetTeamGET /teams/{id}Get a team
OrganizationApiorgIsMemberGET /orgs/{org}/members/{username}Check if a user is a member of an organization
OrganizationApiorgIsPublicMemberGET /orgs/{org}/public_members/{username}Check if a user is a public member of an organization
OrganizationApiorgListCurrentUserOrgsGET /user/orgsList the current user's organizations
OrganizationApiorgListHooksGET /orgs/{org}/hooksList an organization's webhooks
OrganizationApiorgListMembersGET /orgs/{org}/membersList an organization's members
OrganizationApiorgListPublicMembersGET /orgs/{org}/public_membersList an organization's public members
OrganizationApiorgListReposGET /orgs/{org}/reposList an organization's repos
OrganizationApiorgListTeamMemberGET /teams/{id}/members/{username}List a particular member of team
OrganizationApiorgListTeamMembersGET /teams/{id}/membersList a team's members
OrganizationApiorgListTeamReposGET /teams/{id}/reposList a team's repos
OrganizationApiorgListTeamsGET /orgs/{org}/teamsList an organization's teams
OrganizationApiorgListUserOrgsGET /users/{username}/orgsList a user's organizations
OrganizationApiorgPublicizeMemberPUT /orgs/{org}/public_members/{username}Publicize a user's membership
OrganizationApiorgRemoveTeamMemberDELETE /teams/{id}/members/{username}Remove a team member
OrganizationApiorgRemoveTeamRepositoryDELETE /teams/{id}/repos/{org}/{repo}Remove a repository from a team
OrganizationApiteamSearchGET /orgs/{org}/teams/searchSearch for teams within an organization
RepositoryApicreateCurrentUserRepoPOST /user/reposCreate a repository
RepositoryApicreateForkPOST /repos/{owner}/{repo}/forksFork a repository
RepositoryApigetBlobGET /repos/{owner}/{repo}/git/blobs/{sha}Gets the blob of a repository.
RepositoryApigetTagGET /repos/{owner}/{repo}/git/tags/{sha}Gets the tag object of an annotated tag (not lightweight tags)
RepositoryApigetTreeGET /repos/{owner}/{repo}/git/trees/{sha}Gets the tree of a repository.
RepositoryApilistForksGET /repos/{owner}/{repo}/forksList a repository's forks
RepositoryApirepoAddCollaboratorPUT /repos/{owner}/{repo}/collaborators/{collaborator}Add a collaborator to a repository
RepositoryApirepoAddTopĆ­cPUT /repos/{owner}/{repo}/topics/{topic}Add a topic to a repository
RepositoryApirepoCheckCollaboratorGET /repos/{owner}/{repo}/collaborators/{collaborator}Check if a user is a collaborator of a repository
RepositoryApirepoCreateBranchProtectionPOST /repos/{owner}/{repo}/branch_protectionsCreate a branch protections for a repository
RepositoryApirepoCreateFilePOST /repos/{owner}/{repo}/contents/{filepath}Create a file in a repository
RepositoryApirepoCreateHookPOST /repos/{owner}/{repo}/hooksCreate a hook
RepositoryApirepoCreateKeyPOST /repos/{owner}/{repo}/keysAdd a key to a repository
RepositoryApirepoCreatePullRequestPOST /repos/{owner}/{repo}/pullsCreate a pull request
RepositoryApirepoCreateReleasePOST /repos/{owner}/{repo}/releasesCreate a release
RepositoryApirepoCreateReleaseAttachmentPOST /repos/{owner}/{repo}/releases/{id}/assetsCreate a release attachment
RepositoryApirepoCreateStatusPOST /repos/{owner}/{repo}/statuses/{sha}Create a commit status
RepositoryApirepoDeleteDELETE /repos/{owner}/{repo}Delete a repository
RepositoryApirepoDeleteBranchProtectionDELETE /repos/{owner}/{repo}/branch_protections/{name}Delete a specific branch protection for the repository
RepositoryApirepoDeleteCollaboratorDELETE /repos/{owner}/{repo}/collaborators/{collaborator}Delete a collaborator from a repository
RepositoryApirepoDeleteFileDELETE /repos/{owner}/{repo}/contents/{filepath}Delete a file in a repository
RepositoryApirepoDeleteGitHookDELETE /repos/{owner}/{repo}/hooks/git/{id}Delete a Git hook in a repository
RepositoryApirepoDeleteHookDELETE /repos/{owner}/{repo}/hooks/{id}Delete a hook in a repository
RepositoryApirepoDeleteKeyDELETE /repos/{owner}/{repo}/keys/{id}Delete a key from a repository
RepositoryApirepoDeleteReleaseDELETE /repos/{owner}/{repo}/releases/{id}Delete a release
RepositoryApirepoDeleteReleaseAttachmentDELETE /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}Delete a release attachment
RepositoryApirepoDeleteTopicDELETE /repos/{owner}/{repo}/topics/{topic}Delete a topic from a repository
RepositoryApirepoEditPATCH /repos/{owner}/{repo}Edit a repository's properties. Only fields that are set will be changed.
RepositoryApirepoEditBranchProtectionPATCH /repos/{owner}/{repo}/branch_protections/{name}Edit a branch protections for a repository. Only fields that are set will be changed
RepositoryApirepoEditGitHookPATCH /repos/{owner}/{repo}/hooks/git/{id}Edit a Git hook in a repository
RepositoryApirepoEditHookPATCH /repos/{owner}/{repo}/hooks/{id}Edit a hook in a repository
RepositoryApirepoEditPullRequestPATCH /repos/{owner}/{repo}/pulls/{index}Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.
RepositoryApirepoEditReleasePATCH /repos/{owner}/{repo}/releases/{id}Update a release
RepositoryApirepoEditReleaseAttachmentPATCH /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}Edit a release attachment
RepositoryApirepoGetGET /repos/{owner}/{repo}Get a repository
RepositoryApirepoGetAllCommitsGET /repos/{owner}/{repo}/commitsGet a list of all commits from a repository
RepositoryApirepoGetArchiveGET /repos/{owner}/{repo}/archive/{archive}Get an archive of a repository
RepositoryApirepoGetBranchGET /repos/{owner}/{repo}/branches/{branch}Retrieve a specific branch from a repository, including its effective branch protection
RepositoryApirepoGetBranchProtectionGET /repos/{owner}/{repo}/branch_protections/{name}Get a specific branch protection for the repository
RepositoryApirepoGetByIDGET /repositories/{id}Get a repository by id
RepositoryApirepoGetCombinedStatusByRefGET /repos/{owner}/{repo}/commits/{ref}/statusesGet a commit's combined status, by branch/tag/commit reference
RepositoryApirepoGetContentsGET /repos/{owner}/{repo}/contents/{filepath}Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir
RepositoryApirepoGetContentsListGET /repos/{owner}/{repo}/contentsGets the metadata of all the entries of the root dir
RepositoryApirepoGetEditorConfigGET /repos/{owner}/{repo}/editorconfig/{filepath}Get the EditorConfig definitions of a file in a repository
RepositoryApirepoGetGitHookGET /repos/{owner}/{repo}/hooks/git/{id}Get a Git hook
RepositoryApirepoGetHookGET /repos/{owner}/{repo}/hooks/{id}Get a hook
RepositoryApirepoGetKeyGET /repos/{owner}/{repo}/keys/{id}Get a repository's key by id
RepositoryApirepoGetPullRequestGET /repos/{owner}/{repo}/pulls/{index}Get a pull request
RepositoryApirepoGetRawFileGET /repos/{owner}/{repo}/raw/{filepath}Get a file from a repository
RepositoryApirepoGetReleaseGET /repos/{owner}/{repo}/releases/{id}Get a release
RepositoryApirepoGetReleaseAttachmentGET /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}Get a release attachment
RepositoryApirepoGetSingleCommitGET /repos/{owner}/{repo}/git/commits/{sha}Get a single commit from a repository
RepositoryApirepoListAllGitRefsGET /repos/{owner}/{repo}/git/refsGet specified ref or filtered repository's refs
RepositoryApirepoListBranchProtectionGET /repos/{owner}/{repo}/branch_protectionsList branch protections for a repository
RepositoryApirepoListBranchesGET /repos/{owner}/{repo}/branchesList a repository's branches
RepositoryApirepoListCollaboratorsGET /repos/{owner}/{repo}/collaboratorsList a repository's collaborators
RepositoryApirepoListGitHooksGET /repos/{owner}/{repo}/hooks/gitList the Git hooks in a repository
RepositoryApirepoListGitRefsGET /repos/{owner}/{repo}/git/refs/{ref}Get specified ref or filtered repository's refs
RepositoryApirepoListHooksGET /repos/{owner}/{repo}/hooksList the hooks in a repository
RepositoryApirepoListKeysGET /repos/{owner}/{repo}/keysList a repository's keys
RepositoryApirepoListPullRequestsGET /repos/{owner}/{repo}/pullsList a repo's pull requests
RepositoryApirepoListReleaseAttachmentsGET /repos/{owner}/{repo}/releases/{id}/assetsList release's attachments
RepositoryApirepoListReleasesGET /repos/{owner}/{repo}/releasesList a repo's releases
RepositoryApirepoListStargazersGET /repos/{owner}/{repo}/stargazersList a repo's stargazers
RepositoryApirepoListStatusesGET /repos/{owner}/{repo}/statuses/{sha}Get a commit's statuses
RepositoryApirepoListSubscribersGET /repos/{owner}/{repo}/subscribersList a repo's watchers
RepositoryApirepoListTagsGET /repos/{owner}/{repo}/tagsList a repository's tags
RepositoryApirepoListTopicsGET /repos/{owner}/{repo}/topicsGet list of topics that a repository has
RepositoryApirepoMergePullRequestPOST /repos/{owner}/{repo}/pulls/{index}/mergeMerge a pull request
RepositoryApirepoMigratePOST /repos/migrateMigrate a remote git repository
RepositoryApirepoMirrorSyncPOST /repos/{owner}/{repo}/mirror-syncSync a mirrored repository
RepositoryApirepoPullRequestIsMergedGET /repos/{owner}/{repo}/pulls/{index}/mergeCheck if a pull request has been merged
RepositoryApirepoSearchGET /repos/searchSearch for repositories
RepositoryApirepoSigningKeyGET /repos/{owner}/{repo}/signing-key.gpgGet signing-key.gpg for given repository
RepositoryApirepoTestHookPOST /repos/{owner}/{repo}/hooks/{id}/testsTest a push webhook
RepositoryApirepoTrackedTimesGET /repos/{owner}/{repo}/timesList a repo's tracked times
RepositoryApirepoTransferPOST /repos/{owner}/{repo}/transferTransfer a repo ownership
RepositoryApirepoUpdateFilePUT /repos/{owner}/{repo}/contents/{filepath}Update a file in a repository
RepositoryApirepoUpdateTopicsPUT /repos/{owner}/{repo}/topicsReplace list of topics for a repository
RepositoryApitopicSearchGET /topics/searchsearch topics via keyword
RepositoryApiuserCurrentCheckSubscriptionGET /repos/{owner}/{repo}/subscriptionCheck if the current user is watching a repo
RepositoryApiuserCurrentDeleteSubscriptionDELETE /repos/{owner}/{repo}/subscriptionUnwatch a repo
RepositoryApiuserCurrentPutSubscriptionPUT /repos/{owner}/{repo}/subscriptionWatch a repo
RepositoryApiuserTrackedTimesGET /repos/{owner}/{repo}/times/{user}List a user's tracked times in a repo
UserApicreateCurrentUserRepoPOST /user/reposCreate a repository
UserApiuserAddEmailPOST /user/emailsAdd email addresses
UserApiuserCheckFollowingGET /users/{follower}/following/{followee}Check if one user is following another user
UserApiuserCreateTokenPOST /users/{username}/tokensCreate an access token
UserApiuserCurrentCheckFollowingGET /user/following/{username}Check whether a user is followed by the authenticated user
UserApiuserCurrentCheckStarringGET /user/starred/{owner}/{repo}Whether the authenticated is starring the repo
UserApiuserCurrentDeleteFollowDELETE /user/following/{username}Unfollow a user
UserApiuserCurrentDeleteGPGKeyDELETE /user/gpg_keys/{id}Remove a GPG key
UserApiuserCurrentDeleteKeyDELETE /user/keys/{id}Delete a public key
UserApiuserCurrentDeleteStarDELETE /user/starred/{owner}/{repo}Unstar the given repo
UserApiuserCurrentGetGPGKeyGET /user/gpg_keys/{id}Get a GPG key
UserApiuserCurrentGetKeyGET /user/keys/{id}Get a public key
UserApiuserCurrentListFollowersGET /user/followersList the authenticated user's followers
UserApiuserCurrentListFollowingGET /user/followingList the users that the authenticated user is following
UserApiuserCurrentListGPGKeysGET /user/gpg_keysList the authenticated user's GPG keys
UserApiuserCurrentListKeysGET /user/keysList the authenticated user's public keys
UserApiuserCurrentListReposGET /user/reposList the repos that the authenticated user owns or has access to
UserApiuserCurrentListStarredGET /user/starredThe repos that the authenticated user has starred
UserApiuserCurrentListSubscriptionsGET /user/subscriptionsList repositories watched by the authenticated user
UserApiuserCurrentPostGPGKeyPOST /user/gpg_keysCreate a GPG key
UserApiuserCurrentPostKeyPOST /user/keysCreate a public key
UserApiuserCurrentPutFollowPUT /user/following/{username}Follow a user
UserApiuserCurrentPutStarPUT /user/starred/{owner}/{repo}Star the given repo
UserApiuserCurrentTrackedTimesGET /user/timesList the current user's tracked times
UserApiuserDeleteAccessTokenDELETE /users/{username}/tokens/{token}delete an access token
UserApiuserDeleteEmailDELETE /user/emailsDelete email addresses
UserApiuserGetGET /users/{username}Get a user
UserApiuserGetCurrentGET /userGet the authenticated user
UserApiuserGetHeatmapDataGET /users/{username}/heatmapGet a user's heatmap
UserApiuserGetStopWatchesGET /user/stopwatchesGet list of all existing stopwatches
UserApiuserGetTokensGET /users/{username}/tokensList the authenticated user's access tokens
UserApiuserListEmailsGET /user/emailsList the authenticated user's email addresses
UserApiuserListFollowersGET /users/{username}/followersList the given user's followers
UserApiuserListFollowingGET /users/{username}/followingList the users that the given user is following
UserApiuserListGPGKeysGET /users/{username}/gpg_keysList the given user's GPG keys
UserApiuserListKeysGET /users/{username}/keysList the given user's public keys
UserApiuserListReposGET /users/{username}/reposList the repos owned by the given user
UserApiuserListStarredGET /users/{username}/starredThe repos that the given user has starred
UserApiuserListSubscriptionsGET /users/{username}/subscriptionsList the repositories watched by a user
UserApiuserListTeamsGET /user/teamsList all the teams a user belongs to
UserApiuserSearchGET /users/searchSearch for users

Documentation For Models #

Documentation For Authorization #

AccessToken #

  • Type: API key
  • API key parameter name: access_token
  • Location: URL query string

AuthorizationHeaderToken #

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

BasicAuth #

  • Type: HTTP basic authentication

SudoHeader #

  • Type: API key
  • API key parameter name: Sudo
  • Location: HTTP header

SudoParam #

  • Type: API key
  • API key parameter name: sudo
  • Location: URL query string

Token #

  • Type: API key
  • API key parameter name: token
  • Location: URL query string

Author #

0.1.1 #

  • Use dartfmt
  • Don't explicitly initialize variables to null
  • DO use curly braces for all flow control structures

0.1.0 #

  • Initial version

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  gitea_openapi: ^0.1.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:gitea_openapi/api.dart';
import 'package:gitea_openapi/api/admin_api.dart';
import 'package:gitea_openapi/api/issue_api.dart';
import 'package:gitea_openapi/api/miscellaneous_api.dart';
import 'package:gitea_openapi/api/notification_api.dart';
import 'package:gitea_openapi/api/organization_api.dart';
import 'package:gitea_openapi/api/repository_api.dart';
import 'package:gitea_openapi/api/user_api.dart';
import 'package:gitea_openapi/api_client.dart';
import 'package:gitea_openapi/api_exception.dart';
import 'package:gitea_openapi/api_helper.dart';
import 'package:gitea_openapi/auth/api_key_auth.dart';
import 'package:gitea_openapi/auth/authentication.dart';
import 'package:gitea_openapi/auth/http_basic_auth.dart';
import 'package:gitea_openapi/auth/oauth.dart';
import 'package:gitea_openapi/model/access_token.dart';
import 'package:gitea_openapi/model/add_collaborator_option.dart';
import 'package:gitea_openapi/model/add_time_option.dart';
import 'package:gitea_openapi/model/annotated_tag.dart';
import 'package:gitea_openapi/model/annotated_tag_object.dart';
import 'package:gitea_openapi/model/api_error.dart';
import 'package:gitea_openapi/model/attachment.dart';
import 'package:gitea_openapi/model/branch.dart';
import 'package:gitea_openapi/model/branch_protection.dart';
import 'package:gitea_openapi/model/comment.dart';
import 'package:gitea_openapi/model/commit.dart';
import 'package:gitea_openapi/model/commit_date_options.dart';
import 'package:gitea_openapi/model/commit_meta.dart';
import 'package:gitea_openapi/model/commit_user.dart';
import 'package:gitea_openapi/model/contents_response.dart';
import 'package:gitea_openapi/model/create_branch_protection_option.dart';
import 'package:gitea_openapi/model/create_email_option.dart';
import 'package:gitea_openapi/model/create_file_options.dart';
import 'package:gitea_openapi/model/create_fork_option.dart';
import 'package:gitea_openapi/model/create_gpg_key_option.dart';
import 'package:gitea_openapi/model/create_hook_option.dart';
import 'package:gitea_openapi/model/create_issue_comment_option.dart';
import 'package:gitea_openapi/model/create_issue_option.dart';
import 'package:gitea_openapi/model/create_key_option.dart';
import 'package:gitea_openapi/model/create_label_option.dart';
import 'package:gitea_openapi/model/create_milestone_option.dart';
import 'package:gitea_openapi/model/create_org_option.dart';
import 'package:gitea_openapi/model/create_pull_request_option.dart';
import 'package:gitea_openapi/model/create_release_option.dart';
import 'package:gitea_openapi/model/create_repo_option.dart';
import 'package:gitea_openapi/model/create_status_option.dart';
import 'package:gitea_openapi/model/create_team_option.dart';
import 'package:gitea_openapi/model/create_user_option.dart';
import 'package:gitea_openapi/model/delete_email_option.dart';
import 'package:gitea_openapi/model/delete_file_options.dart';
import 'package:gitea_openapi/model/deploy_key.dart';
import 'package:gitea_openapi/model/edit_attachment_options.dart';
import 'package:gitea_openapi/model/edit_branch_protection_option.dart';
import 'package:gitea_openapi/model/edit_deadline_option.dart';
import 'package:gitea_openapi/model/edit_git_hook_option.dart';
import 'package:gitea_openapi/model/edit_hook_option.dart';
import 'package:gitea_openapi/model/edit_issue_comment_option.dart';
import 'package:gitea_openapi/model/edit_issue_option.dart';
import 'package:gitea_openapi/model/edit_label_option.dart';
import 'package:gitea_openapi/model/edit_milestone_option.dart';
import 'package:gitea_openapi/model/edit_org_option.dart';
import 'package:gitea_openapi/model/edit_pull_request_option.dart';
import 'package:gitea_openapi/model/edit_reaction_option.dart';
import 'package:gitea_openapi/model/edit_release_option.dart';
import 'package:gitea_openapi/model/edit_repo_option.dart';
import 'package:gitea_openapi/model/edit_team_option.dart';
import 'package:gitea_openapi/model/edit_user_option.dart';
import 'package:gitea_openapi/model/email.dart';
import 'package:gitea_openapi/model/external_tracker.dart';
import 'package:gitea_openapi/model/external_wiki.dart';
import 'package:gitea_openapi/model/file_commit_response.dart';
import 'package:gitea_openapi/model/file_delete_response.dart';
import 'package:gitea_openapi/model/file_links_response.dart';
import 'package:gitea_openapi/model/file_response.dart';
import 'package:gitea_openapi/model/git_blob_response.dart';
import 'package:gitea_openapi/model/git_entry.dart';
import 'package:gitea_openapi/model/git_hook.dart';
import 'package:gitea_openapi/model/git_object.dart';
import 'package:gitea_openapi/model/git_tree_response.dart';
import 'package:gitea_openapi/model/gpg_key.dart';
import 'package:gitea_openapi/model/gpg_key_email.dart';
import 'package:gitea_openapi/model/hook.dart';
import 'package:gitea_openapi/model/identity.dart';
import 'package:gitea_openapi/model/inline_object.dart';
import 'package:gitea_openapi/model/inline_response200.dart';
import 'package:gitea_openapi/model/inline_response2001.dart';
import 'package:gitea_openapi/model/internal_tracker.dart';
import 'package:gitea_openapi/model/issue.dart';
import 'package:gitea_openapi/model/issue_deadline.dart';
import 'package:gitea_openapi/model/issue_labels_option.dart';
import 'package:gitea_openapi/model/label.dart';
import 'package:gitea_openapi/model/markdown_option.dart';
import 'package:gitea_openapi/model/merge_pull_request_option.dart';
import 'package:gitea_openapi/model/migrate_repo_form.dart';
import 'package:gitea_openapi/model/milestone.dart';
import 'package:gitea_openapi/model/notification_count.dart';
import 'package:gitea_openapi/model/notification_subject.dart';
import 'package:gitea_openapi/model/notification_thread.dart';
import 'package:gitea_openapi/model/organization.dart';
import 'package:gitea_openapi/model/payload_commit.dart';
import 'package:gitea_openapi/model/payload_commit_verification.dart';
import 'package:gitea_openapi/model/payload_user.dart';
import 'package:gitea_openapi/model/permission.dart';
import 'package:gitea_openapi/model/pr_branch_info.dart';
import 'package:gitea_openapi/model/public_key.dart';
import 'package:gitea_openapi/model/pull_request.dart';
import 'package:gitea_openapi/model/pull_request_meta.dart';
import 'package:gitea_openapi/model/reaction.dart';
import 'package:gitea_openapi/model/reference.dart';
import 'package:gitea_openapi/model/release.dart';
import 'package:gitea_openapi/model/repository.dart';
import 'package:gitea_openapi/model/repository_meta.dart';
import 'package:gitea_openapi/model/repo_commit.dart';
import 'package:gitea_openapi/model/repo_topic_options.dart';
import 'package:gitea_openapi/model/search_results.dart';
import 'package:gitea_openapi/model/server_version.dart';
import 'package:gitea_openapi/model/status.dart';
import 'package:gitea_openapi/model/stop_watch.dart';
import 'package:gitea_openapi/model/tag.dart';
import 'package:gitea_openapi/model/team.dart';
import 'package:gitea_openapi/model/topic_name.dart';
import 'package:gitea_openapi/model/topic_response.dart';
import 'package:gitea_openapi/model/tracked_time.dart';
import 'package:gitea_openapi/model/transfer_repo_option.dart';
import 'package:gitea_openapi/model/update_file_options.dart';
import 'package:gitea_openapi/model/user.dart';
import 'package:gitea_openapi/model/user_heatmap_data.dart';
import 'package:gitea_openapi/model/watch_info.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
75
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
37
Learn more about scoring.

We analyzed this package on Feb 26, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.5

Health suggestions

Fix lib/model/branch_protection.dart. (-8.63 points)

Analysis of lib/model/branch_protection.dart reported 18 hints, including:

line 95 col 7: DO use curly braces for all flow control structures.

line 97 col 7: DO use curly braces for all flow control structures.

line 99 col 7: DO use curly braces for all flow control structures.

line 102 col 7: DO use curly braces for all flow control structures.

line 105 col 7: DO use curly braces for all flow control structures.

Fix lib/model/create_branch_protection_option.dart. (-7.71 points)

Analysis of lib/model/create_branch_protection_option.dart reported 16 hints, including:

line 85 col 7: DO use curly braces for all flow control structures.

line 87 col 7: DO use curly braces for all flow control structures.

line 89 col 7: DO use curly braces for all flow control structures.

line 92 col 7: DO use curly braces for all flow control structures.

line 94 col 7: DO use curly braces for all flow control structures.

Fix lib/model/edit_branch_protection_option.dart. (-7.71 points)

Analysis of lib/model/edit_branch_protection_option.dart reported 16 hints, including:

line 82 col 7: DO use curly braces for all flow control structures.

line 84 col 7: DO use curly braces for all flow control structures.

line 86 col 7: DO use curly braces for all flow control structures.

line 88 col 7: DO use curly braces for all flow control structures.

line 90 col 7: DO use curly braces for all flow control structures.

Fix additional 46 files with analysis or formatting issues. (-40.40 points)

Additional issues in the following files:

  • lib/model/pull_request.dart (5 hints)
  • lib/model/repository.dart (5 hints)
  • lib/model/branch.dart (4 hints)
  • lib/model/issue.dart (4 hints)
  • lib/model/edit_repo_option.dart (3 hints)
  • lib/model/external_tracker.dart (3 hints)
  • lib/model/gpg_key.dart (3 hints)
  • lib/model/internal_tracker.dart (3 hints)
  • lib/model/attachment.dart (2 hints)
  • lib/model/comment.dart (2 hints)
  • lib/model/commit_date_options.dart (2 hints)
  • lib/model/create_team_option.dart (2 hints)
  • lib/model/edit_team_option.dart (2 hints)
  • lib/model/edit_user_option.dart (2 hints)
  • lib/model/hook.dart (2 hints)
  • lib/model/milestone.dart (2 hints)
  • lib/model/release.dart (2 hints)
  • lib/model/status.dart (2 hints)
  • lib/model/team.dart (2 hints)
  • lib/model/topic_response.dart (2 hints)
  • lib/model/user.dart (2 hints)
  • lib/api_client.dart (1 hint)
  • lib/api_helper.dart (1 hint)
  • lib/model/add_time_option.dart (1 hint)
  • lib/model/create_issue_option.dart (1 hint)
  • lib/model/create_milestone_option.dart (1 hint)
  • lib/model/create_org_option.dart (1 hint)
  • lib/model/create_pull_request_option.dart (1 hint)
  • lib/model/create_user_option.dart (1 hint)
  • lib/model/deploy_key.dart (1 hint)
  • lib/model/edit_deadline_option.dart (1 hint)
  • lib/model/edit_issue_option.dart (1 hint)
  • lib/model/edit_milestone_option.dart (1 hint)
  • lib/model/edit_org_option.dart (1 hint)
  • lib/model/edit_pull_request_option.dart (1 hint)
  • lib/model/issue_deadline.dart (1 hint)
  • lib/model/merge_pull_request_option.dart (1 hint)
  • lib/model/notification_thread.dart (1 hint)
  • lib/model/organization.dart (1 hint)
  • lib/model/payload_commit.dart (1 hint)
  • lib/model/public_key.dart (1 hint)
  • lib/model/pull_request_meta.dart (1 hint)
  • lib/model/reaction.dart (1 hint)
  • lib/model/stop_watch.dart (1 hint)
  • lib/model/tracked_time.dart (1 hint)
  • lib/model/watch_info.dart (1 hint)

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and gitea_openapi.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
http >=0.12.0 <0.13.0 0.12.0+4
Transitive dependencies
async 2.4.0
charcode 1.1.3
collection 1.14.12
http_parser 3.1.3
meta 1.1.8
path 1.6.4
pedantic 1.9.0
source_span 1.6.0
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
Dev dependencies
test ^1.3.0