wiki

package
v1.0.0-b5 Latest Latest
Warning

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

 Go to latest Published: Aug 23, 2020 License: MIT Imports: 10 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ResourceAreaId, _ = uuid.Parse("bf7d82a0-8aa5-4613-94ef-6172a5ea01f3")
View Source 
var WikiTypeValues = wikiTypeValuesType{

	ProjectWiki: "projectWiki",

	CodeWiki: "codeWiki",
}

Functions

This section is empty.

Types

type Client 

type Client interface {
	// Creates an attachment in the wiki.
	CreateAttachment(context.Context, CreateAttachmentArgs) (*WikiAttachmentResponse, error)
	// Creates or edits a wiki page.
	CreateOrUpdatePage(context.Context, CreateOrUpdatePageArgs) (*WikiPageResponse, error)
	// Creates a page move operation that updates the path and order of the page as provided in the parameters.
	CreatePageMove(context.Context, CreatePageMoveArgs) (*WikiPageMoveResponse, error)
	// Creates the wiki resource.
	CreateWiki(context.Context, CreateWikiArgs) (*WikiV2, error)
	// Deletes a wiki page.
	DeletePage(context.Context, DeletePageArgs) (*WikiPageResponse, error)
	// [Preview API] Deletes a wiki page.
	DeletePageById(context.Context, DeletePageByIdArgs) (*WikiPageResponse, error)
	// Deletes the wiki corresponding to the wiki name or Id provided.
	DeleteWiki(context.Context, DeleteWikiArgs) (*WikiV2, error)
	// Gets all wikis in a project or collection.
	GetAllWikis(context.Context, GetAllWikisArgs) (*[]WikiV2, error)
	// Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the `Accept` header sent in the request.
	GetPage(context.Context, GetPageArgs) (*WikiPageResponse, error)
	// [Preview API] Gets metadata or content of the wiki page for the provided page id. Content negotiation is done based on the `Accept` header sent in the request.
	GetPageById(context.Context, GetPageByIdArgs) (*WikiPageResponse, error)
	// [Preview API] Gets metadata or content of the wiki page for the provided page id. Content negotiation is done based on the `Accept` header sent in the request.
	GetPageByIdText(context.Context, GetPageByIdTextArgs) (io.ReadCloser, error)
	// [Preview API] Gets metadata or content of the wiki page for the provided page id. Content negotiation is done based on the `Accept` header sent in the request.
	GetPageByIdZip(context.Context, GetPageByIdZipArgs) (io.ReadCloser, error)
	// Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the `Accept` header sent in the request.
	GetPageText(context.Context, GetPageTextArgs) (io.ReadCloser, error)
	// Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the `Accept` header sent in the request.
	GetPageZip(context.Context, GetPageZipArgs) (io.ReadCloser, error)
	// Gets the wiki corresponding to the wiki name or Id provided.
	GetWiki(context.Context, GetWikiArgs) (*WikiV2, error)
	// [Preview API] Edits a wiki page.
	UpdatePageById(context.Context, UpdatePageByIdArgs) (*WikiPageResponse, error)
	// Updates the wiki corresponding to the wiki Id or name provided using the update parameters.
	UpdateWiki(context.Context, UpdateWikiArgs) (*WikiV2, error)
}

func NewClient 

func NewClient(ctx context.Context, connection *azuredevops.Connection) (Client, error)

type ClientImpl 

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) CreateAttachment 

func (client *ClientImpl) CreateAttachment(ctx context.Context, args CreateAttachmentArgs) (*WikiAttachmentResponse, error)

Creates an attachment in the wiki.

func (*ClientImpl) CreateOrUpdatePage 

func (client *ClientImpl) CreateOrUpdatePage(ctx context.Context, args CreateOrUpdatePageArgs) (*WikiPageResponse, error)

Creates or edits a wiki page.

func (*ClientImpl) CreatePageMove 

func (client *ClientImpl) CreatePageMove(ctx context.Context, args CreatePageMoveArgs) (*WikiPageMoveResponse, error)

Creates a page move operation that updates the path and order of the page as provided in the parameters.

func (*ClientImpl) CreateWiki 

func (client *ClientImpl) CreateWiki(ctx context.Context, args CreateWikiArgs) (*WikiV2, error)

Creates the wiki resource.

func (*ClientImpl) DeletePage 

func (client *ClientImpl) DeletePage(ctx context.Context, args DeletePageArgs) (*WikiPageResponse, error)

