package github-unix

You can search for identifiers within the package.

in-package search v0.2.0

github-unix
- Github
  - API
  - Collaborator
  - Deploy_key
  - Emoji
  - Endpoint
    
    Version
  - Event
  - Filter
  - Gist
  - Git_obj
  - Issue
  - Label
  - Milestone
  - Monad
  - Organization
    
    Hook
  - Pull
  - Rate_limit
  - Release
  - Repo
    
    Hook
  - Response
  - Scope
  - Search
  - Stats
  - Status
  - Stream
  - Team
  - Token
  - URI
  - User
- Github_cookie_jar

Legend:
Library
Module
Module type
Parameter
Class
Class type

The Deploy_key module provides the means to manage per-repository deploy keys.

see https://developer.github.com/v3/repos/keys/
deploy key API docs

val for_repo : 
  ?token:Token.t ->
  user:string ->
  repo:string ->
  unit ->
  Github_t.deploy_key Stream.t

for_repo ~user ~repo () is a stream of deploy keys associated with repo user/repo.

val get : 
  ?token:Token.t ->
  user:string ->
  repo:string ->
  id:int64 ->
  unit ->
  Github_t.deploy_key Response.t Monad.t

get ~user ~repo ~id () is deploy key id for repo user/repo.

val create : 
  ?token:Token.t ->
  user:string ->
  repo:string ->
  new_key:Github_t.new_deploy_key ->
  unit ->
  Github_t.deploy_key Response.t Monad.t

create ~user ~repo ~new_key () is the newly created deploy key new_key for repo user/repo.

val delete : 
  ?token:Token.t ->
  user:string ->
  repo:string ->
  id:int64 ->
  unit ->
  unit Response.t Monad.t

delete ~user ~repo ~id () activates after deploy key id in repo user/repo has been deleted.