Hide last authors
Achraf El Kari 1.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
Outhman Moustaghfir 1.2 5 = Introduction =
Achraf El Kari 1.1 6
Outhman Moustaghfir 1.4 7 Git endpoints take advantage of all git commands known and needed to create versions of files.
Achraf El Kari 1.1 8
Outhman Moustaghfir 1.4 9 = Endpoints =
10
Outhman Moustaghfir 1.14 11 |(% style="width:166px" %)**URL [method]**|(% style="width:189px" %)**Description**|(% style="width:383px" %)**Input example**|(% style="width:449px" %)**Output example**
12 |(% style="width:166px" %)/rest/git/getstatus [GET]|(% style="width:189px" %)get all files that have been modified or untracked|(% style="width:383px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
Outhman Moustaghfir 1.7 13 "timestamp": 1620216790744,
14 "status": "200",
15 "data": [
16 {
17 "fileName": "FileToF.txt",
18 "status": "Untracked"
19 },
20 {
21 "fileName": "newfile.txt",
22 "status": "Modified"
23 }
24 ]
25 }{{/code}}
Outhman Moustaghfir 1.14 26 |(% style="width:166px" %)/rest/git/history [GET]|(% style="width:189px" %)get all commits history, with their IDs ,authors ,messages, dates and if considired as current version or not |(% style="width:383px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
Outhman Moustaghfir 1.8 27 "timestamp": 1620217014704,
28 "status": "200",
29 "data": [
30 {
31 "date": "Tue May 04 16:37:49 GMT+01:00 2021",
32 "current": "true",
33 "author": "person1232",
34 "id": "11e8707eb50e25c00a62e4efedb5f6071ec7e27e",
35 "message": "version 2"
36 },
37 {
38 "date": "Tue May 04 13:28:12 GMT+01:00 2021",
39 "current": "false",
40 "author": "person1",
41 "id": "4b64d02451f47d9cb91d08faa986c941deef0f5c",
42 "message": "version 1"
43 }
44 ]
45 }{{/code}}
Outhman Moustaghfir 1.14 46 |(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:189px" %)commit changes in files with a message|(% style="width:383px" %){{code language="JSON"}}{
Outhman Moustaghfir 1.10 47 "files":
48 [
49 {"fileName" : "newFile.xml"},
50 {"fileName" : "/dir/modifiedFile.pdf"}
51 ],
52 "message": "this is a commit message"
Outhman Moustaghfir 1.13 53 }{{/code}}|(% style="width:449px" %)(((
Outhman Moustaghfir 1.10 54 it returns a String with the commit message meaning that the commit has passed successfully.
Outhman Moustaghfir 1.4 55
Outhman Moustaghfir 1.10 56 eg :
57
Outhman Moustaghfir 1.11 58 {{code language="JSON"}}{
59 "timestamp": 1620217700570,
60 "status": "200",
61 "data": "this is a commit message"
62 }{{/code}}
Outhman Moustaghfir 1.10 63 )))
Outhman Moustaghfir 1.13 64 |(% style="width:166px" %)(((
65 /rest/git/switchComit/{id}
Outhman Moustaghfir 1.10 66
Outhman Moustaghfir 1.13 67 [GET]
Outhman Moustaghfir 1.15 68 )))|(% style="width:189px" %)(((
69 switch to a certain version and return the history of all commits.
70
71 **__NB __**: if there are modified files in the current version, these files will be moved to
72 )))|(% style="width:383px" %)(((
Outhman Moustaghfir 1.14 73 the {id} in the URL should be replaced by the id of the wanted commit.
Outhman Moustaghfir 1.13 74
Outhman Moustaghfir 1.14 75 eg :
76
77 rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
Outhman Moustaghfir 1.15 78 )))|(% style="width:449px" %){{code language="JSON"}}{
79 "timestamp": 1620217014704,
80 "status": "200",
81 "data": [
82 {
83 "date": "Tue May 04 16:37:49 GMT+01:00 2021",
84 "current": "false",
85 "author": "person1232",
86 "id": "11e8707eb50e25c00a62e4efedb5f6071ec7e27e",
87 "message": "version 2"
88 },
89 {
90 "date": "Tue May 04 13:28:12 GMT+01:00 2021",
91 "current": "true",
92 "author": "person1",
93 "id": "4b64d02451f47d9cb91d08faa986c941deef0f5c",
94 "message": "version 1"
95 }
96 ]
97 }{{/code}}
Outhman Moustaghfir 1.14 98
Outhman Moustaghfir 1.3 99 == ==
This wiki is hosted and managed by iXPath
Powered by XWiki 13.3 debian