Deletes a wiki page.

func (*ClientImpl) DeletePageById 

func (client *ClientImpl) DeletePageById(ctx context.Context, args DeletePageByIdArgs) (*WikiPageResponse, error)

[Preview API] Deletes a wiki page.

func (*ClientImpl) DeleteWiki 

func (client *ClientImpl) DeleteWiki(ctx context.Context, args DeleteWikiArgs) (*WikiV2, error)

Deletes the wiki corresponding to the wiki name or Id provided.

func (*ClientImpl) GetAllWikis 

func (client *ClientImpl) GetAllWikis(ctx context.Context, args GetAllWikisArgs) (*[]WikiV2, error)

Gets all wikis in a project or collection.

func (*ClientImpl) GetPage 

func (client *ClientImpl) GetPage(ctx context.Context, args GetPageArgs) (*WikiPageResponse, error)

Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the `Accept` header sent in the request.

func (*ClientImpl) GetPageById 

func (client *ClientImpl) GetPageById(ctx context.Context, args GetPageByIdArgs) (*WikiPageResponse, error)

[Preview API] Gets metadata or content of the wiki page for the provided page id. Content negotiation is done based on the `Accept` header sent in the request.

func (*ClientImpl) GetPageByIdText 

func (client *ClientImpl) GetPageByIdText(ctx context.Context, args GetPageByIdTextArgs) (io.ReadCloser, error)

[Preview API] Gets metadata or content of the wiki page for the provided page id. Content negotiation is done based on the `Accept` header sent in the request.

func (*ClientImpl) GetPageByIdZip 

func (client *ClientImpl) GetPageByIdZip(ctx context.Context, args GetPageByIdZipArgs) (io.ReadCloser, error)

[Preview API] Gets metadata or content of the wiki page for the provided page id. Content negotiation is done based on the `Accept` header sent in the request.

func (*ClientImpl) GetPageText 

func (client *ClientImpl) GetPageText(ctx context.Context, args GetPageTextArgs) (io.ReadCloser, error)

Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the `Accept` header sent in the request.

func (*ClientImpl) GetPageZip 

func (client *ClientImpl) GetPageZip(ctx context.Context, args GetPageZipArgs) (io.ReadCloser, error)

Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the `Accept` header sent in the request.

func (*ClientImpl) GetWiki 

func (client *ClientImpl) GetWiki(ctx context.Context, args GetWikiArgs) (*WikiV2, error)

Gets the wiki corresponding to the wiki name or Id provided.

func (*ClientImpl) UpdatePageById 

func (client *ClientImpl) UpdatePageById(ctx context.Context, args UpdatePageByIdArgs) (*WikiPageResponse, error)

[Preview API] Edits a wiki page.

func (*ClientImpl) UpdateWiki 

func (client *ClientImpl) UpdateWiki(ctx context.Context, args UpdateWikiArgs) (*WikiV2, error)

Updates the wiki corresponding to the wiki Id or name provided using the update parameters.

type CreateAttachmentArgs 

type CreateAttachmentArgs struct {
	// (required) Stream to upload
	UploadStream io.Reader
	// (required) Project ID or project name
	Project *string
	// (required) Wiki Id or name.
	WikiIdentifier *string
	// (required) Wiki attachment name.
	Name *string
	// (optional) GitVersionDescriptor for the page. (Optional in case of ProjectWiki).
	VersionDescriptor *git.GitVersionDescriptor
}

Arguments for the CreateAttachment function

type CreateOrUpdatePageArgs 

type CreateOrUpdatePageArgs struct {
	// (required) Wiki create or update operation parameters.
	Parameters *WikiPageCreateOrUpdateParameters
	// (required) Project ID or project name
	Project *string
	// (required) Wiki Id or name.
	WikiIdentifier *string
	// (required) Wiki page path.
	Path *string
	// (required) Version of the page on which the change is to be made. Mandatory for `Edit` scenario. To be populated in the If-Match header of the request.
	Version *string
	// (optional) Comment to be associated with the page operation.
	Comment *string
	// (optional) GitVersionDescriptor for the page. (Optional in case of ProjectWiki).
	VersionDescriptor *git.GitVersionDescriptor
}

Arguments for the CreateOrUpdatePage function

type CreatePageMoveArgs 

