Summary

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

Details

Page properties

Title

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

Author

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

Content

...	...	@@ -4,13 +4,18 @@
4	4
5	5	= Introduction =
6	6
7		-Git endpoints take advantage of all git commands known and needed to create versions of files.
	7	+We will go through all endpoints needed to manage the Tracking type entity.
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		-{
	11	+|(% style="width:166px" %)**URL [method]**|(% style="width:238px" %)**Description**|(% style="width:599px" %)**Input example**|(% style="width:449px" %)**Output example**
	12	+|(% style="width:166px" %)(((
	13	+/rest/trackingType [GET]
	14	+
	15	+
	16	+hedear : Authorization + env => Mandatory
	17	+\\PS : If the env does not exist on the header, you got an error 400 (bad params)
	18	+)))|(% style="width:238px" %)get all tracking Type of the giving environment|(% style="width:599px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
14	14	"timestamp": 1620216790744,
15	15	"status": "200",
16	16	"data": [
...	...	@@ -24,7 +24,7 @@
24	24	}
25	25	]
26	26	}{{/code}}
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"}}{
	32	+|(% 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"}}{
28	28	"timestamp": 1620217014704,
29	29	"status": "200",
30	30	"data": [
...	...	@@ -44,7 +44,7 @@
44	44	}
45	45	]
46	46	}{{/code}}
47		-|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:189px" %)commit changes in files with a message|(% style="width:383px" %){{code language="JSON"}}{
	52	+|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:238px" %)commit changes in files with a message|(% style="width:599px" %){{code language="JSON"}}{
48	48	"files":
49	49	[
50	50	{"fileName" : "newFile.xml"},
...	...	@@ -66,13 +66,13 @@
66	66	/rest/git/switchComit/{id}
67	67
68	68	[GET]
69		-)))|(% style="width:189px" %)(((
	74	+)))|(% style="width:238px" %)(((
70	70	switch to a certain version and return the history of all commits.
71	71
72	72	**__NB __**: if there are some modified files in the current version, these files will be moved to a new directory called :
73	73
74	74	.../archive/git-{timestamp}
75		-)))|(% style="width:383px" %)(((
	80	+)))|(% style="width:599px" %)(((
76	76	the {id} in the URL should be replaced by the id of the wanted commit.
77	77
78	78	eg :
...	...	@@ -104,9 +104,9 @@
104	104	}
105	105	{{/code}}
106	106	)))
107		-|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:189px" %)(((
	112	+|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:238px" %)(((
108	108	Integrates and pulls changes from a remote repository into the current branch.
109		-)))|(% style="width:383px" %)(no input required)|(% style="width:449px" %)(((
	114	+)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
110	110	it returns a success message.
111	111
112	112	eg :
...	...	@@ -119,13 +119,13 @@
119	119	}
120	120	{{/code}}
121	121	)))
122		-|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:189px" %)(((
	127	+|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:238px" %)(((
123	123	Clone a git repository into the directory of the current environment,
124	124
125	125	if it doesn't exist it creates a new directory and initialize the repo,
126	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" %)(((
	132	+if the directory exists, the endpoint renames the directory and creates a new one and clones the repository.
	133	+)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
129	129	it returns a "success" message :
130	130
131	131	eg :
...	...	@@ -134,9 +134,86 @@
134	134	{
135	135	"timestamp": 1620229625932,
136	136	"status": "200",
137		- "data": "ok"
	142	+ "data": "Repository initialized successfully !"
138	138	}
139	139	{{/code}}
140	140	)))
	146	+|(% style="width:166px" %)/rest/git/checkout/{branch} [POST]|(% style="width:238px" %)switch to a certain branch|(% style="width:599px" %)(((
	147	+the {branch} must be replaced by the name of the branch destination.
141	141
	149	+eg : /rest/git/checkout/master
	150	+
	151	+ /rest/git/checkout/develop
	152	+)))|(% style="width:449px" %)(((
	153	+it returns a "success" message of checkout branch.
	154	+
	155	+eg :
	156	+
	157	+{{code language="JSON"}}
	158	+{
	159	+ "timestamp": 1620229625932,
	160	+ "status": "200",
	161	+ "data": "switched to branch : master"
	162	+}
	163	+{{/code}}
	164	+)))
	165	+|(% style="width:166px" %)(((
	166	+/rest/git/newbranch/{branch}
	167	+
	168	+[POST]
	169	+)))|(% style="width:238px" %)create and switch to a new branch |(% style="width:599px" %)(((
	170	+the {branch} must be replaced by the name of the branch destination.
	171	+
	172	+eg :
	173	+
	174	+ /rest/git/checkout/newBranch
	175	+)))|(% style="width:449px" %)(((
	176	+it returns a "success" message of the branch creation.
	177	+
	178	+eg :
	179	+
	180	+{{code language="JSON"}}
	181	+{
	182	+ "timestamp": 1620229625932,
	183	+ "status": "200",
	184	+ "data": "new branch has been created : newBranch"
	185	+}
	186	+{{/code}}
	187	+)))
	188	+|(% 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"}}{
	189	+"files":
	190	+[
	191	+{"fileName" : "newFile.xml"},
	192	+{"fileName" : "/dir/modifiedFile.pdf"}
	193	+]
	194	+}{{/code}}|(% style="width:449px" %)(((
	195	+it returns a "success" message.
	196	+
	197	+eg :
	198	+
	199	+{{code language="JSON"}}
	200	+{
	201	+ "timestamp": 1620229625932,
	202	+ "status": "200",
	203	+ "data": "the selected files has been synchronized to HEAD successfully !"
	204	+}
	205	+{{/code}}
	206	+)))
	207	+
	208	+= Errors =
	209	+
	210	+below, you can find an example of technical and functional errors :
	211	+
	212	+{{code language="JSON"}}
	213	+{
	214	+ "timestamp": 1620221672951,
	215	+ "status": "500",
	216	+ "error": "JSON file is not valid",
	217	+ "thechnicalError": "JSONObject[\"fileName\"] not found."
	218	+}
	219	+{{/code}}
	220	+
	221	+the functional error is shown with the JSON key "error", while technical error is stored in the "thechnicalError" key.
	222	+
	223	+
142	142	== ==