Wiki source code of GIT endpoints
Version 1.22 by Outhman Moustaghfir on 2021/05/05 14:55
Hide last authors
author | version | line-number | content |
---|---|---|---|
![]() |
1.1 | 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} |
2 | {{toc/}} | ||
3 | {{/box}} | ||
4 | |||
![]() |
1.2 | 5 | = Introduction = |
![]() |
1.1 | 6 | |
![]() |
1.4 | 7 | Git endpoints take advantage of all git commands known and needed to create versions of files. |
![]() |
1.1 | 8 | |
![]() |
1.4 | 9 | = Endpoints = |
10 | |||
![]() |
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"}}{ | ||
![]() |
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}} | ||
![]() |
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"}}{ |
![]() |
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}} | ||
![]() |
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"}}{ |
![]() |
1.10 | 47 | "files": |
48 | [ | ||
49 | {"fileName" : "newFile.xml"}, | ||
50 | {"fileName" : "/dir/modifiedFile.pdf"} | ||
51 | ], | ||
52 | "message": "this is a commit message" | ||
![]() |
1.13 | 53 | }{{/code}}|(% style="width:449px" %)((( |
![]() |
1.10 | 54 | it returns a String with the commit message meaning that the commit has passed successfully. |
![]() |
1.4 | 55 | |
![]() |
1.10 | 56 | eg : |
57 | |||
![]() |
1.11 | 58 | {{code language="JSON"}}{ |
59 | "timestamp": 1620217700570, | ||
60 | "status": "200", | ||
61 | "data": "this is a commit message" | ||
62 | }{{/code}} | ||
![]() |
1.10 | 63 | ))) |
![]() |
1.13 | 64 | |(% style="width:166px" %)((( |
65 | /rest/git/switchComit/{id} | ||
![]() |
1.10 | 66 | |
![]() |
1.13 | 67 | [GET] |
![]() |
1.15 | 68 | )))|(% style="width:189px" %)((( |
69 | switch to a certain version and return the history of all commits. | ||
70 | |||
![]() |
1.16 | 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} | ||
![]() |
1.15 | 74 | )))|(% style="width:383px" %)((( |
![]() |
1.14 | 75 | the {id} in the URL should be replaced by the id of the wanted commit. |
![]() |
1.13 | 76 | |
![]() |
1.14 | 77 | eg : |
78 | |||
79 | rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c | ||
![]() |
1.17 | 80 | |
81 | |||
![]() |
1.15 | 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}} | ||
![]() |
1.19 | 102 | |(% style="width:166px" %)/rest/git/update|(% style="width:189px" %)update the version with the|(% style="width:383px" %) |(% style="width:449px" %) |
![]() |
1.14 | 103 | |
![]() |
1.3 | 104 | == == |