Summary

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

Details

Page properties

Content

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