Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Tracking Type
	1	+GIT endpoints

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.aelkari
	1	+XWiki.omoustaghfir

Content

...	...	@@ -4,21 +4,13 @@
4	4
5	5	= Introduction =
6	6
7		-We will go through all endpoints needed to manage the Tracking type entity.
	7	+Git endpoints take advantage of all git commands known and needed to create versions of files.
8	8
9	9	= Endpoints =
10	10
11		-**PS :** __//For all those endpoints, the env params is andatory on the header, otherwise you got an error 400 (BAD PARAMS).//__
12		-
13		-
14		-|(% style="width:166px" %)**URL [method]**|(% style="width:238px" %)**Description**|(% style="width:599px" %)**Input example**|(% style="width:449px" %)**Output example**
15		-|(% style="width:166px" %)(((
16		-/rest/trackingType [GET]
17		-
18		-
19		-hedear : Authorization + env => Mandatory
20		-\\PS :** If the env does not exist on the header, you got an error 400 (bad params)**
21		-)))|(% style="width:238px" %)get all tracking Type of the giving environment|(% style="width:599px" %)(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	+{
22	22	"timestamp": 1620216790744,
23	23	"status": "200",
24	24	"data": [
...	...	@@ -32,7 +32,7 @@
32	32	}
33	33	]
34	34	}{{/code}}
35		-|(% style="width:166px" %)/rest/git/history [GET]|(% style="width:238px" %)get all commits history, with their IDs ,authors ,messages, dates and if considired as current version or not |(% style="width:599px" %)(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"}}{
36	36	"timestamp": 1620217014704,
37	37	"status": "200",
38	38	"data": [
...	...	@@ -52,7 +52,7 @@
52	52	}
53	53	]
54	54	}{{/code}}
55		-|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:238px" %)commit changes in files with a message|(% style="width:599px" %){{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"}}{
56	56	"files":
57	57	[
58	58	{"fileName" : "newFile.xml"},
...	...	@@ -74,13 +74,13 @@
74	74	/rest/git/switchComit/{id}
75	75
76	76	[GET]
77		-)))|(% style="width:238px" %)(((
	69	+)))|(% style="width:189px" %)(((
78	78	switch to a certain version and return the history of all commits.
79	79
80	80	**__NB __**: if there are some modified files in the current version, these files will be moved to a new directory called :
81	81
82	82	.../archive/git-{timestamp}
83		-)))|(% style="width:599px" %)(((
	75	+)))|(% style="width:383px" %)(((
84	84	the {id} in the URL should be replaced by the id of the wanted commit.
85	85
86	86	eg :
...	...	@@ -112,9 +112,9 @@
112	112	}
113	113	{{/code}}
114	114	)))
115		-|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:238px" %)(((
	107	+|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:189px" %)(((
116	116	Integrates and pulls changes from a remote repository into the current branch.
117		-)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
	109	+)))|(% style="width:383px" %)(no input required)|(% style="width:449px" %)(((
118	118	it returns a success message.
119	119
120	120	eg :
...	...	@@ -127,13 +127,13 @@
127	127	}
128	128	{{/code}}
129	129	)))
130		-|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:238px" %)(((
	122	+|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:189px" %)(((
131	131	Clone a git repository into the directory of the current environment,
132	132
133	133	if it doesn't exist it creates a new directory and initialize the repo,
134	134
135		-if the directory exists, the endpoint renames the directory and creates a new one and clones the repository.
136		-)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
	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" %)(((
137	137	it returns a "success" message :
138	138
139	139	eg :
...	...	@@ -142,86 +142,9 @@
142	142	{
143	143	"timestamp": 1620229625932,
144	144	"status": "200",
145		- "data": "Repository initialized successfully !"
	137	+ "data": "ok"
146	146	}
147	147	{{/code}}
148	148	)))
149		-|(% style="width:166px" %)/rest/git/checkout/{branch} [POST]|(% style="width:238px" %)switch to a certain branch|(% style="width:599px" %)(((
150		-the {branch} must be replaced by the name of the branch destination.
151	151
152		-eg : /rest/git/checkout/master
153		-
154		- /rest/git/checkout/develop
155		-)))|(% style="width:449px" %)(((
156		-it returns a "success" message of checkout branch.
157		-
158		-eg :
159		-
160		-{{code language="JSON"}}
161		-{
162		- "timestamp": 1620229625932,
163		- "status": "200",
164		- "data": "switched to branch : master"
165		-}
166		-{{/code}}
167		-)))
168		-|(% style="width:166px" %)(((
169		-/rest/git/newbranch/{branch}
170		-
171		-[POST]
172		-)))|(% style="width:238px" %)create and switch to a new branch |(% style="width:599px" %)(((
173		-the {branch} must be replaced by the name of the branch destination.
174		-
175		-eg :
176		-
177		- /rest/git/checkout/newBranch
178		-)))|(% style="width:449px" %)(((
179		-it returns a "success" message of the branch creation.
180		-
181		-eg :
182		-
183		-{{code language="JSON"}}
184		-{
185		- "timestamp": 1620229625932,
186		- "status": "200",
187		- "data": "new branch has been created : newBranch"
188		-}
189		-{{/code}}
190		-)))
191		-|(% style="width:166px" %)/rest/git/revert [POST]|(% style="width:238px" %)switch the modified file to the initial head version. |(% style="width:599px" %){{code language="JSON"}}{
192		-"files":
193		-[
194		-{"fileName" : "newFile.xml"},
195		-{"fileName" : "/dir/modifiedFile.pdf"}
196		-]
197		-}{{/code}}|(% style="width:449px" %)(((
198		-it returns a "success" message.
199		-
200		-eg :
201		-
202		-{{code language="JSON"}}
203		-{
204		- "timestamp": 1620229625932,
205		- "status": "200",
206		- "data": "the selected files has been synchronized to HEAD successfully !"
207		-}
208		-{{/code}}
209		-)))
210		-
211		-= Errors =
212		-
213		-below, you can find an example of technical and functional errors :
214		-
215		-{{code language="JSON"}}
216		-{
217		- "timestamp": 1620221672951,
218		- "status": "500",
219		- "error": "JSON file is not valid",
220		- "thechnicalError": "JSONObject[\"fileName\"] not found."
221		-}
222		-{{/code}}
223		-
224		-the functional error is shown with the JSON key "error", while technical error is stored in the "thechnicalError" key.
225		-
226		-
227	227	== ==