wiki

package
v0.0.0-...-dfb7f3b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 18, 2022 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateUploadTokenReq

type CreateUploadTokenReq struct {
	Action        string `json:"Action"`        // CreateUploadToken
	Authorization string `json:"Authorization"` // 8c044154bd5c7cadb5720944c733b018d0984b3
	FileName      string `json:"FileName"`      // filename.zip
	ProjectName   string `json:"ProjectName"`   // demo-project
	Time          int64  `json:"Time"`          // 1.605247760074e+12
}

type CreateUploadTokenResp

type CreateUploadTokenResp struct {
	Response struct {
		RequestID int64 `json:"RequestId,string"` // 1
		Token     struct {
			AuthToken  string `json:"authToken"`   // 5b3848e2dfa921e183a071df84aa513d2018031b4df6786dfa7a214a9db855b1
			Provider   string `json:"provider"`    // TENCENT
			SecretID   string `json:"secretId"`    // AKIDOeYe7WatwJ5Hr4-wIW25kxH007lVmjK
			SecretKey  string `json:"secretKey"`   // ggBkOApOtx8p0cw+dhfo8nU31oj7xX39gkpl
			Time       int64  `json:"time,string"` // 1605247760074
			UpToken    string `json:"upToken"`     // bBoXiOuPiCeuXaeiyxAOK2qfsbSJJv5a393b958ff8094b
			UploadLink string `json:"uploadLink"`  // https://coding-net-production-file-1257242599.cos.ap-shanghai.myqcloud.com
		} `json:"Token"`
	} `json:"Response"`
}

type CreateWikiByZipReq

type CreateWikiByZipReq struct {
	Action        string `json:"Action"`        // CreateWikiByZip
	AuthToken     string `json:"AuthToken"`     // 5b3848e2dfa921e183a071df84aa513d2018031b4df6786dfa7a214a9db855b1
	Authorization string `json:"Authorization"` // 8c044154bd5c7cadb5720944c733b018d0984b3
	FileName      string `json:"FileName"`      // filename.zip
	Key           string `json:"Key"`           // 9fc310d0-3837-11eb-bca5-bd71c937c060.zip
	ParentIid     int64  `json:"ParentIid"`     // 0
	ProjectName   string `json:"ProjectName"`   // demo-project
	Time          int64  `json:"Time"`          // 1.605247760074e+12
}

type CreateWikiByZipResp

type CreateWikiByZipResp struct {
	Response struct {
		JobID     string `json:"JobId"`            // 5b3848e2dfa921e183a07
		RequestID int64  `json:"RequestId,string"` // 1
	} `json:"Response"`
}

type CreateWikiReq

type CreateWikiReq struct {
	Action        string `json:"Action"`        // CreateWiki
	Authorization string `json:"Authorization"` // 8c044154bd5c7cadb5720944c733b018d0984b3
	Content       string `json:"Content"`       // 内容
	Msg           string `json:"Msg"`           // 提交说明
	ParentIid     int64  `json:"ParentIid"`     // 0
	ProjectName   string `json:"ProjectName"`   // demo-project
	Title         string `json:"Title"`         // Title
}

type CreateWikiResp

