Summary

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

Details

Page properties

Content

...	...	@@ -9,8 +9,7 @@
9	9	= Endpoints =
10	10
11	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		-{
	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"}}{
14	14	"timestamp": 1620216790744,
15	15	"status": "200",
16	16	"data": [
...	...	@@ -134,9 +134,86 @@
134	134	{
135	135	"timestamp": 1620229625932,
136	136	"status": "200",
137		- "data": "ok"
	136	+ "data": "Repository initialized successfully !"
138	138	}
139	139	{{/code}}
140	140	)))
	140	+|(% style="width:166px" %)/rest/git/checkout/{branch} [POST]|(% style="width:189px" %)switch to a certain branch|(% style="width:383px" %)(((
	141	+the {branch} must be replaced by the name of the branch destination.
141	141
	143	+eg : /rest/git/checkout/master
	144	+
	145	+ /rest/git/checkout/develop
	146	+)))|(% style="width:449px" %)(((
	147	+it returns a "success" message of checkout branch.
	148	+
	149	+eg :
	150	+
	151	+{{code language="JSON"}}
	152	+{
	153	+ "timestamp": 1620229625932,
	154	+ "status": "200",
	155	+ "data": "switched to branch : master"
	156	+}
	157	+{{/code}}
	158	+)))
	159	+|(% style="width:166px" %)(((
	160	+/rest/git/newbranch/{branch}
	161	+
	162	+[POST]
	163	+)))|(% style="width:189px" %)create and switch to a new branch |(% style="width:383px" %)(((
	164	+the {branch} must be replaced by the name of the branch destination.
	165	+
	166	+eg :
	167	+
	168	+ /rest/git/checkout/newBranch
	169	+)))|(% style="width:449px" %)(((
	170	+it returns a "success" message of the branch creation.
	171	+
	172	+eg :
	173	+
	174	+{{code language="JSON"}}
	175	+{
	176	+ "timestamp": 1620229625932,
	177	+ "status": "200",
	178	+ "data": "new branch has been created : newBranch"
	179	+}
	180	+{{/code}}
	181	+)))
	182	+|(% style="width:166px" %)/rest/git/revert [POST]|(% style="width:189px" %)switch the modified file to the initial head version. |(% style="width:383px" %){{code language="JSON"}}{
	183	+"files":
	184	+[
	185	+{"fileName" : "newFile.xml"},
	186	+{"fileName" : "/dir/modifiedFile.pdf"}
	187	+]
	188	+}{{/code}}|(% style="width:449px" %)(((
	189	+it returns a "success" message.
	190	+
	191	+eg :
	192	+
	193	+{{code language="JSON"}}
	194	+{
	195	+ "timestamp": 1620229625932,
	196	+ "status": "200",
	197	+ "data": "the selected files has been synchronized to HEAD successfully !"
	198	+}
	199	+{{/code}}
	200	+)))
	201	+
	202	+= Errors =
	203	+
	204	+below, you can find an example of technical and functional errors :
	205	+
	206	+{{code language="JSON"}}
	207	+{
	208	+ "timestamp": 1620221672951,
	209	+ "status": "500",
	210	+ "error": "JSON file is not valid",
	211	+ "thechnicalError": "JSONObject[\"fileName\"] not found."
	212	+}
	213	+{{/code}}
	214	+
	215	+the functional error is shown with the JSON key "error", while technical error is stored in the "thechnicalError" key.
	216	+
	217	+
142	142	== ==