markdown

Documentation

Index

• func CreateMarkdownPostRequestBodyFromDiscriminatorValue(...) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, ...)
• func ParseMarkdownPostRequestBody_mode(v string) (any, error)
• func SerializeMarkdownPostRequestBody_mode(values []MarkdownPostRequestBody_mode) []string
• type MarkdownPostRequestBody
  • func NewMarkdownPostRequestBody() *MarkdownPostRequestBody
  • func (m *MarkdownPostRequestBody) GetAdditionalData() map[string]any
  • func (m *MarkdownPostRequestBody) GetContext() *string
  • func (m *MarkdownPostRequestBody) GetFieldDeserializers() ...
  • func (m *MarkdownPostRequestBody) GetMode() *MarkdownPostRequestBody_mode
  • func (m *MarkdownPostRequestBody) GetText() *string
  • func (m *MarkdownPostRequestBody) Serialize(...) error
  • func (m *MarkdownPostRequestBody) SetAdditionalData(value map[string]any)
  • func (m *MarkdownPostRequestBody) SetContext(value *string)
  • func (m *MarkdownPostRequestBody) SetMode(value *MarkdownPostRequestBody_mode)
  • func (m *MarkdownPostRequestBody) SetText(value *string)
• type MarkdownPostRequestBody_mode
  • func (i MarkdownPostRequestBody_mode) String() string
• type MarkdownPostRequestBodyable
• type MarkdownRequestBuilder
  • func NewMarkdownRequestBuilder(rawUrl string, ...) *MarkdownRequestBuilder
  • func NewMarkdownRequestBuilderInternal(pathParameters map[string]string, ...) *MarkdownRequestBuilder
  • func (m *MarkdownRequestBuilder) Post(ctx context.Context, body MarkdownPostRequestBodyable, ...) error
  • func (m *MarkdownRequestBuilder) Raw() *RawRequestBuilder
  • func (m *MarkdownRequestBuilder) ToPostRequestInformation(ctx context.Context, body MarkdownPostRequestBodyable, ...) (...)
  • func (m *MarkdownRequestBuilder) WithUrl(rawUrl string) *MarkdownRequestBuilder
• type RawRequestBuilder
  • func NewRawRequestBuilder(rawUrl string, ...) *RawRequestBuilder
  • func NewRawRequestBuilderInternal(pathParameters map[string]string, ...) *RawRequestBuilder
  • func (m *RawRequestBuilder) Post(ctx context.Context, body *string, ...) error
  • func (m *RawRequestBuilder) ToPostRequestInformation(ctx context.Context, body *string, ...) (...)
  • func (m *RawRequestBuilder) WithUrl(rawUrl string) *RawRequestBuilder

Functions

func CreateMarkdownPostRequestBodyFromDiscriminatorValue

func CreateMarkdownPostRequestBodyFromDiscriminatorValue(parseNode i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, error)

CreateMarkdownPostRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func ParseMarkdownPostRequestBody_mode

func ParseMarkdownPostRequestBody_mode(v string) (any, error)

func SerializeMarkdownPostRequestBody_mode

func SerializeMarkdownPostRequestBody_mode(values []MarkdownPostRequestBody_mode) []string

Types

type MarkdownPostRequestBody

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

func NewMarkdownPostRequestBody

func NewMarkdownPostRequestBody() *MarkdownPostRequestBody

NewMarkdownPostRequestBody instantiates a new MarkdownPostRequestBody and sets the default values.

func (*MarkdownPostRequestBody) GetAdditionalData

func (m *MarkdownPostRequestBody) GetAdditionalData() map[string]any

GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful

func (*MarkdownPostRequestBody) GetContext

func (m *MarkdownPostRequestBody) GetContext() *string

GetContext gets the context property value. The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository. returns a *string when successful

func (*MarkdownPostRequestBody) GetFieldDeserializers

func (m *MarkdownPostRequestBody) GetFieldDeserializers() map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) error

GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful

func (*MarkdownPostRequestBody) GetMode

func (m *MarkdownPostRequestBody) GetMode() *MarkdownPostRequestBody_mode

GetMode gets the mode property value. The rendering mode. returns a *MarkdownPostRequestBody_mode when successful

func (*MarkdownPostRequestBody) GetText

func (m *MarkdownPostRequestBody) GetText() *string

GetText gets the text property value. The Markdown text to render in HTML. returns a *string when successful

func (*MarkdownPostRequestBody) Serialize

func (m *MarkdownPostRequestBody) Serialize(writer i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.SerializationWriter) error

Serialize serializes information the current object

func (*MarkdownPostRequestBody) SetAdditionalData

func (m *MarkdownPostRequestBody) SetAdditionalData(value map[string]any)

SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

func (*MarkdownPostRequestBody) SetContext

func (m *MarkdownPostRequestBody) SetContext(value *string)

SetContext sets the context property value. The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.

func (*MarkdownPostRequestBody) SetMode

func (m *MarkdownPostRequestBody) SetMode(value *MarkdownPostRequestBody_mode)

SetMode sets the mode property value. The rendering mode.

func (*MarkdownPostRequestBody) SetText

func (m *MarkdownPostRequestBody) SetText(value *string)

SetText sets the text property value. The Markdown text to render in HTML.

type MarkdownPostRequestBody_mode

type MarkdownPostRequestBody_mode int

The rendering mode.

const (
	MARKDOWN_MARKDOWNPOSTREQUESTBODY_MODE MarkdownPostRequestBody_mode = iota
	GFM_MARKDOWNPOSTREQUESTBODY_MODE
)

func (MarkdownPostRequestBody_mode) String

func (i MarkdownPostRequestBody_mode) String() string

type MarkdownPostRequestBodyable

type MarkdownPostRequestBodyable interface {
	i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.AdditionalDataHolder
	i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable
	GetContext() *string
	GetMode() *MarkdownPostRequestBody_mode
	GetText() *string
	SetContext(value *string)
	SetMode(value *MarkdownPostRequestBody_mode)
	SetText(value *string)
}

type MarkdownRequestBuilder

type MarkdownRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

MarkdownRequestBuilder builds and executes requests for operations under \markdown

func NewMarkdownRequestBuilder

func NewMarkdownRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *MarkdownRequestBuilder

NewMarkdownRequestBuilder instantiates a new MarkdownRequestBuilder and sets the default values.

func NewMarkdownRequestBuilderInternal

func NewMarkdownRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *MarkdownRequestBuilder

NewMarkdownRequestBuilderInternal instantiates a new MarkdownRequestBuilder and sets the default values.

func (*MarkdownRequestBuilder) Post

func (m *MarkdownRequestBuilder) Post(ctx context.Context, body MarkdownPostRequestBodyable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) error

Post render a Markdown document API method documentation

func (*MarkdownRequestBuilder) Raw

func (m *MarkdownRequestBuilder) Raw() *RawRequestBuilder

Raw the raw property returns a *RawRequestBuilder when successful

func (*MarkdownRequestBuilder) ToPostRequestInformation

func (m *MarkdownRequestBuilder) ToPostRequestInformation(ctx context.Context, body MarkdownPostRequestBodyable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

returns a *RequestInformation when successful

func (*MarkdownRequestBuilder) WithUrl

func (m *MarkdownRequestBuilder) WithUrl(rawUrl string) *MarkdownRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *MarkdownRequestBuilder when successful

type RawRequestBuilder

type RawRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

RawRequestBuilder builds and executes requests for operations under \markdown\raw

func NewRawRequestBuilder

func NewRawRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *RawRequestBuilder

NewRawRequestBuilder instantiates a new RawRequestBuilder and sets the default values.

func NewRawRequestBuilderInternal

func NewRawRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *RawRequestBuilder

NewRawRequestBuilderInternal instantiates a new RawRequestBuilder and sets the default values.

func (*RawRequestBuilder) Post

func (m *RawRequestBuilder) Post(ctx context.Context, body *string, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) error

Post you must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. API method documentation

func (*RawRequestBuilder) ToPostRequestInformation

func (m *RawRequestBuilder) ToPostRequestInformation(ctx context.Context, body *string, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToPostRequestInformation you must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. returns a *RequestInformation when successful

func (*RawRequestBuilder) WithUrl

func (m *RawRequestBuilder) WithUrl(rawUrl string) *RawRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *RawRequestBuilder when successful