The cl-github-v3 Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-github-v3 Reference Manual

This is the cl-github-v3 Reference Manual, version 0.0.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:20:14 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-github-v3 - Common Lisp interface to the github V3 API

This library implements a thin wrapper around github's V3 API. At this point, it is incomplete and only defines CL functions for listing and creating repositories.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-github-v3

Author

Hans Huebner

Description

github V3 API library

Version

0.0.1

Dependencies
Source

cl-github-v3.asd (file)

Component

github.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-github-v3.asd

Location

cl-github-v3.asd

Systems

cl-github-v3 (system)


Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-github-v3/github.lisp

Parent

cl-github-v3 (system)

Location

github.lisp

Packages

cl-github

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cl-github

Source

github.lisp (file)

Nickname

github

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *password*

Password to use for API calls

Package

cl-github

Source

github.lisp (file)

Special Variable: *username*

Username to use for API calls

Package

cl-github

Source

github.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: api-command URL &key BODY METHOD USERNAME PASSWORD PARAMETERS
Package

cl-github

Source

github.lisp (file)

Function: create-repository &rest PARAMETERS &key NAME ORG DESCRIPTION HOMEPAGE PUBLIC HAS-ISSUES HAS-WIKI HAS-DOWNLOADS
Package

cl-github

Source

github.lisp (file)

Function: list-repositories &rest PARAMETERS &key ORG
Package

cl-github

Source

github.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Macros

Macro: booleanize-parameters PLIST &rest KEYS
Package

cl-github

Source

github.lisp (file)

Macro: define-github-command NAME PARAMETERS &body BODY
Package

cl-github

Source

github.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: github-keyword-to-keyword STRING
Package

cl-github

Source

github.lisp (file)

Function: keyword-to-github-keyword KEYWORD
Package

cl-github

Source

github.lisp (file)

Function: plist-to-hash-table PLIST
Package

cl-github

Source

github.lisp (file)

Function: plist-to-http-parameters PLIST
Package

cl-github

Source

github.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Generic functions

Generic Function: error-http-headers CONDITION
Package

cl-github

Methods
Method: error-http-headers (CONDITION api-error)
Source

github.lisp (file)

Generic Function: error-http-status CONDITION
Package

cl-github

Methods
Method: error-http-status (CONDITION api-error)
Source

github.lisp (file)

Generic Function: error-response CONDITION
Package

cl-github

Methods
Method: error-response (CONDITION api-error)
Source

github.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Conditions

Condition: api-error ()
Package

cl-github

Source

github.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: http-status
Initargs

:http-status

Readers

error-http-status (generic function)

Slot: http-headers
Initargs

:http-headers

Readers

error-http-headers (generic function)

Slot: response
Initargs

:response

Readers

error-response (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-github-v3.asd: The cl-github-v3<dot>asd file
cl-github-v3/github.lisp: The cl-github-v3/github<dot>lisp file

F
File, Lisp, cl-github-v3.asd: The cl-github-v3<dot>asd file
File, Lisp, cl-github-v3/github.lisp: The cl-github-v3/github<dot>lisp file

L
Lisp File, cl-github-v3.asd: The cl-github-v3<dot>asd file
Lisp File, cl-github-v3/github.lisp: The cl-github-v3/github<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   B   C   D   E   F   G   K   L   M   P  
Index Entry  Section

A
api-command: Exported functions

B
booleanize-parameters: Internal macros

C
create-repository: Exported functions

D
define-github-command: Internal macros

E
error-http-headers: Internal generic functions
error-http-headers: Internal generic functions
error-http-status: Internal generic functions
error-http-status: Internal generic functions
error-response: Internal generic functions
error-response: Internal generic functions

F
Function, api-command: Exported functions
Function, create-repository: Exported functions
Function, github-keyword-to-keyword: Internal functions
Function, keyword-to-github-keyword: Internal functions
Function, list-repositories: Exported functions
Function, plist-to-hash-table: Internal functions
Function, plist-to-http-parameters: Internal functions

G
Generic Function, error-http-headers: Internal generic functions
Generic Function, error-http-status: Internal generic functions
Generic Function, error-response: Internal generic functions
github-keyword-to-keyword: Internal functions

K
keyword-to-github-keyword: Internal functions

L
list-repositories: Exported functions

M
Macro, booleanize-parameters: Internal macros
Macro, define-github-command: Internal macros
Method, error-http-headers: Internal generic functions
Method, error-http-status: Internal generic functions
Method, error-response: Internal generic functions

P
plist-to-hash-table: Internal functions
plist-to-http-parameters: Internal functions

Jump to:   A   B   C   D   E   F   G   K   L   M   P  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
H   R   S  
Index Entry  Section

*
*password*: Exported special variables
*username*: Exported special variables

H
http-headers: Internal conditions
http-status: Internal conditions

R
response: Internal conditions

S
Slot, http-headers: Internal conditions
Slot, http-status: Internal conditions
Slot, response: Internal conditions
Special Variable, *password*: Exported special variables
Special Variable, *username*: Exported special variables

Jump to:   *  
H   R   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   A   C   P   S  
Index Entry  Section

A
api-error: Internal conditions

C
cl-github: The cl-github package
cl-github-v3: The cl-github-v3 system
Condition, api-error: Internal conditions

P
Package, cl-github: The cl-github package

S
System, cl-github-v3: The cl-github-v3 system

Jump to:   A   C   P   S