type CreateWikiResp struct {
	Response struct {
		Data struct {
			CanMaintain bool   `json:"CanMaintain"` // true
			CanRead     bool   `json:"CanRead"`     // true
			Content     string `json:"Content"`     // WIKI
			CreatedAt   string `json:"CreatedAt"`   // 2020-09-22 00:00:00
			Creator     struct {
				Avatar        string `json:"Avatar"`        // https://dn-coding-net-production-static.codehub.cn/512b2a62-956b-4ef8-8e84-b3c66e71468f.png?imageMogr2/auto-orient/format/png/crop/!300x300a0a0
				Email         string `json:"Email"`         // coding.com
				GlobalKey     string `json:"GlobalKey"`     // coding
				ID            int64  `json:"Id"`            // 1
				Name          string `json:"Name"`          // coding
				Phone         int64  `json:"Phone,string"`  // 133131313
				Status        int64  `json:"Status"`        // 1
				TeamGlobalKey string `json:"TeamGlobalKey"` // coding
				TeamID        int64  `json:"TeamId"`        // 1
			} `json:"Creator"`
			CurrentVersion int64 `json:"CurrentVersion"` // 1
			Editor         struct {
				Avatar        string `json:"Avatar"`        // https://dn-coding-net-production-static.codehub.cn/512b2a62-956b-4ef8-8e84-b3c66e71468f.png?imageMogr2/auto-orient/format/png/crop/!300x300a0a0
				Email         string `json:"Email"`         // coding.com
				GlobalKey     string `json:"GlobalKey"`     // coding
				ID            int64  `json:"Id"`            // 1
				Name          string `json:"Name"`          // coding
				Phone         int64  `json:"Phone,string"`  // 133131313
				Status        int64  `json:"Status"`        // 1
				TeamGlobalKey string `json:"TeamGlobalKey"` // coding
				TeamID        int64  `json:"TeamId"`        // 1
			} `json:"Editor"`
			HistoriesCount     int64  `json:"HistoriesCount"`     // 1
			HistoryID          int64  `json:"HistoryId"`          // 13
			Html               string `json:"Html"`               // WIKI
			ID                 int64  `json:"Id"`                 // 10
			Iid                int64  `json:"Iid"`                // 10
			LastVersion        int64  `json:"LastVersion"`        // 1
			Msg                string `json:"Msg"`                // TEST
			Order              int64  `json:"Order"`              // 0
			ParentIid          int64  `json:"ParentIid"`          // 7
			ParentShared       bool   `json:"ParentShared"`       // true
			ParentVisibleRange string `json:"ParentVisibleRange"` // PUBLIC
			Path               int64  `json:"Path,string"`        // 2091
			Title              string `json:"Title"`              // WIKI-TEST
			UpdatedAt          string `json:"UpdatedAt"`          // 2020-09-22 00:00:00
			VisibleRange       string `json:"VisibleRange"`       // INHERIT
		} `json:"Data"`
		RequestID int64 `json:"RequestId,string"` // 1111111111
	} `json:"Response"`
}

type DeleteWikiReq

type DeleteWikiReq struct {
	Action        string `json:"Action"`        // DeleteWiki
	Authorization string `json:"Authorization"` // 8c044154bd5c7cadb5720944c733b018d0984b3
	Iid           int64  `json:"Iid"`           // 1
	ProjectName   string `json:"ProjectName"`   // demo-project
}

type DeleteWikiResp

type DeleteWikiResp struct {
	Response struct {
		RequestID int64 `json:"RequestId,string"` // 1
	} `json:"Response"`
}

type DescribeImportJobStatusReq

type DescribeImportJobStatusReq struct {
	Action        string `json:"Action"`        // DescribeImportJobStatus
	Authorization string `json:"Authorization"` // 8c044154bd5c7cadb5720944c733b018d0984b3
	JobID         string `json:"JobId"`         // asdaqweqsdaddsdsadsa
	ProjectName   string `json:"ProjectName"`   // demo-project
}

type DescribeImportJobStatusResp

type DescribeImportJobStatusResp struct {
	Response struct {
		JobID     string `json:"JobId"`            // 5b3848e2dfa921e183a071df84aa
		RequestID int64  `json:"RequestId,string"` // 1
		Status    string `json:"Status"`           // WAIT_PROCESS
	} `json:"Response"`
}

type DescribeUpdateJobStatusReq

type DescribeUpdateJobStatusReq struct {
	Action        string `json:"Action"`        // DescribeUpdateJobStatus
	Authorization string `json:"Authorization"` // 8c044154bd5c7cadb5720944c733b018d0984b3
	JobID         string `json:"JobId"`         // asdaqweqsdaddsdsadsa
	ProjectName   string `json:"ProjectName"`   // demo-project
}

type DescribeUpdateJobStatusResp

