<
From version < 1.17 >
edited by Outhman Moustaghfir
on 2021/05/05 14:43
To version < 1.6 >
edited by Outhman Moustaghfir
on 2021/05/05 14:11
>
Change comment: (Autosaved)

Summary

Details

Page properties
Content
... ... @@ -8,96 +8,8 @@
8 8  
9 9  = Endpoints =
10 10  
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"}}{
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}}
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"}}{
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}}
46 -|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:189px" %)commit changes in files with a message|(% style="width:383px" %){{code language="JSON"}}{
47 -"files":
48 -[
49 -{"fileName" : "newFile.xml"},
50 -{"fileName" : "/dir/modifiedFile.pdf"}
51 -],
52 -"message": "this is a commit message"
53 -}{{/code}}|(% style="width:449px" %)(((
54 -it returns a String with the commit message meaning that the commit has passed successfully.
11 +|(% style="width:155px" %)**URL [method]**|(% style="width:287px" %)**Description**|(% style="width:283px" %)**Input example**|(% style="width:263px" %)**Output example**
12 +|(% style="width:155px" %)/rest/git/getstatus [GET]|(% style="width:287px" %)get all files that have been modified or untracked|(% style="width:283px" %)(no input required)|(% style="width:263px" %)
13 +|(% style="width:155px" %) |(% style="width:287px" %) |(% style="width:283px" %) |(% style="width:263px" %)
55 55  
56 -eg :
57 -
58 -{{code language="JSON"}}{
59 - "timestamp": 1620217700570,
60 - "status": "200",
61 - "data": "this is a commit message"
62 -}{{/code}}
63 -)))
64 -|(% style="width:166px" %)(((
65 -/rest/git/switchComit/{id}
66 -
67 -[GET]
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 a new directory called :
72 -
73 -.../archive/git-{timestamp}
74 -)))|(% style="width:383px" %)(((
75 -the {id} in the URL should be replaced by the id of the wanted commit.
76 -
77 -eg :
78 -
79 -rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
80 -
81 -
82 -)))|(% style="width:449px" %){{code language="JSON"}}{
83 - "timestamp": 1620217014704,
84 - "status": "200",
85 - "data": [
86 - {
87 - "date": "Tue May 04 16:37:49 GMT+01:00 2021",
88 - "current": "false",
89 - "author": "person1232",
90 - "id": "11e8707eb50e25c00a62e4efedb5f6071ec7e27e",
91 - "message": "version 2"
92 - },
93 - {
94 - "date": "Tue May 04 13:28:12 GMT+01:00 2021",
95 - "current": "true",
96 - "author": "person1",
97 - "id": "4b64d02451f47d9cb91d08faa986c941deef0f5c",
98 - "message": "version 1"
99 - }
100 - ]
101 -}{{/code}}
102 -
103 103  == ==
This wiki is hosted and managed by iXPath
Powered by XWiki 13.3 debian