Skip to content

Commit

Permalink
📝 Added the Service documentation
Browse files Browse the repository at this point in the history
1. Added the method documentation on the Space Content Archive .

2. Added the service documentation on the LongTaskService
  • Loading branch information
ctreminiom committed Mar 8, 2022
1 parent 9d2ca5f commit a729452
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions confluence/content.go
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@ func (c *ContentService) History(ctx context.Context, contentID string, expand [
// Archive archives a list of pages. The pages to be archived are specified as a list of content IDs.
// This API accepts the archival request and returns a task ID. The archival process happens asynchronously.
// Use the /longtask/ REST API to get the copy task status.
// Docs: https://docs.go-atlassian.io/confluence-cloud/content#archive-pages
func (c *ContentService) Archive(ctx context.Context, payload *model.ContentArchivePayloadScheme) (result *model.ContentArchiveResultScheme, response *ResponseScheme, err error) {

payloadAsReader, err := transformStructToReader(payload)
Expand Down
2 changes: 2 additions & 0 deletions confluence/longTask.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ type LongTaskService struct{ client *Client }

// Gets returns information about all active long-running tasks (e.g. space export),
// such as how long each task has been running and the percentage of each task that has completed.
// Docs: https://docs.go-atlassian.io/confluence-cloud/long-task#get-long-running-tasks
func (l *LongTaskService) Gets(ctx context.Context, start, limit int) (result *models.LongTaskPageScheme,
response *ResponseScheme, err error) {

Expand All @@ -39,6 +40,7 @@ func (l *LongTaskService) Gets(ctx context.Context, start, limit int) (result *m

// Get returns information about an active long-running task (e.g. space export), such as how long it has been running
//and the percentage of the task that has completed.
// Docs: https://docs.go-atlassian.io/confluence-cloud/long-task#get-long-running-task
func (l *LongTaskService) Get(ctx context.Context, taskID string) (result *models.LongTaskScheme, response *ResponseScheme,
err error) {

Expand Down

0 comments on commit a729452

Please sign in to comment.