type DescribeUpdateJobStatusResp struct {
	Response struct {
		JobID     string `json:"JobId"`            // 5b3848e2dfa921e183a071df84aa
		RequestID int64  `json:"RequestId,string"` // 1
		Status    string `json:"Status"`           // WAIT_PROCESS
	} `json:"Response"`
}

type DescribeWikiListReq

type DescribeWikiListReq struct {
	Action        string `json:"Action"`        // DescribeWikiList
	Authorization string `json:"Authorization"` // 8c044154bd5c7cadb5720944c733b018d0984b3
	ProjectName   string `json:"ProjectName"`   // demo-project
}

type DescribeWikiListResp

type DescribeWikiListResp struct {
	Response struct {
		RequestID int64 `json:"RequestId,string"` // 1
		Data      []struct {
			ID          int64 `json:"id"`          // 359411
			CanMaintain bool  `json:"canMaintain"` // false
			CanRead     bool  `json:"canRead"`     // false
			Children    []struct {
				ID          int64 `json:"id"`          // 359413
				CanMaintain bool  `json:"canMaintain"` // true
				CanRead     bool  `json:"canRead"`     // false
				Children    []struct {
					ID          int64         `json:"id"`          // 359414
					CanMaintain bool          `json:"canMaintain"` // true
					CanRead     bool          `json:"canRead"`     // false
					Children    []interface{} `json:"children"`    // <nil>
					CreatedAt   int64         `json:"createdAt"`   // 1.578036875e+12
					Creator     struct {
						ID        int64  `json:"id"`        // 38981
						Avatar    string `json:"avatar"`    // https://dn-coding-net-production-static.codehub.cn/d466b293-5637-48e7-b485-e979d125d7a6.jpg?imageMogr2/auto-orient/format/jpeg/crop/!639x639a0a0
						Email     string `json:"email"`     // wangjiajun@coding.net
						GlobalKey string `json:"globalKey"` // wangjiajun
						Name      string `json:"name"`      // 王佳骏
						Status    int64  `json:"status"`    // 1
					} `json:"creator"`
					Editor struct {
						ID        int64  `json:"id"`        // 39018
						Avatar    string `json:"avatar"`    // https://dn-coding-net-production-static.codehub.cn/86e98800-d835-41d8-8142-b7fca0550bf7.jpg?imageMogr2/auto-orient/format/jpeg/crop/!410x410a0a0
						Email     string `json:"email"`     // caiyuezhang@coding.net
						GlobalKey string `json:"globalKey"` // caiyuezhang
						Name      string `json:"name"`      // 蔡悦彰
						Status    int64  `json:"status"`    // 1
					} `json:"editor"`
					Iid          int64  `json:"iid"`          // 26
					IsShared     bool   `json:"isShared"`     // false
					IsTreeShared bool   `json:"isTreeShared"` // false
					Order        int64  `json:"order"`        // 1
					ParentIid    int64  `json:"parentIid"`    // 25
					Title        string `json:"title"`        // Wiki 产品
					UpdatedAt    int64  `json:"updatedAt"`    // 1.586787643e+12
					VisibleRange string `json:"visibleRange"` // INHERIT
				} `json:"children"`
				CreatedAt int64 `json:"createdAt"` // 1.578036875e+12
				Creator   struct {
					ID        int64  `json:"id"`        // 38981
					Avatar    string `json:"avatar"`    // https://dn-coding-net-production-static.codehub.cn/d466b293-5637-48e7-b485-e979d125d7a6.jpg?imageMogr2/auto-orient/format/jpeg/crop/!639x639a0a0
					Email     string `json:"email"`     // wangjiajun@coding.net
					GlobalKey string `json:"globalKey"` // wangjiajun
					Name      string `json:"name"`      // 王佳骏
					Status    int64  `json:"status"`    // 1
				} `json:"creator"`
				Editor struct {
					ID        int64  `json:"id"`        // 39018
					Avatar    string `json:"avatar"`    // https://dn-coding-net-production-static.codehub.cn/86e98800-d835-41d8-8142-b7fca0550bf7.jpg?imageMogr2/auto-orient/format/jpeg/crop/!410x410a0a0
					Email     string `json:"email"`     // caiyuezhang@coding.net
					GlobalKey string `json:"globalKey"` // caiyuezhang
					Name      string `json:"name"`      // 蔡悦彰
					Status    int64  `json:"status"`    // 1
				} `json:"editor"`
				Iid          int64  `json:"iid"`          // 25
				IsShared     bool   `json:"isShared"`     // false
				IsTreeShared bool   `json:"isTreeShared"` // false
				Order        int64  `json:"order"`        // 1
				ParentIid    int64  `json:"parentIid"`    // 24
				Title        string `json:"title"`        // 产品文档
				UpdatedAt    int64  `json:"updatedAt"`    // 1.586787643e+12
				VisibleRange string `json:"visibleRange"` // READ_ONLY
			} `json:"children"`
			Iid          int64       `json:"iid"`          // 24
			IsShared     bool        `json:"isShared"`     // false
			IsTreeShared bool        `json:"isTreeShared"` // true
			Order        int64       `json:"order"`        // 1
			ParentIid    int64       `json:"parentIid"`    // 0
			Title        interface{} `json:"title"`        // <nil>
			VisibleRange string      `json:"visibleRange"` // HIDDEN
		} `json:"data"`
	} `json:"Response"`
}

