Skip to content
This repository has been archived by the owner on Feb 23, 2020. It is now read-only.
/ circleci.py Public archive

Commit

Permalink
add experimental doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Lev Lazinskiy committed Oct 25, 2017
1 parent 8f03116 commit 9a44572
Showing 1 changed file with 227 additions and 0 deletions.
227 changes: 227 additions & 0 deletions docs/circleci.experimental.txt
View file
@@ -0,0 +1,227 @@
Help on module experimental:

NAME
experimental - CircleCI Experimental API Module

DESCRIPTION
WARNING: All methods here work against the UNDOCUMENTED and UNSUPPORTED CircleCI
API. Subject to change at any moment. Use at your own risk

:copyright: (c) 2017 by Lev Lazinskiy
:license: MIT, see LICENSE for more details.

CLASSES
circleci.api.Api(builtins.object)
Experimental

class Experimental(circleci.api.Api)
| Experimantal CircleCI API
|
| Method resolution order:
| Experimental
| circleci.api.Api
| builtins.object
|
| Methods defined here:
|
| retry_no_cache(self, username, project, build_num, vcs_type='github')
| Retries a build without cache
|
| Args:
| username (str):
| org or user name
| project (str):
| case sensitive repo name
| build_num (str):
| build number
| vcs_type (str):
| defaults to github
| on circleci.com you can also pass in bitbucket
|
| Endpoint:
| POST: /project/:vcs-type/:username/:project/:build_num/retry
|
| ----------------------------------------------------------------------
| Methods inherited from circleci.api.Api:
|
| __init__(self, token, url='https://circleci.com/api/v1.1')
| Instantiate a new circleci.Api object.
|
| Args:
| url (str):
| The URL to the CircleCI instance
| defaults to https://circleci.com/api/v1.1
|
| If you are running CircleCI server, the API
| is available at the same endpoint of your own
| installation url. i.e (https://circleci.yourcompany.com/api/v1.1)
|
| token (str):
| Your CircleCI token.abs
|
| add_ssh_user(self, username, project, build_num, vcs_type='github')
| Adds a user to the build's SSH permissions.
|
| Args:
| username (str):
| org or user name
| project (str):
| case sensitive repo name
| build_num (str):
| build number
| vcs_type (str):
| defaults to github
| on circleci.com you can also pass in bitbucket
|
| Endpoint:
| POST: /project/:vcs-type/:username/:project/:build_num/ssh-users
|
| cancel_build(self, username, project, build_num, vcs_type='github')
| Cancels the build.
|
| Args:
| username (str):
| org or user name
| project (str):
| case sensitive repo name
| build_num (str):
| build number
| vcs_type (str):
| defaults to github
| on circleci.com you can also pass in bitbucket
|
| Endpoint:
| POST: /project/:vcs-type/:username/:project/:build_num/cancel
|
| follow_project(self, username, project, vcs_type='github')
| Follow a new project on CircleCI.
|
| Args:
| username (str):
| org or user name
| project (str):
| case sensitive repo name
| vcs_type (str):
| defaults to github
| on circleci.com you can also pass in bitbucket
|
| Endpoint:
| POST: /project/:vcs-type/:username/:project/follow
|
| get_artifacts(self, username, project, build_num, vcs_type='github')
| List the artifacts produced by a given build.
|
| Args:
| username (str):
| org or user name
| project (str):
| case sensitive repo name
| build_num (str):
| build number
| vcs_type (str):
| defaults to github
| on circleci.com you can also pass in bitbucket
|
| Endpoint:
| GET: /project/:vcs-type/:username/:project/:build_num/artifacts
|
| get_build_info(self, username, project, build_num, vcs_type='github')
| Full details for a single build.
|
| Args:
| username (str):
| org or user name
| project (str):
| case sensitive repo name
| build_num (str):
| build number
| vcs_type (str):
| defaults to github
| on circleci.com you can also pass in bitbucket
|
| Endpoint:
| GET: /project/:vcs-type/:username/:project/:build_num
|
| get_project_build_summary(self, username, project, vcs_type='github')
| Build summary for each of the last 30 builds for a single git repo.
|
| Args:
| username (str):
| org or user name
| project (str):
| case sensitive repo name
| vcs_type (str):
| defaults to github
| on circleci.com you can also pass in bitbucket
|
| Endpoint:
| GET: /project/:vcs-type/:username/:project
|
| get_projects(self)
| List of all the projects you're following on CircleCI.
|
| Endpoint:
| GET: /projects
|
| get_recent_builds(self)
| Build summary for each of the last 30 recent builds, ordered by build_num.
|
| Endpoint:
| GET: /recent-builds
|
| get_user_info(self)
| Provides information about the signed in user.
|
| Endpoint:
| GET: /me
|
| retry_build(self, username, project, build_num, vcs_type='github')
| Retries the build.
|
| Args:
| username (str):
| org or user name
| project (str):
| case sensitive repo name
| build_num (str):
| build number
| vcs_type (str):
| defaults to github
| on circleci.com you can also pass in bitbucket
|
| Endpoint:
| POST: /project/:vcs-type/:username/:project/:build_num/retry
|
| trigger_build(self, username, project, branch='master', vcs_type='github', params=None)
| Triggers a new build.
|
| Args:
| username (str):
| org or user name
| project (str):
| case sensitive repo name
| branch (str):
| defaults to master
| vcs_type (str):
| defaults to github
| on circleci.com you can also pass in bitbucket
| params (dict):
| optional build parameters
| https://circleci.com/docs/1.0/parameterized-builds/
|
| Endpoint:
| POST: /project/:vcs-type/:username/:project/tree/:branch
|
| ----------------------------------------------------------------------
| Data descriptors inherited from circleci.api.Api:
|
| __dict__
| dictionary for instance variables (if defined)
|
| __weakref__
| list of weak references to the object (if defined)

FILE
/Users/levlaz/git/circleci.py/circleci/experimental.py


0 comments on commit 9a44572

Please sign in to comment.