Wiki source code of GIT endpoints

Version 3.1 by Outhman Moustaghfir on 2021/05/05 15:19

version	line-number	content
1.1	1	{{box cssClass="floatinginfobox" title="Contents"}}
	2	{{toc/}}
	3	{{/box}}
	4
1.2	5	= Introduction =
1.1	6
1.4	7	Git endpoints take advantage of all git commands known and needed to create versions of files.
1.1	8
1.4	9	= Endpoints =
	10
1.14	11	\|(% style="width:166px" %)URL [method]\|(% style="width:189px" %)Description\|(% style="width:383px" %)Input example\|(% style="width:449px" %)Output example
3.1	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	{
1.7	14	"timestamp": 1620216790744,
	15	"status": "200",
	16	"data": [
	17	{
	18	"fileName": "FileToF.txt",
	19	"status": "Untracked"
	20	},
	21	{
	22	"fileName": "newfile.txt",
	23	"status": "Modified"
	24	}
	25	]
	26	}{{/code}}
1.14	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"}}{
1.8	28	"timestamp": 1620217014704,
	29	"status": "200",
	30	"data": [
	31	{
	32	"date": "Tue May 04 16:37:49 GMT+01:00 2021",
	33	"current": "true",
	34	"author": "person1232",
	35	"id": "11e8707eb50e25c00a62e4efedb5f6071ec7e27e",
	36	"message": "version 2"
	37	},
	38	{
	39	"date": "Tue May 04 13:28:12 GMT+01:00 2021",
	40	"current": "false",
	41	"author": "person1",
	42	"id": "4b64d02451f47d9cb91d08faa986c941deef0f5c",
	43	"message": "version 1"
	44	}
	45	]
	46	}{{/code}}
1.14	47	\|(% style="width:166px" %)/rest/git/commit [POST]\|(% style="width:189px" %)commit changes in files with a message\|(% style="width:383px" %){{code language="JSON"}}{
1.10	48	"files":
	49	[
	50	{"fileName" : "newFile.xml"},
	51	{"fileName" : "/dir/modifiedFile.pdf"}
	52	],
	53	"message": "this is a commit message"
1.13	54	}{{/code}}\|(% style="width:449px" %)(((
1.10	55	it returns a String with the commit message meaning that the commit has passed successfully.
1.4	56
1.10	57	eg :
	58
1.11	59	{{code language="JSON"}}{
	60	"timestamp": 1620217700570,
	61	"status": "200",
	62	"data": "this is a commit message"
	63	}{{/code}}
1.10	64	)))
1.13	65	\|(% style="width:166px" %)(((
	66	/rest/git/switchComit/{id}
1.10	67
1.13	68	[GET]
1.15	69	)))\|(% style="width:189px" %)(((
	70	switch to a certain version and return the history of all commits.
	71
1.26	72	__NB __: if there are some modified files in the current version, these files will be moved to a new directory called :
1.16	73
	74	.../archive/git-{timestamp}
1.15	75	)))\|(% style="width:383px" %)(((
1.14	76	the {id} in the URL should be replaced by the id of the wanted commit.
1.13	77
1.14	78	eg :
	79
	80	rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
1.17	81
	82
1.30	83	)))\|(% style="width:449px" %)(((
	84	{{code language="JSON"}}
	85	{
1.15	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	]
1.30	104	}
	105	{{/code}}
	106	)))
1.26	107	\|(% style="width:166px" %)/rest/git/update [GET]\|(% style="width:189px" %)(((
1.25	108	Integrates and pulls changes from a remote repository into the current branch.
1.26	109	)))\|(% style="width:383px" %)(no input required)\|(% style="width:449px" %)(((
	110	it returns a success message.
1.14	111
1.26	112	eg :
	113
	114	{{code language="JSON"}}
	115	{
	116	"timestamp": 1620219625637,
	117	"status": "200",
	118	"data": "branch is now updated"
	119	}
	120	{{/code}}
	121	)))
1.28	122	\|(% style="width:166px" %)/rest/environment/init [POST]\|(% style="width:189px" %)(((
	123	Clone a git repository into the directory of the current environment,
1.26	124
1.29	125	if it doesn't exist it creates a new directory and initialize the repo,
1.28	126
1.29	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
1.30	133	{{code language="JSON"}}
	134	{
	135	"timestamp": 1620229625932,
	136	"status": "200",
	137	"data": "ok"
	138	}
	139	{{/code}}
1.29	140	)))
	141
3.1	142	== ==

Wiki source code of GIT endpoints

Navigation

Applications