type DescribeWikiReq

type DescribeWikiReq struct {
	Action      string `json:"Action"`      // DescribeWiki
	Iid         int64  `json:"Iid"`         // 7
	ProjectName string `json:"ProjectName"` // demo-project
	VersionID   int64  `json:"VersionId"`   // 1
}

type DescribeWikiResp

type DescribeWikiResp struct {
	Response struct {
		RequestID int64 `json:"RequestId,string"` // 1
		Data      struct {
			ID        int64  `json:"id"`        // 10
			Content   string `json:"content"`   //
			CreatedAt int64  `json:"createdAt"` // 1.578378234037e+12
			Creator   struct {
				ID        int64  `json:"id"`         // 1
				Avatar    string `json:"avatar"`     // https://dn-coding-net-production-static.codehub.cn/512b2a62-956b-4ef8-8e84-b3c66e71468f.png?imageMogr2/auto-orient/format/png/crop/!300x300a0a0
				Email     string `json:"email"`      // 1111@coding.com
				GlobalKey string `json:"global_key"` // coding
				Name      string `json:"name"`       // coding
				Phone     int64  `json:"phone"`      // 0
				Status    int64  `json:"status"`     // 1
				TeamID    int64  `json:"teamId"`     // 0
			} `json:"creator"`
			CurrentUserRoleID int64 `json:"currentUserRoleId"` // 100
			CurrentVersion    int64 `json:"currentVersion"`    // 1
			Editor            struct {
				ID        int64  `json:"id"`         // 1
				Avatar    string `json:"avatar"`     // https://dn-coding-net-production-static.codehub.cn/512b2a62-956b-4ef8-8e84-b3c66e71468f.png?imageMogr2/auto-orient/format/png/crop/!300x300a0a0
				Email     string `json:"email"`      // 1111@coding.com
				GlobalKey string `json:"global_key"` // coding
				Name      string `json:"name"`       // coding
				Phone     int64  `json:"phone"`      // 0
				Status    int64  `json:"status"`     // 1
				TeamID    int64  `json:"teamId"`     // 0
			} `json:"editor"`
			HistoriesCount int64  `json:"historiesCount"` // 1
			HistoryID      int64  `json:"historyId"`      // 13
			Html           string `json:"html"`           //
			Iid            int64  `json:"iid"`            // 10
			LastVersion    int64  `json:"lastVersion"`    // 1
			Msg            string `json:"msg"`            //
			Order          int64  `json:"order"`          // 3
			ParentIid      int64  `json:"parentIid"`      // 7
			Path           string `json:"path"`           // 1/2/7/10
			Reminded       bool   `json:"reminded"`       // false
			Title          string `json:"title"`          // 不卡了
			UpdatedAt      int64  `json:"updatedAt"`      // 1.578378234041e+12
		} `json:"data"`
	} `json:"Response"`
}

