Package org.gitlab4j.api

Class MarkdownApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.MarkdownApi

All Implemented Interfaces:

Constants

public class MarkdownApi
extends AbstractApi

This class provides an entry point to all the GitLab API markdown calls.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.AutoDevopsDeployStrategy, Constants.BuildGitStrategy, Constants.CommitBuildState, Constants.ContributorOrderBy, Constants.DeploymentOrderBy, Constants.DeploymentStatus, Constants.DeployTokenScope, Constants.Encoding, Constants.EpicOrderBy, Constants.EventScope, Constants.GroupOrderBy, Constants.GroupSearchScope, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestSearchIn, Constants.MergeRequestState, Constants.MilestoneState, Constants.PackageOrderBy, Constants.PackageStatus, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, Constants.TagOrderBy, Constants.TargetType, Constants.TodoAction, Constants.TodoState, Constants.TodoType, Constants.TokenType

Field Summary

Fields inherited from class org.gitlab4j.api.AbstractApi

gitLabApi

Fields inherited from interface org.gitlab4j.api.Constants

NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

Constructor Summary

Constructors

Constructor	Description
MarkdownApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
Markdown	getMarkdown(String text)	Render an arbitrary Markdown document.
Markdown	getMarkdown(MarkdownRequest markdownRequest)	Render an arbitrary Markdown document.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getLabelIdOrName, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, patch, patch, post, post, post, post, post, put, put, put, putUpload, putUpload, putWithFormData, upload, upload, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MarkdownApi

public MarkdownApi(GitLabApi gitLabApi)

Method Details

getMarkdown

public Markdown getMarkdown(String text)
                     throws GitLabApiException

Render an arbitrary Markdown document.

GitLab Endpoint: POST /api/v4/markdown

Parameters:

text - text to be transformed

Returns:

a Markdown instance with transformed info

Throws:

GitLabApiException - if any exception occurs

Since:

GitLab 11.0

getMarkdown

public Markdown getMarkdown(MarkdownRequest markdownRequest)
                     throws GitLabApiException

Render an arbitrary Markdown document.

GitLab Endpoint: POST /api/v4/markdown

Parameters:

markdownRequest - a request of markdown transformation

Returns:

a Markdown instance with transformed info

Throws:

GitLabApiException - if any exception occurs

Since:

GitLab 11.0