vincent/aptly
1
0
Fork 0
mirror of https://github.com/aptly-dev/aptly.git synced 2026-01-11 03:11:50 +00:00
Code Issues Projects Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
André Roth
2024-11-28 13:09:41 +01:00
parent 83f7c869f0
commit 4f229a5bcf
18 changed files with 47 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
api/gpg.go
View File

@@ -19,9 +19,11 @@ type gpgAddKeyParams struct {
Keyring string
}
// @Summary Add GPG Key
// @Description Adds a GPG key to aptly keyring
// @Tags GPG
// @Summary Add GPG Keys
// @Description **Adds GPG keys to aptly keyring**
// @Description
// @Description Add GPG public keys for veryfing remote repositories for mirroring.
// @Tags Mirrors
// @Produce json
// @Success 200 {object} string "OK"
// @Failure 400 {object} Error "Bad Request"

19
api/graph.go
View File

@@ -13,17 +13,26 @@ import (
)
// @Summary Graph Output
// @Description **Generate graph of aptly objects (same as in aptly graph command).**
// @Description e.g open url `http://localhost:8080/api/graph.svg?layout=vertical` in browser
// @Tags Graph
// @Description **Generate dependency graph**
// @Description
// @Description Command graph generates graph of dependencies:
// @Description
// @Description * between snapshots and mirrors (what mirror was used to create each snapshot)
// @Description * between snapshots and local repos (what local repo was used to create snapshot)
// @Description * between snapshots (pulling, merging, etc.)
// @Description * between snapshots, local repos and published repositories (how snapshots were published).
// @Description
// @Description Graph is rendered to PNG file using graphviz package.
// @Description
// @Description Example URL: `http://localhost:8080/api/graph.svg?layout=vertical`
// @Tags Status
// @Produce json
// @Param ext path string true "ext specifies desired file extension, e.g. .png, .svg."
// @Param layout query string false "Change between a `horizontal` (default) and a `vertical` graph layout."
// @Success 200 {object} []byte "Output"
// @Failure 404 {object} Error "Not Found"
// @Failure 500 {object} Error "Internal Server Error"
// @Router /api/graph [get]
// GET /api/graph.:ext?layout=[vertical|horizontal(default)]
// @Router /api/graph.{ext} [get]
func apiGraph(c *gin.Context) {
var (
err error

6
api/mirror.go
View File

@@ -31,7 +31,7 @@ func getVerifier(keyRings []string) (pgp.Verifier, error) {
return verifier, nil
}
// @Summary Get mirrors
// @Summary Get Mirrors
// @Description **Show list of currently available mirrors**
// @Description Each mirror is returned as in “show” API.
// @Tags Mirrors
@@ -82,8 +82,8 @@ type mirrorCreateParams struct {
IgnoreSignatures bool ` json:"IgnoreSignatures"`
}
// @Summary Create mirror
// @Description **Create a mirror**
// @Summary Create Mirror
// @Description **Create a mirror of a remote repositoru**
// @Tags Mirrors
// @Consume json
// @Param request body mirrorCreateParams true "Parameters"

6
api/s3.go
View File

@@ -6,8 +6,10 @@ import (
// @Summary S3 buckets
// @Description **Get list of S3 buckets**
// @Tags S3
// @Produce json
// @Description
// @Description List configured S3 buckets.
// @Tags Status
// @Produce json
// @Success 200 {array} string "List of S3 buckets"
// @Router /api/s3 [get]
func apiS3List(c *gin.Context) {

2
api/storage.go
View File

@@ -18,6 +18,8 @@ type diskFree struct {
// @Summary Get Storage Utilization
// @Description **Get disk free information of aptly storage**
// @Description
// @Description Units in MiB.
// @Tags Status
// @Produce json
// @Success 200 {object} diskFree "Storage information"

2
docs/Database.md
View File

@@ -1,4 +1,4 @@
# Aptly Database Operations
# Maintenance Operations
<div>
Manage aptly’s internal metadata database and package pool.
</div>

2
docs/Files.md
View File

@@ -1,4 +1,4 @@
# File Operations
# Upload Package Files
<div>
Upload package files temporarily to aptly service. These files
could be added to local repositories using [local repositories API](/doc/api/repos).

4
docs/GPG.md
View File

@@ -1,4 +0,0 @@
# GPG Keys
<div>
</div>

30
docs/Graph.md
View File

@@ -1,30 +0,0 @@
# Dependency Graph
<div>
aptly generates graph showing dependencies between mirrors, local repositories,
snapshots and published repositories.
 
Command graph generates graph of dependencies:
* between snapshots and mirrors (what mirror was used to create each snapshot)
* between snapshots and local repos (what local repo was used to create snapshot)
* between snapshots (pulling, merging, etc.)
* between snapshots, local repos and published repositories (how snapshots were published).
Graph is rendered to PNG file using graphviz package.
Usage:
$ aptly graph
Flags:
- `-format="png"`: graph output format, could be anything graphviz supports, e.g. `png`, `pdf`, `svg`, ...
- `-output=""`: specify output filename, default is to open result in viewer
- `-layout="horizontal"`: change between a `horizontal` and a `vertical` graph layout.
Example:
<a href="../../../img/graphfull.png"><img src="../../../img/graph.png" alt="Example graph from aptly graph (horizontal)" class="img-responsive"></a>
</div>

7
docs/Mirrors.md
View File

@@ -1,7 +1,8 @@
# Repository Mirrors
# Remote Repository Mirrors
<div>
aptly allows to create mirrors of remote Debian repositories, HTTP, HTTPS and FTP repositories are supported.
Manage mirrors of remote Debian repositories.
HTTP, HTTPS and FTP repositories are supported.
Mirrors are created with [`aptly mirror create`](/doc/aptly/mirror/create/) command, mirror contents are downloaded with [`aptly mirror update`](/doc/aptly/mirror/update/) command. Mirror could be updated at any moment. In order to preserve current mirror state, [create snapshot](/doc/aptly/snapshot/create/) of the mirror. Snapshot could be published or used to build other snapshots.
</div>

2
docs/Packages.md
View File

@@ -1,4 +1,4 @@
# Packages
# Search Packages
<div>
Perform operations on the whole collection of packages in apty database.
</div>

2
docs/Publish.md
View File

@@ -1,4 +1,4 @@
# Aptly Publish Points
# Publish repositories and mirrors
<div>
Publish snapshot or local repo as Debian repository which could be served by HTTP/FTP/rsync server. Repository is signed by user's key with GnuPG. Key should be created beforehand (see section GPG Keys below). Published repository could be consumed directly by apt.

2
docs/Repos.md
View File

@@ -1,4 +1,4 @@
# Repositories
# Manage Local Repositories
<div>
Local repository is a collection of packages (most usually custom packages created internally).
Packages could be added to local repository at any moment, removed, moved or copied between repos.

5
docs/S3.md
View File

@@ -1,5 +0,0 @@
# S3 Endpoints
<div>
</div>

2
docs/Snapshots.md
View File

@@ -1,4 +1,4 @@
# Repository and Mirror Snapshots
# Manage repository and mirror Snapshots
<div>
Snapshot is a fixed state of remote repository mirror or local repository. Internally snapshot is list of references to packages. Snapshot is immutable, i.e. it can’t be changed since it has been created. Snapshots could be merged, filtered, individual packages could be pulled, snapshot could be verified for missing dependencies. Finally, snapshots could be published as repositories.
</div>

7
docs/Status.md
View File

@@ -1,10 +1,5 @@
# Aptly Status Information
<div>
## Something
Very interesting ... asd wer
Various status information.
</div>

6
docs/docs.html
View File

@@ -39,6 +39,11 @@
font-size: 16pt !important;
}
/* Group Spacing */
.swagger-ui .opblock-tag-section {
padding-top: 40px !important;
}
/* Tag Group */
.swagger-ui .opblock-tag-section > .opblock-tag > a {
color: grey !important;
@@ -51,7 +56,6 @@
.swagger-ui .opblock-tag-section .opblock-tag .markdown > h1 {
font-size: 14pt;
margin-top: 0px;
margin-left: 1em;
}
/* Group Description */

12
docs/swagger.conf.tpl
View File

@@ -10,24 +10,18 @@ package docs
// @Tag.description.markdown
// @Tag.name Files
// @Tag.description.markdown
// @Tag.name Packages
// @Tag.description.markdown
// @Tag.name Mirrors
// @Tag.description.markdown
// @Tag.name Snapshots
// @Tag.description.markdown
// @Tag.name Publish
// @Tag.description.markdown
// @Tag.name Graph
// @Tag.description.markdown
// @Tag.name S3
// @Tag.description.markdown
// @Tag.name GPG
// @Tag.description.markdown
// @Tag.name Database
// @Tag.name Packages
// @Tag.description.markdown
// @Tag.name Status
// @Tag.description.markdown
// @Tag.name Database
// @Tag.description.markdown
// @Tag.name Tasks
// @Tag.description.markdown