type ModifyWikiByZipReq

type ModifyWikiByZipReq struct {
	Action        string `json:"Action"`        // ModifyWikiByZip
	AuthToken     string `json:"AuthToken"`     // 5b3848e2dfa921e183a071df84aa513d2018031b4df6786dfa7a214a9db855b1
	Authorization string `json:"Authorization"` // 8c044154bd5c7cadb5720944c733b018d0984b3
	FileName      string `json:"FileName"`      // filename.zip
	Iid           int64  `json:"Iid"`           // 11
	Key           string `json:"Key"`           // 9fc310d0-3837-11eb-bca5-bd71c937c060.zip
	ProjectName   string `json:"ProjectName"`   // demo-project
	Time          int64  `json:"Time"`          // 1.605247760074e+12
}

type ModifyWikiByZipResp

type ModifyWikiByZipResp struct {
	Response struct {
		JobID     string `json:"JobId"`            // 5b3848e2dfa921e183a071df84aa
		RequestID int64  `json:"RequestId,string"` // 1
	} `json:"Response"`
}

type ModifyWikiOrderReq

type ModifyWikiOrderReq struct {
	Action        string `json:"Action"`        // ModifyWikiOrder
	Authorization string `json:"Authorization"` // 8c044154bd5c7cadb5720944c733b018d0984b3
	Iid           int64  `json:"Iid"`           // 1
	ProjectName   string `json:"ProjectName"`   // demo-project
}

type ModifyWikiOrderResp

type ModifyWikiOrderResp struct {
	Response struct {
		RequestID int64 `json:"RequestId,string"` // 1
	} `json:"Response"`
}

type ModifyWikiReq

type ModifyWikiReq struct {
	Action        string `json:"Action"`        // ModifyWiki
	Authorization string `json:"Authorization"` // 8c044154bd5c7cadb5720944c733b018d0984b3
	Content       string `json:"Content"`       // 内容
	Iid           int64  `json:"Iid"`           // 1
	Msg           string `json:"Msg"`           // 提交说明
	ProjectName   string `json:"ProjectName"`   // demo-project
	Title         string `json:"Title"`         // Title
}

type ModifyWikiResp

type ModifyWikiResp struct {
	Response struct {
		Data struct {
			CanMaintain bool   `json:"CanMaintain"` // true
			CanRead     bool   `json:"CanRead"`     // true
			Content     string `json:"Content"`     // WIKI
			CreatedAt   string `json:"CreatedAt"`   // 2020-09-22 00:00:00
			Creator     struct {
				Avatar        string `json:"Avatar"`        // https://dn-coding-net-production-static.codehub.cn/512b2a62-956b-4ef8-8e84-b3c66e71468f.png?imageMogr2/auto-orient/format/png/crop/!300x300a0a0
				Email         string `json:"Email"`         // coding.com
				GlobalKey     string `json:"GlobalKey"`     // coding
				ID            int64  `json:"Id"`            // 1
				Name          string `json:"Name"`          // coding
				Phone         int64  `json:"Phone,string"`  // 133131313
				Status        int64  `json:"Status"`        // 1
				TeamGlobalKey string `json:"TeamGlobalKey"` // coding
				TeamID        int64  `json:"TeamId"`        // 1
			} `json:"Creator"`
			CurrentVersion int64 `json:"CurrentVersion"` // 1
			Editor         struct {
				Avatar        string `json:"Avatar"`        // https://dn-coding-net-production-static.codehub.cn/512b2a62-956b-4ef8-8e84-b3c66e71468f.png?imageMogr2/auto-orient/format/png/crop/!300x300a0a0
				Email         string `json:"Email"`         // coding.com
				GlobalKey     string `json:"GlobalKey"`     // coding
				ID            int64  `json:"Id"`            // 1
				Name          string `json:"Name"`          // coding
				Phone         int64  `json:"Phone,string"`  // 133131313
				Status        int64  `json:"Status"`        // 1
				TeamGlobalKey string `json:"TeamGlobalKey"` // coding
				TeamID        int64  `json:"TeamId"`        // 1
			} `json:"Editor"`
			HistoriesCount     int64  `json:"HistoriesCount"`     // 1
			HistoryID          int64  `json:"HistoryId"`          // 13
			Html               string `json:"Html"`               // WIKI
			ID                 int64  `json:"Id"`                 // 10
			Iid                int64  `json:"Iid"`                // 10
			LastVersion        int64  `json:"LastVersion"`        // 1
			Msg                string `json:"Msg"`                // TEST
			Order              int64  `json:"Order"`              // 0
			ParentIid          int64  `json:"ParentIid"`          // 7
			ParentShared       bool   `json:"ParentShared"`       // true
			ParentVisibleRange string `json:"ParentVisibleRange"` // PUBLIC
			Path               int64  `json:"Path,string"`        // 2091
			Title              string `json:"Title"`              // WIKI-TEST
			UpdatedAt          string `json:"UpdatedAt"`          // 2020-09-22 00:00:00
			VisibleRange       string `json:"VisibleRange"`       // INHERIT
		} `json:"Data"`
		RequestID int64 `json:"RequestId,string"` // 1111111111
	} `json:"Response"`
}

