Skip to content
forgit api docs

Edit a wiki page

PATCH
/repos/{owner}/{repo}/wiki/page/{pageName}

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
owner
required
string

Owner of the repo

repo
required
string

Name of the repo

pageName
required
string

Name of the page

Request Body

Section titled “Request Body”
Media typeapplication/json

CreateWikiPageOptions form for creating wiki

object
content_base64

Content must be base64 encoded

string
message

Optional commit message summarizing the change

string
title

Page title. leave empty to keep unchanged

string
Examplegenerated
{
  "content_base64": "example",
  "message": "example",
  "title": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

WikiPage

WikiPage a wiki page

object
commit_count
integer format: int64
content_base64

Page content, base64 encoded

string
footer
string
html_url
string
last_commit

WikiCommit page commit/revision

object
author
CommitUser contains information of a user in the context of a commit.
object
date
string
email
string format: email
name
string
commiter
CommitUser contains information of a user in the context of a commit.
object
date
string
email
string format: email
name
string
message
string
sha
string
sidebar
string
sub_url
string
title
string
Examplegenerated
{
  "commit_count": 1,
  "content_base64": "example",
  "footer": "example",
  "html_url": "example",
  "last_commit": {
    "author": {
      "date": "example",
      "email": "hello@example.com",
      "name": "example"
    },
    "commiter": {
      "date": "example",
      "email": "hello@example.com",
      "name": "example"
    },
    "message": "example",
    "sha": "example"
  },
  "sidebar": "example",
  "sub_url": "example",
  "title": "example"
}

400

Section titled “400”

APIError is error format response

APIError is an api error with a message

object
message
string
url
string
Examplegenerated
{
  "message": "example",
  "url": "example"
}

403

Section titled “403”

APIForbiddenError is a forbidden error response

object
message
string
url
string
Examplegenerated
{
  "message": "example",
  "url": "example"
}

404

Section titled “404”

APINotFound is a not found error response

object
errors
Array<string>
message
string
url
string
Examplegenerated
{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}

413

Section titled “413”

QuotaExceeded

Headers

Section titled “Headers”
message
string
user_id
integer format: int64
username
string

423

Section titled “423”

APIRepoArchivedError is an error that is raised when an archived repo should be modified

object
message
string
url
string
Examplegenerated
{
  "message": "example",
  "url": "example"
}