type CreatePageMoveArgs struct {
	// (required) Page more operation parameters.
	PageMoveParameters *WikiPageMoveParameters
	// (required) Project ID or project name
	Project *string
	// (required) Wiki Id or name.
	WikiIdentifier *string
	// (optional) Comment that is to be associated with this page move.
	Comment *string
	// (optional) GitVersionDescriptor for the page. (Optional in case of ProjectWiki).
	VersionDescriptor *git.GitVersionDescriptor
}

Arguments for the CreatePageMove function

type CreateWikiArgs 

type CreateWikiArgs struct {
	// (required) Parameters for the wiki creation.
	WikiCreateParams *WikiCreateParametersV2
	// (optional) Project ID or project name
	Project *string
}

Arguments for the CreateWiki function

type DeletePageArgs 

type DeletePageArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki Id or name.
	WikiIdentifier *string
	// (required) Wiki page path.
	Path *string
	// (optional) Comment to be associated with this page delete.
	Comment *string
	// (optional) GitVersionDescriptor for the page. (Optional in case of ProjectWiki).
	VersionDescriptor *git.GitVersionDescriptor
}

Arguments for the DeletePage function

type DeletePageByIdArgs 

type DeletePageByIdArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki Id or name.
	WikiIdentifier *string
	// (required) Wiki page id.
	Id *int
	// (optional) Comment to be associated with this page delete.
	Comment *string
}

Arguments for the DeletePageById function

type DeleteWikiArgs 

type DeleteWikiArgs struct {
	// (required) Wiki name or Id.
	WikiIdentifier *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the DeleteWiki function

type GetAllWikisArgs 

type GetAllWikisArgs struct {
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetAllWikis function

type GetPageArgs 

type GetPageArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki Id or name.
	WikiIdentifier *string
	// (optional) Wiki page path.
	Path *string
	// (optional) Recursion level for subpages retrieval. Defaults to `None` (Optional).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) GitVersionDescriptor for the page. Defaults to the default branch (Optional).
	VersionDescriptor *git.GitVersionDescriptor
	// (optional) True to include the content of the page in the response for Json content type. Defaults to false (Optional)
	IncludeContent *bool
}

Arguments for the GetPage function

type GetPageByIdArgs 

type GetPageByIdArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki Id or name.
	WikiIdentifier *string
	// (required) Wiki page id.
	Id *int
	// (optional) Recursion level for subpages retrieval. Defaults to `None` (Optional).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) True to include the content of the page in the response for Json content type. Defaults to false (Optional)
	IncludeContent *bool
}

Arguments for the GetPageById function

type GetPageByIdTextArgs 

type GetPageByIdTextArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki Id or name.
	WikiIdentifier *string
	// (required) Wiki page id.
	Id *int
	// (optional) Recursion level for subpages retrieval. Defaults to `None` (Optional).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) True to include the content of the page in the response for Json content type. Defaults to false (Optional)
	IncludeContent *bool
}

Arguments for the GetPageByIdText function

type GetPageByIdZipArgs 

type GetPageByIdZipArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki Id or name.
	WikiIdentifier *string
	// (required) Wiki page id.
	Id *int
	// (optional) Recursion level for subpages retrieval. Defaults to `None` (Optional).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) True to include the content of the page in the response for Json content type. Defaults to false (Optional)
	IncludeContent *bool
}

Arguments for the GetPageByIdZip function

type GetPageTextArgs 

type GetPageTextArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki Id or name.
	WikiIdentifier *string
	// (optional) Wiki page path.
	Path *string
	// (optional) Recursion level for subpages retrieval. Defaults to `None` (Optional).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) GitVersionDescriptor for the page. Defaults to the default branch (Optional).
	VersionDescriptor *git.GitVersionDescriptor
	// (optional) True to include the content of the page in the response for Json content type. Defaults to false (Optional)
	IncludeContent *bool
}

Arguments for the GetPageText function

type GetPageZipArgs 

type GetPageZipArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki Id or name.
	WikiIdentifier *string
	// (optional) Wiki page path.
	Path *string
	// (optional) Recursion level for subpages retrieval. Defaults to `None` (Optional).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) GitVersionDescriptor for the page. Defaults to the default branch (Optional).
	VersionDescriptor *git.GitVersionDescriptor
	// (optional) True to include the content of the page in the response for Json content type. Defaults to false (Optional)
	IncludeContent *bool
}

Arguments for the GetPageZip function

type GetWikiArgs 

type GetWikiArgs struct {
	// (required) Wiki name or id.
	WikiIdentifier *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetWiki function

type UpdatePageByIdArgs 

type UpdatePageByIdArgs struct {
	// (required) Wiki update operation parameters.
	Parameters *WikiPageCreateOrUpdateParameters
	// (required) Project ID or project name
	Project *string
	// (required) Wiki Id or name.
	WikiIdentifier *string
	// (required) Wiki page id.
	Id *int
	// (required) Version of the page on which the change is to be made. Mandatory for `Edit` scenario. To be populated in the If-Match header of the request.
	Version *string
	// (optional) Comment to be associated with the page operation.
	Comment *string
}

Arguments for the UpdatePageById function

type UpdateWikiArgs 

type UpdateWikiArgs struct {
	// (required) Update parameters.
	UpdateParameters *WikiUpdateParameters
	// (required) Wiki name or Id.
	WikiIdentifier *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the UpdateWiki function

type Wiki 

type Wiki struct {
	// Wiki name.
	Name *string `json:"name,omitempty"`
	// ID of the project in which the wiki is to be created.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// The head commit associated with the git repository backing up the wiki.
	HeadCommit *string `json:"headCommit,omitempty"`
	// The ID of the wiki which is same as the ID of the Git repository that it is backed by.
	Id *uuid.UUID `json:"id,omitempty"`
	// The git repository that backs up the wiki.
	Repository *git.GitRepository `json:"repository,omitempty"`
}

Defines a wiki repository which encapsulates the git repository backing the wiki.

type WikiAttachment 

type WikiAttachment struct {
	// Name of the wiki attachment file.
	Name *string `json:"name,omitempty"`
	// Path of the wiki attachment file.
	Path *string `json:"path,omitempty"`
}

Defines properties for wiki attachment file.

type WikiAttachmentResponse 

type WikiAttachmentResponse struct {
	// Defines properties for wiki attachment file.
	Attachment *WikiAttachment `json:"attachment,omitempty"`
	// Contains the list of ETag values from the response header of the attachments API call. The first item in the list contains the version of the wiki attachment.
	ETag *[]string `json:"eTag,omitempty"`
}

Response contract for the Wiki Attachments API

type WikiCreateBaseParameters 

type WikiCreateBaseParameters struct {
	// Folder path inside repository which is shown as Wiki. Not required for ProjectWiki type.
	MappedPath *string `json:"mappedPath,omitempty"`
	// Wiki name.
	Name *string `json:"name,omitempty"`
	// ID of the project in which the wiki is to be created.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// ID of the git repository that backs up the wiki. Not required for ProjectWiki type.
	RepositoryId *uuid.UUID `json:"repositoryId,omitempty"`
	// Type of the wiki.
	Type *WikiType `json:"type,omitempty"`
}

Base wiki creation parameters.

type WikiCreateParameters 

type WikiCreateParameters struct {
	// Wiki name.
	Name *string `json:"name,omitempty"`
	// ID of the project in which the wiki is to be created.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
}

Wiki creations parameters.

type WikiCreateParametersV2 

type WikiCreateParametersV2 struct {
	// Folder path inside repository which is shown as Wiki. Not required for ProjectWiki type.
	MappedPath *string `json:"mappedPath,omitempty"`
	// Wiki name.
	Name *string `json:"name,omitempty"`
	// ID of the project in which the wiki is to be created.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// ID of the git repository that backs up the wiki. Not required for ProjectWiki type.
	RepositoryId *uuid.UUID `json:"repositoryId,omitempty"`
	// Type of the wiki.
	Type *WikiType `json:"type,omitempty"`
	// Version of the wiki. Not required for ProjectWiki type.
	Version *git.GitVersionDescriptor `json:"version,omitempty"`
}

Wiki creation parameters.

type WikiPage 

type WikiPage struct {
	// Content of the wiki page.
	Content *string `json:"content,omitempty"`
	// Path of the git item corresponding to the wiki page stored in the backing Git repository.
	GitItemPath *string `json:"gitItemPath,omitempty"`
	// When present, permanent identifier for the wiki page
	Id *int `json:"id,omitempty"`
	// True if a page is non-conforming, i.e. 1) if the name doesn't match page naming standards. 2) if the page does not have a valid entry in the appropriate order file.
	IsNonConformant *bool `json:"isNonConformant,omitempty"`
	// True if this page has subpages under its path.
	IsParentPage *bool `json:"isParentPage,omitempty"`
	// Order of the wiki page, relative to other pages in the same hierarchy level.
	Order *int `json:"order,omitempty"`
	// Path of the wiki page.
	Path *string `json:"path,omitempty"`
	// Remote web url to the wiki page.
	RemoteUrl *string `json:"remoteUrl,omitempty"`
	// List of subpages of the current page.
	SubPages *[]WikiPage `json:"subPages,omitempty"`
	// REST url for this wiki page.
	Url *string `json:"url,omitempty"`
}

Defines a page in a wiki.

type WikiPageCreateOrUpdateParameters 

type WikiPageCreateOrUpdateParameters struct {
	// Content of the wiki page.
	Content *string `json:"content,omitempty"`
}

Contract encapsulating parameters for the page create or update operations.

type WikiPageMove 

type WikiPageMove struct {
	// New order of the wiki page.
	NewOrder *int `json:"newOrder,omitempty"`
	// New path of the wiki page.
	NewPath *string `json:"newPath,omitempty"`
	// Current path of the wiki page.
	Path *string `json:"path,omitempty"`
	// Resultant page of this page move operation.
	Page *WikiPage `json:"page,omitempty"`
}

Request contract for Wiki Page Move.

type WikiPageMoveParameters 

type WikiPageMoveParameters struct {
	// New order of the wiki page.
	NewOrder *int `json:"newOrder,omitempty"`
	// New path of the wiki page.
	NewPath *string `json:"newPath,omitempty"`
	// Current path of the wiki page.
	Path *string `json:"path,omitempty"`
}

Contract encapsulating parameters for the page move operation.

type WikiPageMoveResponse 

type WikiPageMoveResponse struct {
	// Contains the list of ETag values from the response header of the page move API call. The first item in the list contains the version of the wiki page subject to page move.
	ETag *[]string `json:"eTag,omitempty"`
	// Defines properties for wiki page move.
	PageMove *WikiPageMove `json:"pageMove,omitempty"`
}

Response contract for the Wiki Page Move API.

type WikiPageResponse 

type WikiPageResponse struct {
	// Contains the list of ETag values from the response header of the pages API call. The first item in the list contains the version of the wiki page.
	ETag *[]string `json:"eTag,omitempty"`
	// Defines properties for wiki page.
	Page *WikiPage `json:"page,omitempty"`
}

Response contract for the Wiki Pages PUT, PATCH and DELETE APIs.

type WikiPageViewStats 

type WikiPageViewStats struct {
	// Wiki page view count.
	Count *int `json:"count,omitempty"`
	// Wiki page last viewed time.
	LastViewedTime *azuredevops.Time `json:"lastViewedTime,omitempty"`
	// Wiki page path.
	Path *string `json:"path,omitempty"`
}

Defines properties for wiki page view stats.

type WikiType 

type WikiType string

Wiki types.

type WikiUpdateParameters 

type WikiUpdateParameters struct {
	// Name for wiki.
	Name *string `json:"name,omitempty"`
	// Versions of the wiki.
	Versions *[]git.GitVersionDescriptor `json:"versions,omitempty"`
}

Wiki update parameters.

type WikiUpdatedNotificationMessage 

type WikiUpdatedNotificationMessage struct {
	// Collection host Id for which the wikis are updated.
	CollectionId *uuid.UUID `json:"collectionId,omitempty"`
	// Project Id for which the wikis are updated.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// Repository Id associated with the particular wiki which is added, updated or deleted.
	RepositoryId *uuid.UUID `json:"repositoryId,omitempty"`
}

type WikiV2 

type WikiV2 struct {
	// Folder path inside repository which is shown as Wiki. Not required for ProjectWiki type.
	MappedPath *string `json:"mappedPath,omitempty"`
	// Wiki name.
	Name *string `json:"name,omitempty"`
	// ID of the project in which the wiki is to be created.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// ID of the git repository that backs up the wiki. Not required for ProjectWiki type.
	RepositoryId *uuid.UUID `json:"repositoryId,omitempty"`
	// Type of the wiki.
	Type *WikiType `json:"type,omitempty"`
	// ID of the wiki.
	Id *uuid.UUID `json:"id,omitempty"`
	// Properties of the wiki.
	Properties *map[string]string `json:"properties,omitempty"`
	// Remote web url to the wiki.
	RemoteUrl *string `json:"remoteUrl,omitempty"`
	// REST url for this wiki.
	Url *string `json:"url,omitempty"`
	// Versions of the wiki.
	Versions *[]git.GitVersionDescriptor `json:"versions,omitempty"`
}

Defines a wiki resource.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.