<
From version < 1.13 >
edited by Outhman Moustaghfir
on 2021/05/05 14:37
To version < 3.1 >
edited by Outhman Moustaghfir
on 2021/05/05 15:19
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -8,8 +8,9 @@
8 8  
9 9  = Endpoints =
10 10  
11 -|(% style="width:166px" %)**URL [method]**|(% style="width:122px" %)**Description**|(% style="width:338px" %)**Input example**|(% style="width:449px" %)**Output example**
12 -|(% style="width:166px" %)/rest/git/getstatus [GET]|(% style="width:122px" %)get all files that have been modified or untracked|(% style="width:338px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
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 +{
13 13   "timestamp": 1620216790744,
14 14   "status": "200",
15 15   "data": [
... ... @@ -23,7 +23,7 @@
23 23   }
24 24   ]
25 25  }{{/code}}
26 -|(% style="width:166px" %)/rest/git/history [GET]|(% style="width:122px" %)get all commits history, with their IDs ,authors ,messages, dates and if considired as current version or not |(% style="width:338px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
27 +|(% 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 27   "timestamp": 1620217014704,
28 28   "status": "200",
29 29   "data": [
... ... @@ -43,7 +43,7 @@
43 43   }
44 44   ]
45 45  }{{/code}}
46 -|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:122px" %)commit changes in files with a message|(% style="width:338px" %){{code language="JSON"}}{
47 +|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:189px" %)commit changes in files with a message|(% style="width:383px" %){{code language="JSON"}}{
47 47  "files":
48 48  [
49 49  {"fileName" : "newFile.xml"},
... ... @@ -65,6 +65,77 @@
65 65  /rest/git/switchComit/{id}
66 66  
67 67  [GET]
68 -)))|(% style="width:122px" %)switch to a certain version and return the history of all commits.|(% style="width:338px" %)the {id} in the URL should be replaced by the |(% style="width:449px" %)
69 +)))|(% style="width:189px" %)(((
70 +switch to a certain version and return the history of all commits.
69 69  
70 -== ==
72 +**__NB __**: if there are some modified files in the current version, these files will be moved to a new directory called :
73 +
74 +.../archive/git-{timestamp}
75 +)))|(% style="width:383px" %)(((
76 +the {id} in the URL should be replaced by the id of the wanted commit.
77 +
78 +eg :
79 +
80 +rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
81 +
82 +
83 +)))|(% style="width:449px" %)(((
84 +{{code language="JSON"}}
85 +{
86 + "timestamp": 1620217014704,
87 + "status": "200",
88 + "data": [
89 + {
90 + "date": "Tue May 04 16:37:49 GMT+01:00 2021",
91 + "current": "false",
92 + "author": "person1232",
93 + "id": "11e8707eb50e25c00a62e4efedb5f6071ec7e27e",
94 + "message": "version 2"
95 + },
96 + {
97 + "date": "Tue May 04 13:28:12 GMT+01:00 2021",
98 + "current": "true",
99 + "author": "person1",
100 + "id": "4b64d02451f47d9cb91d08faa986c941deef0f5c",
101 + "message": "version 1"
102 + }
103 + ]
104 +}
105 +{{/code}}
106 +)))
107 +|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:189px" %)(((
108 +Integrates and pulls changes from a remote repository into the current branch.
109 +)))|(% style="width:383px" %)(no input required)|(% style="width:449px" %)(((
110 +it returns a success message.
111 +
112 +eg :
113 +
114 +{{code language="JSON"}}
115 +{
116 + "timestamp": 1620219625637,
117 + "status": "200",
118 + "data": "branch is now updated"
119 +}
120 +{{/code}}
121 +)))
122 +|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:189px" %)(((
123 +Clone a git repository into the directory of the current environment,
124 +
125 +if it doesn't exist it creates a new directory and initialize the repo,
126 +
127 +if the directory exists, the endpoint rename the directory with and create a new one and clone the repository.
128 +)))|(% style="width:383px" %)(no input required)|(% style="width:449px" %)(((
129 +it returns a "success" message :
130 +
131 +eg :
132 +
133 +{{code language="JSON"}}
134 +{
135 + "timestamp": 1620229625932,
136 + "status": "200",
137 + "data": "ok"
138 +}
139 +{{/code}}
140 +)))
141 +
142 +== ==
This wiki is hosted and managed by iXPath
Powered by XWiki 13.3 debian