update swagger documentation

This commit is contained in:
André Roth
2024-10-31 13:57:37 +01:00
parent c9309c926c
commit f79423a4ee
7 changed files with 61 additions and 36 deletions
+4 -2
View File
@@ -66,9 +66,11 @@ func makeCmdPublishSourceAdd() *commander.Command {
cmd := &commander.Command{
Run: aptlyPublishSourceAdd,
UsageLine: "add <distribution> <source>",
Short: "add source to staged source list of published repository",
Short: "add source components to a published repo",
Long: `
The command adds sources to the staged source list of the published repository.
The command adds components of a snapshot or local repository to be published.
This does not publish the changes directly, but rather schedules them for a subsequent 'aptly publish update'.
The flag -component is mandatory. Use a comma-separated list of components, if
multiple components should be modified. The number of given components must be
+2 -2
View File
@@ -45,9 +45,9 @@ func makeCmdPublishSourceDrop() *commander.Command {
cmd := &commander.Command{
Run: aptlyPublishSourceDrop,
UsageLine: "drop <distribution>",
Short: "drops staged source changes of published repository",
Short: "drop pending source component changes of a published repository",
Long: `
Command drops the staged source changes of the published repository.
Remove all pending changes what would be applied with a subsequent 'aptly publish update'.
Example:
+4 -2
View File
@@ -64,9 +64,11 @@ func makeCmdPublishSourceRemove() *commander.Command {
cmd := &commander.Command{
Run: aptlyPublishSourceRemove,
UsageLine: "remove <distribution> [[<endpoint>:]<prefix>] <source>",
Short: "remove source from staged source list of published repository",
Short: "remove source components from a published repo",
Long: `
The command removes sources from the staged source list of the published repository.
The command removes source components (snapshot / local repo) from a published repository.
This does not publish the changes directly, but rather schedules them for a subsequent 'aptly publish update'.
The flag -component is mandatory. Use a comma-separated list of components, if
multiple components should be removed, e.g.:
+4 -3
View File
@@ -64,9 +64,11 @@ func makeCmdPublishSourceReplace() *commander.Command {
cmd := &commander.Command{
Run: aptlyPublishSourceReplace,
UsageLine: "replace <distribution> <source>",
Short: "replace staged source list of published repository",
Short: "replace the source components of a published repository",
Long: `
The command replaces the staged source list of the published repository.
The command replaces the source components of a snapshot or local repository to be published.
This does not publish the changes directly, but rather schedules them for a subsequent 'aptly publish update'.
The flag -component is mandatory. Use a comma-separated list of components, if
multiple components should be modified. The number of given components must be
@@ -77,7 +79,6 @@ equal to the number of given sources, e.g.:
Example:
$ aptly publish source replace -component=contrib wheezy ppa wheezy-contrib
`,
Flag: *flag.NewFlagSet("aptly-publish-source-add", flag.ExitOnError),
}
+4 -2
View File
@@ -66,9 +66,11 @@ func makeCmdPublishSourceUpdate() *commander.Command {
cmd := &commander.Command{
Run: aptlyPublishSourceUpdate,
UsageLine: "update <distribution> <source>",
Short: "update source in staged source list of published repository",
Short: "update the source components of a published repository",
Long: `
The command updates sources in the staged source list of the published repository.
The command updates the source components of a snapshot or local repository to be published.
This does not publish the changes directly, but rather schedules them for a subsequent 'aptly publish update'.
The flag -component is mandatory. Use a comma-separated list of components, if
multiple components should be modified. The number of given components must be
+13 -7
View File
@@ -93,15 +93,21 @@ func makeCmdPublishUpdate() *commander.Command {
cmd := &commander.Command{
Run: aptlyPublishUpdate,
UsageLine: "update <distribution> [[<endpoint>:]<prefix>]",
Short: "update published local repository",
Short: "update published repository",
Long: `
Command re-publishes (updates) published local repository. <distribution>
and <prefix> should be occupied with local repository published
using command aptly publish repo. Update happens in-place with
minimum possible downtime for published repository.
The command updates updates a published repository after applying pending changes to the sources.
For multiple component published repositories, all local repositories
are updated.
For published local repositories:
* update to match local repository contents
For published snapshots:
* switch components to new snapshot
The update happens in-place with minimum possible downtime for published repository.
For multiple component published repositories, all local repositories are updated.
Example: