The cl-github-v3 Reference Manual

This is the cl-github-v3 Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 04:02:39 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-github-v3

github V3 API library

Author

Hans Huebner

Version

0.0.1

Dependencies
  • cl-ppcre (system).
  • drakma (system).
  • yason (system).
  • alexandria (system).
Source

cl-github-v3.asd.

Child Component

github.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 cl-github-v3/cl-github-v3.asd

Source

cl-github-v3.asd.

Parent Component

cl-github-v3 (system).

ASDF Systems

cl-github-v3.


3.1.2 cl-github-v3/github.lisp

Source

cl-github-v3.asd.

Parent Component

cl-github-v3 (system).

Packages

cl-github.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-github

Source

github.lisp.

Nickname

github

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *password*

Password to use for API calls

Package

cl-github.

Source

github.lisp.

Special Variable: *username*

Username to use for API calls

Package

cl-github.

Source

github.lisp.


5.1.2 Ordinary functions

Function: api-command (url &key body method username password parameters)
Package

cl-github.

Source

github.lisp.

Function: create-repository (&rest parameters &key name org description homepage public has-issues has-wiki has-downloads)
Package

cl-github.

Source

github.lisp.

Function: list-repositories (&rest parameters &key org)
Package

cl-github.

Source

github.lisp.


5.2 Internals


5.2.1 Macros

Macro: booleanize-parameters (plist &rest keys)
Package

cl-github.

Source

github.lisp.

Macro: define-github-command (name parameters &body body)
Package

cl-github.

Source

github.lisp.


5.2.2 Ordinary functions

Package

cl-github.

Source

github.lisp.

Function: github-keyword-to-keyword (string)
Package

cl-github.

Source

github.lisp.

Function: keyword-to-github-keyword (keyword)
Package

cl-github.

Source

github.lisp.

Function: plist-to-hash-table (plist)
Package

cl-github.

Source

github.lisp.

Function: plist-to-http-parameters (plist)
Package

cl-github.

Source

github.lisp.


5.2.3 Generic functions

Generic Reader: error-http-headers (condition)
Package

cl-github.

Methods
Reader Method: error-http-headers ((condition api-error))
Source

github.lisp.

Target Slot

http-headers.

Generic Reader: error-http-status (condition)
Package

cl-github.

Methods
Reader Method: error-http-status ((condition api-error))
Source

github.lisp.

Target Slot

http-status.

Generic Reader: error-response (condition)
Package

cl-github.

Methods
Reader Method: error-response ((condition api-error))
Source

github.lisp.

Target Slot

response.


5.2.4 Conditions

Condition: api-error
Package

cl-github.

Source

github.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: http-status
Initargs

:http-status

Readers

error-http-status.

Writers

This slot is read-only.

Slot: http-headers
Initargs

:http-headers

Readers

error-http-headers.

Writers

This slot is read-only.

Slot: response
Initargs

:response

Readers

error-response.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

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

A
api-command: Public ordinary functions

B
booleanize-parameters: Private macros

C
create-repository: Public ordinary functions

D
define-github-command: Private macros
do-header-links: Private ordinary functions

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

F
Function, api-command: Public ordinary functions
Function, create-repository: Public ordinary functions
Function, do-header-links: Private ordinary functions
Function, github-keyword-to-keyword: Private ordinary functions
Function, keyword-to-github-keyword: Private ordinary functions
Function, list-repositories: Public ordinary functions
Function, plist-to-hash-table: Private ordinary functions
Function, plist-to-http-parameters: Private ordinary functions

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

K
keyword-to-github-keyword: Private ordinary functions

L
list-repositories: Public ordinary functions

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

P
plist-to-hash-table: Private ordinary functions
plist-to-http-parameters: Private ordinary functions