The cl-github-v3 Reference Manual

Table of Contents

The cl-github-v3 Reference Manual

This is the cl-github-v3 Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:21:13 2020 GMT+0.

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.

2 Systems

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

2.1 cl-github-v3

Author

Hans Huebner

Description

github V3 API library

Version

0.0.1

Dependencies

• cl-ppcre
• drakma
• yason
• alexandria

Source

cl-github-v3.asd (file)

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

Location

cl-github-v3.asd

Systems

cl-github-v3 (system)

3.1.2 cl-github-v3/github.lisp

Parent

cl-github-v3 (system)

Location

github.lisp

Packages

cl-github

Exported Definitions

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

Internal Definitions

• api-error (condition)
• booleanize-parameters (macro)
• define-github-command (macro)
• do-header-links (function)
• error-http-headers (method)
• error-http-status (method)
• error-response (method)
• github-keyword-to-keyword (function)
• keyword-to-github-keyword (function)
• plist-to-hash-table (function)
• plist-to-http-parameters (function)

4 Packages

Packages are listed by definition order.

4.1 cl-github

Source

github.lisp (file)

Nickname

github

Use List

common-lisp

Exported Definitions

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

Internal Definitions

• api-error (condition)
• booleanize-parameters (macro)
• define-github-command (macro)
• do-header-links (function)
• error-http-headers (generic function)
• error-http-headers (method)
• error-http-status (generic function)
• error-http-status (method)
• error-response (generic function)
• error-response (method)
• github-keyword-to-keyword (function)
• keyword-to-github-keyword (function)
• plist-to-hash-table (function)
• plist-to-http-parameters (function)

5 Definitions

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

5.1 Exported definitions

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)

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)

5.2 Internal definitions

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)

5.2.2 Functions

Function: do-header-links FN HEADERS

Package

cl-github

Source

github.lisp (file)

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)

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)

5.2.4 Conditions

Condition: api-error ()

Package

cl-github

Source

github.lisp (file)

Direct superclasses

error (condition)

Direct methods

• error-response (method)
• error-http-headers (method)
• error-http-status (method)

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)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types