Next: Introduction, Previous: (dir), 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 4.0 beta 2 "William Riker" on Sun Dec 15 04:58:49 2024 GMT+0.

Next: Systems, Previous: The cl-github-v3 Reference Manual, Up: The cl-github-v3 Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cl-github-v3 Reference Manual [Contents][Index]

2 Systems

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

cl-github-v3

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

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).

Next: Packages, Previous: Systems, Up: The cl-github-v3 Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: cl-github-v3/github.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

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.

Previous: cl-github-v3/cl-github-v3.asd, Up: Lisp [Contents][Index]

3.1.2 `cl-github-v3/github.lisp`

Source

cl-github-v3.asd.

Parent Component

cl-github-v3 (system).

Packages

cl-github.

Public Interface

*password* (special variable).
*username* (special variable).
api-command (function).
create-repository (function).
list-repositories (function).

Internals

+ratelimit-min-wait+ (special variable).
+ratelimit-retry-max+ (special variable).
+unix-epoch+ (constant).
api-error (condition).
booleanize-parameters (macro).
define-github-command (macro).
do-header-links (function).
error-http-headers (reader method).
error-http-status (reader method).
error-response (reader method).
get-unix-time (function).
github-keyword-to-keyword (function).
keyword-to-github-keyword (function).
plist-to-hash-table (function).
plist-to-http-parameters (function).

Next: Definitions, Previous: Files, Up: The cl-github-v3 Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

cl-github

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

4.1 `cl-github`

Source

github.lisp.

Nickname

github

Use List

common-lisp.

Public Interface

*password* (special variable).
*username* (special variable).
api-command (function).
create-repository (function).
list-repositories (function).

Internals

+ratelimit-min-wait+ (special variable).
+ratelimit-retry-max+ (special variable).
+unix-epoch+ (constant).
api-error (condition).
booleanize-parameters (macro).
define-github-command (macro).
do-header-links (function).
error-http-headers (generic reader).
error-http-status (generic reader).
error-response (generic reader).
get-unix-time (function).
github-keyword-to-keyword (function).
keyword-to-github-keyword (function).
plist-to-hash-table (function).
plist-to-http-parameters (function).

Next: Indexes, Previous: Packages, Up: The cl-github-v3 Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

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.

Previous: Special variables, Up: Public Interface [Contents][Index]

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.

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

5.2 Internals

Constants
Special variables
Macros
Ordinary functions
Generic functions
Conditions

Next: Special variables, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Constants

Constant: +unix-epoch+ ¶

The Unix epoch as a universal time.

Package: cl-github.
Source: github.lisp.

Next: Macros, Previous: Constants, Up: Internals [Contents][Index]

5.2.2 Special variables

Special Variable: +ratelimit-min-wait+ ¶

Minimum number of seconds to wait when rate limited

Package: cl-github.
Source: github.lisp.

Special Variable: +ratelimit-retry-max+ ¶

Number of retries before failing

Package: cl-github.
Source: github.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]

5.2.3 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.

Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]

5.2.4 Ordinary functions

Function: do-header-links (fn headers) ¶

Package: cl-github.
Source: github.lisp.

Function: get-unix-time () ¶

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.

Next: Conditions, Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.5 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.

Previous: Generic functions, Up: Internals [Contents][Index]

5.2.6 Conditions

Condition: api-error ¶

Package

cl-github.

Source

github.lisp.

Direct superclasses

error.

Direct methods

error-http-headers.
error-http-status.
error-response.

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.

Previous: Definitions, Up: The cl-github-v3 Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

Next: Variables, Previous: Concepts, 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`:	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, get-unix-time`:	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
	`get-unix-time`:	Private ordinary 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

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* + C H R S

	Index Entry	Section

*
	`password`:	Public special variables
	`username`:	Public special variables

+
	`+ratelimit-min-wait+`:	Private special variables
	`+ratelimit-retry-max+`:	Private special variables
	`+unix-epoch+`:	Private constants

C
	`Constant, +unix-epoch+`:	Private constants

H
	`http-headers`:	Private conditions
	`http-status`:	Private conditions

R
	`response`:	Private conditions

S
	`Slot, http-headers`:	Private conditions
	`Slot, http-status`:	Private conditions
	`Slot, response`:	Private conditions
	`Special Variable, password`:	Public special variables
	`Special Variable, username`:	Public special variables
	`Special Variable, +ratelimit-min-wait+`:	Private special variables
	`Special Variable, +ratelimit-retry-max+`:	Private special variables

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

A.4 Data types

Jump to:	A C F G P S

	Index Entry	Section

A
	`api-error`:	Private conditions

C
	`cl-github`:	The cl-github package
	`cl-github-v3`:	The cl-github-v3 system
	`cl-github-v3.asd`:	The cl-github-v3/cl-github-v3․asd file
	`Condition, api-error`:	Private conditions

F
	`File, cl-github-v3.asd`:	The cl-github-v3/cl-github-v3․asd file
	`File, github.lisp`:	The cl-github-v3/github․lisp file

G
	`github.lisp`:	The cl-github-v3/github․lisp file

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

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

The cl-github-v3 Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-github-v3

3 Files

3.1 Lisp

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

3.1.2 cl-github-v3/github.lisp

4 Packages

4.1 cl-github

5 Definitions

5.1 Public Interface

5.1.1 Special variables

5.1.2 Ordinary functions

5.2 Internals

5.2.1 Constants

5.2.2 Special variables

5.2.3 Macros

5.2.4 Ordinary functions

5.2.5 Generic functions

5.2.6 Conditions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-github-v3`

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

3.1.2 `cl-github-v3/github.lisp`

4.1 `cl-github`