Add API to get/edit wiki #17278
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,12 +5,12 @@ | |
| package integrations | ||
|
|
||
| import ( | ||
| "encoding/base64" | ||
| "fmt" | ||
| "net/http" | ||
| "testing" | ||
|
|
||
| api "code.gitea.io/gitea/modules/structs" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
@@ -30,33 +30,34 @@ func TestAPIGetWikiPage(t *testing.T) { | |
|
|
||
| assert.Equal(t, &api.WikiPage{ | ||
| WikiPageMetaData: &api.WikiPageMetaData{ | ||
| Title: "Home", | ||
| HTMLURL: page.HTMLURL, | ||
| SubURL: "Home", | ||
| LastCommit: &api.WikiCommit{ | ||
| ID: "2c54faec6c45d31c1abfaecdab471eac6633738a", | ||
| Author: &api.CommitUser{ | ||
| Identity: api.Identity{ | ||
| Name: "Ethan Koenig", | ||
| Email: "[email protected]", | ||
| }, | ||
| Date: "2017-11-27T04:31:18Z", | ||
| }, | ||
| Committer: &api.CommitUser{ | ||
| Identity: api.Identity{ | ||
| Name: "Ethan Koenig", | ||
| Email: "[email protected]", | ||
| }, | ||
| Date: "2017-11-27T04:31:18Z", | ||
| }, | ||
| Message: "Add Home.md\n", | ||
| }, | ||
| }, | ||
| ContentBase64: base64.RawStdEncoding.EncodeToString( | ||
| []byte("# Home page\n\nThis is the home page!\n"), | ||
| ), | ||
| CommitCount: 1, | ||
| Sidebar: "", | ||
| Footer: "", | ||
| }, page) | ||
| } | ||
|
|
||
|
|
@@ -76,24 +77,96 @@ func TestAPIListWikiPages(t *testing.T) { | |
|
|
||
| dummymeta := []*api.WikiPageMetaData{ | ||
| { | ||
| Title: "Home", | ||
| HTMLURL: meta[0].HTMLURL, | ||
| SubURL: "Home", | ||
| LastCommit: &api.WikiCommit{ | ||
| ID: "2c54faec6c45d31c1abfaecdab471eac6633738a", | ||
| Author: &api.CommitUser{ | ||
| Identity: api.Identity{ | ||
| Name: "Ethan Koenig", | ||
| Email: "[email protected]", | ||
| }, | ||
| Date: "2017-11-27T04:31:18Z", | ||
| }, | ||
| Committer: &api.CommitUser{ | ||
| Identity: api.Identity{ | ||
| Name: "Ethan Koenig", | ||
| Email: "[email protected]", | ||
| }, | ||
| Date: "2017-11-27T04:31:18Z", | ||
| }, | ||
| Message: "Add Home.md\n", | ||
| }, | ||
| }, | ||
| { | ||
| Title: "Page With Image", | ||
| HTMLURL: meta[1].HTMLURL, | ||
| SubURL: "Page-With-Image", | ||
| LastCommit: &api.WikiCommit{ | ||
| ID: "0cf15c3f66ec8384480ed9c3cf87c9e97fbb0ec3", | ||
| Author: &api.CommitUser{ | ||
| Identity: api.Identity{ | ||
| Name: "Gabriel Silva Simões", | ||
| Email: "[email protected]", | ||
| }, | ||
| Date: "2019-01-25T01:41:55Z", | ||
| }, | ||
| Committer: &api.CommitUser{ | ||
| Identity: api.Identity{ | ||
| Name: "Gabriel Silva Simões", | ||
| Email: "[email protected]", | ||
| }, | ||
| Date: "2019-01-25T01:41:55Z", | ||
| }, | ||
| Message: "Add jpeg.jpg and page with image\n", | ||
| }, | ||
| }, | ||
| { | ||
| Title: "Page With Spaced Name", | ||
| HTMLURL: meta[2].HTMLURL, | ||
| SubURL: "Page-With-Spaced-Name", | ||
| LastCommit: &api.WikiCommit{ | ||
| ID: "c10d10b7e655b3dab1f53176db57c8219a5488d6", | ||
| Author: &api.CommitUser{ | ||
| Identity: api.Identity{ | ||
| Name: "Gabriel Silva Simões", | ||
| Email: "[email protected]", | ||
| }, | ||
| Date: "2019-01-25T01:39:51Z", | ||
| }, | ||
| Committer: &api.CommitUser{ | ||
| Identity: api.Identity{ | ||
| Name: "Gabriel Silva Simões", | ||
| Email: "[email protected]", | ||
| }, | ||
| Date: "2019-01-25T01:39:51Z", | ||
| }, | ||
| Message: "Add page with spaced name\n", | ||
| }, | ||
| }, | ||
| { | ||
| Title: "Unescaped File", | ||
| HTMLURL: meta[3].HTMLURL, | ||
| SubURL: "Unescaped-File", | ||
| LastCommit: &api.WikiCommit{ | ||
| ID: "0dca5bd9b5d7ef937710e056f575e86c0184ba85", | ||
| Author: &api.CommitUser{ | ||
| Identity: api.Identity{ | ||
| Name: "6543", | ||
| Email: "[email protected]", | ||
| }, | ||
| Date: "2021-07-19T16:42:46Z", | ||
| }, | ||
| Committer: &api.CommitUser{ | ||
| Identity: api.Identity{ | ||
| Name: "6543", | ||
| Email: "[email protected]", | ||
| }, | ||
| Date: "2021-07-19T16:42:46Z", | ||
| }, | ||
| Message: "add unescaped file\n", | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
|
|
@@ -113,15 +186,11 @@ func TestAPINewWikiPage(t *testing.T) { | |
| urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/wiki/new?token=%s", username, "repo1", token) | ||
|
|
||
| req := NewRequestWithJSON(t, "POST", urlStr, &api.CreateWikiPageOptions{ | ||
| Title: title, | ||
| ContentBase64: base64.StdEncoding.EncodeToString([]byte("Wiki page content for API unit tests")), | ||
| Message: "", | ||
| }) | ||
| session.MakeRequest(t, req, http.StatusCreated) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -134,11 +203,11 @@ func TestAPIEditWikiPage(t *testing.T) { | |
| urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/wiki/page/Page-With-Spaced-Name?token=%s", username, "repo1", token) | ||
|
|
||
| req := NewRequestWithJSON(t, "PATCH", urlStr, &api.CreateWikiPageOptions{ | ||
| Title: "edited title", | ||
| ContentBase64: base64.StdEncoding.EncodeToString([]byte("Edited wiki page content for API unit tests")), | ||
| Message: "", | ||
| }) | ||
| session.MakeRequest(t, req, http.StatusOK) | ||
| } | ||
|
|
||
| func TestAPIListPageRevisions(t *testing.T) { | ||
|
|
@@ -163,14 +232,14 @@ func TestAPIListPageRevisions(t *testing.T) { | |
| Name: "Ethan Koenig", | ||
| Email: "[email protected]", | ||
| }, | ||
| Date: "2017-11-27T04:31:18Z", | ||
| }, | ||
| Committer: &api.CommitUser{ | ||
| Identity: api.Identity{ | ||
| Name: "Ethan Koenig", | ||
| Email: "[email protected]", | ||
| }, | ||
| Date: "2017-11-27T04:31:18Z", | ||
| }, | ||
| Message: "Add Home.md\n", | ||
| }, | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,26 +15,28 @@ type WikiCommit struct { | |
| // WikiPage a wiki page | ||
| type WikiPage struct { | ||
| *WikiPageMetaData | ||
| // Page content, base64 encoded | ||
| ContentBase64 string `json:"content_base64"` | ||
| CommitCount int64 `json:"commit_count"` | ||
| Sidebar string `json:"sidebar"` | ||
| Footer string `json:"footer"` | ||
| } | ||
|
|
||
| // WikiPageMetaData wiki page meta information | ||
| type WikiPageMetaData struct { | ||
| Title string `json:"title"` | ||
| HTMLURL string `json:"html_url"` | ||
| SubURL string `json:"sub_url"` | ||
| LastCommit *WikiCommit `json:"last_commit"` | ||
| } | ||
|
|
||
| // CreateWikiPageOptions form for creating wiki | ||
| type CreateWikiPageOptions struct { | ||
| // page title. leave empty to keep unchanged | ||
| Title string `json:"title"` | ||
| // content must be base64 encoded | ||
| ContentBase64 string `json:"content_base64"` | ||
|
There was a problem hiding this comment. Must the content really be base64 encoded? There was a problem hiding this comment. The files API returns base64 data too, so @noerw suggested to change it here too. |
||
| // optional commit message summarizing the change | ||
| Message string `json:"message"` | ||
qwerty287 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Must the content really be base64 encoded?
How would it be possible to send binary data? Isn't it an
htmlormarkdownfile you're sending?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a git repo, it can contain anything.