type Wiki

type Wiki struct {
	// contains filtered or unexported fields
}

func New

func New(c *config.Basic) Wiki

New 新建文档管理相关函数

func (*Wiki) CreateUploadToken

func (w *Wiki) CreateUploadToken(req *CreateUploadTokenReq) (resp CreateUploadTokenResp, err error)

CreateUploadToken 获取上传文件的 Token

func (*Wiki) CreateWiki

func (w *Wiki) CreateWiki(req *CreateWikiReq) (resp CreateWikiResp, err error)

CreateWiki 创建 Wiki

func (*Wiki) CreateWikiByZip

func (w *Wiki) CreateWikiByZip(req *CreateWikiByZipReq) (resp CreateWikiByZipResp, err error)

CreateWikiByZip 通过 ZIP 包上传

func (*Wiki) DeleteWiki

func (w *Wiki) DeleteWiki(req *DeleteWikiReq) (resp DeleteWikiResp, err error)

DeleteWiki 删除 Wiki

func (*Wiki) DescribeImportJobStatus

func (w *Wiki) DescribeImportJobStatus(req *DescribeImportJobStatusReq) (resp DescribeImportJobStatusResp, err error)

DescribeImportJobStatus 任务状态查询

func (*Wiki) DescribeUpdateJobStatus

func (w *Wiki) DescribeUpdateJobStatus(req *DescribeUpdateJobStatusReq) (resp DescribeUpdateJobStatusResp, err error)

DescribeUpdateJobStatus 通过 ZIP 包更新任务状态查询

func (*Wiki) DescribeWiki

func (w *Wiki) DescribeWiki(req *DescribeWikiReq) (resp DescribeWikiResp, err error)

DescribeWiki 获取详情

func (*Wiki) DescribeWikiList

func (w *Wiki) DescribeWikiList(req *DescribeWikiListReq) (resp DescribeWikiListResp, err error)

DescribeWikiList 获取列表详情

func (*Wiki) ModifyWiki

func (w *Wiki) ModifyWiki(req *ModifyWikiReq) (resp ModifyWikiResp, err error)

ModifyWiki 更新 Wiki

func (*Wiki) ModifyWikiByZip

func (w *Wiki) ModifyWikiByZip(req *ModifyWikiByZipReq) (resp ModifyWikiByZipResp, err error)

ModifyWikiByZip 通过 ZIP 包更新 Wiki

func (*Wiki) ModifyWikiOrder

func (w *Wiki) ModifyWikiOrder(req *ModifyWikiOrderReq) (resp ModifyWikiOrderResp, err error)

ModifyWikiOrder 修改父级顺序

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL