Blame - runtime-acm/src/main/resources/openapi/openapi.yaml - onap/policy/clamp

blob: 5075ee5e66cf5033a91bb3eec642b19070b05e69 [file] [log] [blame]

lapentafd	16e6e7e	2022-11-02 10:08:16 +0000	[diff] [blame]	1	# ============LICENSE_START=======================================================
				2	# Copyright (C) 2022 Nordix Foundation
				3	# ================================================================================
				4	# Licensed under the Apache License, Version 2.0 (the "License");
				5	# you may not use this file except in compliance with the License.
				6	# You may obtain a copy of the License at
				7	#
				8	# http://www.apache.org/licenses/LICENSE-2.0
				9	#
				10	# Unless required by applicable law or agreed to in writing, software
				11	# distributed under the License is distributed on an "AS IS" BASIS,
				12	# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
				13	# See the License for the specific language governing permissions and
				14	# limitations under the License.
				15	#
				16	# SPDX-License-Identifier: Apache-2.0
				17	# ============LICENSE_END=========================================================
				18	openapi: 3.0.1
				19	info:
				20	title: Api Documentation
				21	description: Api Documentation
				22	termsOfService: urn:tos
				23	contact: {}
				24	license:
				25	name: Apache 2.0
				26	url: http://www.apache.org/licenses/LICENSE-2.0
				27	version: "1.0"
				28	servers:
				29	- url: https://{server}
				30	variables:
				31	server:
				32	default: onap/acm/v3
				33	description: This value is assigned by the service provider
				34	tags:
				35	- name: Automation Composition Controller
				36	description: Automation Composition Controller
				37
				38	paths:
				39	/compositions:
				40	get:
				41	tags:
				42	- Automation Composition Controller
				43	summary: Query the commissioned automation composition definitions
				44	definitions
				45	description: Query the commissioned automation composition
				46	definitions, returning the automation composition details
				47	operationId: queryCompositionDefinitions
				48	parameters:
				49	- name: name
				50	in: query
				51	description: Automation composition definition name. Regular expressions are supported for filtering. If
				52	this parameter is not specified, all automation composition definitions are returned.
				53	schema:
				54	type: string
				55	- name: version
				56	in: query
				57	description: Automation composition definition version. Regular expressions are supported for filtering. If this
				58	parameter is not specified, all automation composition definitions that match the "name" filter are are returned.
				59	schema:
				60	type: string
				61	- name: X-onap-RequestId
				62	in: header
				63	description: RequestID for http transaction
				64	schema:
				65	type: string
				66	format: uuid
				67	responses:
				68	200:
				69	description: Serialised instance of
				70	[ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
				71	that contains the automation composition definitions that match the requested filters.
				72	content:
				73	application/json:
				74	schema:
				75	title: ToscaServiceTemplate
				76	type: object
				77	example:
				78	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.json'
				79	application/yaml:
				80	schema:
				81	title: ToscaServiceTemplate
				82	type: object
				83	example:
				84	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.yaml'
				85	401:
				86	description: Authentication Error
				87	headers:
				88	X-LatestVersion:
				89	schema:
				90	type: string
				91	X-PatchVersion:
				92	schema:
				93	type: string
				94	X-MinorVersion:
				95	schema:
				96	type: string
				97	X-onap-RequestId:
				98	schema:
				99	type: string
				100	format: uuid
				101	content: {}
				102	403:
				103	description: Authorization Error
				104	headers:
				105	X-LatestVersion:
				106	schema:
				107	type: string
				108	X-PatchVersion:
				109	schema:
				110	type: string
				111	X-MinorVersion:
				112	schema:
				113	type: string
				114	X-onap-RequestId:
				115	schema:
				116	type: string
				117	format: uuid
				118	content: {}
				119	404:
				120	description: Not Found
				121	content: {}
				122	500:
				123	description: Internal Server Error
				124	headers:
				125	X-LatestVersion:
				126	schema:
				127	type: string
				128	X-PatchVersion:
				129	schema:
				130	type: string
				131	X-MinorVersion:
				132	schema:
				133	type: string
				134	X-onap-RequestId:
				135	schema:
				136	type: string
				137	format: uuid
				138	content: {}
				139	security:
				140	- basicAuth: []
				141	x-interface info:
				142	api-version: 1.0.0
				143	last-mod-release: London
				144	post:
				145	tags:
				146	- Automation Composition Controller
				147	summary: Commissions automation composition definitions
				148	description: Commissions automation composition definitions, returning the UUIDs of
				149	automation composition definitions commissioned by this request.
				150	operationId: createCompositionDefinitions
				151	parameters:
				152	- name: X-onap-RequestId
				153	in: header
				154	description: RequestID for http transaction
				155	schema:
				156	type: string
				157	format: uuid
				158	requestBody:
				159	description: Serialised instance of
				160	[ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
				161	containing the automation composition definitions to be commissioned.
				162	content:
				163	application/json:
				164	schema:
				165	title: ToscaServiceTemplate
				166	type: object
				167	example:
				168	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.json'
				169	application/yaml:
				170	schema:
				171	title: ToscaServiceTemplate
				172	type: object
				173	example:
				174	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.yaml'
				175	required: true
				176	responses:
				177	200:
				178	description: Serialised instance of
				179	[CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
				180	containing the UUIDs of automation composition definitions created by this request
				181	content:
				182	application/json:
				183	schema:
				184	title: CommissioningResponse
				185	type: object
				186	example:
				187	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.json'
				188	application/yaml:
				189	schema:
				190	title: CommissioningResponse
				191	type: object
				192	example:
				193	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.yaml'
				194	201:
				195	description: Created
				196	content: {}
				197	401:
				198	description: Authentication Error
				199	headers:
				200	X-LatestVersion:
				201	schema:
				202	type: string
				203	X-PatchVersion:
				204	schema:
				205	type: string
				206	X-MinorVersion:
				207	schema:
				208	type: string
				209	X-onap-RequestId:
				210	schema:
				211	type: string
				212	format: uuid
				213	content: {}
				214	403:
				215	description: Authorization Error
				216	headers:
				217	X-LatestVersion:
				218	schema:
				219	type: string
				220	X-PatchVersion:
				221	schema:
				222	type: string
				223	X-MinorVersion:
				224	schema:
				225	type: string
				226	X-onap-RequestId:
				227	schema:
				228	type: string
				229	format: uuid
				230	content: {}
				231	404:
				232	description: Not Found
				233	content: {}
				234	500:
				235	description: Internal Server Error
				236	headers:
				237	X-LatestVersion:
				238	schema:
				239	type: string
				240	X-PatchVersion:
				241	schema:
				242	type: string
				243	X-MinorVersion:
				244	schema:
				245	type: string
				246	X-onap-RequestId:
				247	schema:
				248	type: string
				249	format: uuid
				250	content: {}
				251	security:
				252	- basicAuth: []
				253	x-interface info:
				254	api-version: 1.0.0
				255	last-mod-release: London
				256	x-codegen-request-body-name: body
				257	/compositions/{compositionId}:
				258	get:
				259	tags:
				260	- Automation Composition Controller
				261	summary: Get details of the requested commissioned automation composition
				262	definitions
				263	description: Get details of the requested commissioned automation composition
				264	definitions, returning all automation composition details
				265	operationId: getCompositionDefinition
				266	parameters:
				267	- name : compositionId
				268	in: path
				269	description: The UUID of the automation composition definition to get
				270	required: true
				271	schema:
				272	type: string
				273	format: uuid
				274	- name: X-onap-RequestId
				275	in: header
				276	description: RequestID for http transaction
				277	schema:
				278	type: string
				279	format: uuid
				280	responses:
				281	200:
				282	description:
				283	Serialised instance of
				284	[ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
				285	containing the requested automation composition definition.
				286	content:
				287	application/json:
				288	schema:
				289	title: ToscaServiceTemplate
				290	type: object
				291	example:
				292	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.json'
				293	application/yaml:
				294	schema:
				295	title: ToscaServiceTemplate
				296	type: object
				297	example:
				298	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.yaml'
				299	401:
				300	description: Authentication Error
				301	headers:
				302	X-LatestVersion:
				303	schema:
				304	type: string
				305	X-PatchVersion:
				306	schema:
				307	type: string
				308	X-MinorVersion:
				309	schema:
				310	type: string
				311	X-onap-RequestId:
				312	schema:
				313	type: string
				314	format: uuid
				315	content: {}
				316	403:
				317	description: Authorization Error
				318	headers:
				319	X-LatestVersion:
				320	schema:
				321	type: string
				322	X-PatchVersion:
				323	schema:
				324	type: string
				325	X-MinorVersion:
				326	schema:
				327	type: string
				328	X-onap-RequestId:
				329	schema:
				330	type: string
				331	format: uuid
				332	content: {}
				333	404:
				334	description: Specified automation composition definition not found
				335	content: {}
				336	500:
				337	description: Internal Server Error
				338	headers:
				339	X-LatestVersion:
				340	schema:
				341	type: string
				342	X-PatchVersion:
				343	schema:
				344	type: string
				345	X-MinorVersion:
				346	schema:
				347	type: string
				348	X-onap-RequestId:
				349	schema:
				350	type: string
				351	format: uuid
				352	content: {}
				353	security:
				354	- basicAuth: []
				355	x-interface info:
				356	api-version: 1.0.0
				357	last-mod-release: London
				358	put:
				359	tags:
				360	- Automation Composition Controller
				361	summary: Update an automation composition definition
				362	description: Updates an automation composition definition as described in the supplied automation composition defintion, returning the UUID of the automation composition definition updated by this request
				363	operationId: updateCompositionDefinition
				364	parameters:
				365	- name : compositionId
				366	in: path
				367	description: The UUID of the automation composition definition to update
				368	required: true
				369	schema:
				370	type: string
				371	format: uuid
				372	- name: X-onap-RequestId
				373	in: header
				374	description: RequestID for http transaction
				375	schema:
				376	type: string
				377	format: uuid
				378	requestBody:
				379	description: Serialised instance of
				380	[ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
				381	containing the changes to be made to the automation composition definition.
				382	content:
				383	application/json:
				384	schema:
				385	title: ToscaServiceTemplate
				386	type: object
				387	example:
				388	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.json'
				389	application/yaml:
				390	schema:
				391	title: ToscaServiceTemplate
				392	type: object
				393	example:
				394	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.yaml'
				395	required: true
				396	responses:
				397	200:
				398	description: Serialised instance of
				399	[CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
				400	containing the UUID of the automation composition updated by this request
				401	content:
				402	application/json:
				403	schema:
				404	title: CommissioningResponse
				405	type: object
				406	example:
				407	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdateResponse.json'
				408	application/yaml:
				409	schema:
				410	title: CommissioningResponse
				411	type: object
				412	example:
				413	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdateResponse.yaml'
				414	201:
				415	description: Created
				416	content: {}
				417	401:
				418	description: Authentication Error
				419	headers:
				420	X-LatestVersion:
				421	schema:
				422	type: string
				423	X-PatchVersion:
				424	schema:
				425	type: string
				426	X-MinorVersion:
				427	schema:
				428	type: string
				429	X-onap-RequestId:
				430	schema:
				431	type: string
				432	format: uuid
				433	content: {}
				434	403:
				435	description: Authorization Error
				436	headers:
				437	X-LatestVersion:
				438	schema:
				439	type: string
				440	X-PatchVersion:
				441	schema:
				442	type: string
				443	X-MinorVersion:
				444	schema:
				445	type: string
				446	X-onap-RequestId:
				447	schema:
				448	type: string
				449	format: uuid
				450	content: {}
				451	404:
				452	description: Specified automation composition definition not found
				453	content: {}
				454	406:
				455	description: Specified updates to the automation composition definition are not acceptable. See the content for error messages.
				456	content: {}
				457	409:
				458	description: Specified updates to the automation composition definition would cause a conflict and are not allowed
				459	because there are automation composition instances using this automation composition definition. See the content for error messages.
				460	content: {}
				461	500:
				462	description: Internal Server Error
				463	headers:
				464	X-LatestVersion:
				465	schema:
				466	type: string
				467	X-PatchVersion:
				468	schema:
				469	type: string
				470	X-MinorVersion:
				471	schema:
				472	type: string
				473	X-onap-RequestId:
				474	schema:
				475	type: string
				476	format: uuid
				477	content: {}
				478	security:
				479	- basicAuth: []
				480	x-interface info:
				481	api-version: 1.0.0
				482	last-mod-release: London
				483	x-codegen-request-body-name: body
				484	delete:
				485	tags:
				486	- Automation Composition Controller
				487	summary: Delete a commissioned automation composition definition
				488	description: Deletes a commissioned automation composition definition,returning the UUID of the automation composition definition deleted by this request
				489	operationId: deleteCompositionDefinition
				490	parameters:
				491	- name : compositionId
				492	in: path
				493	description: The UUID of the automation composition definition to delete
				494	required: true
				495	schema:
				496	type: string
				497	format: uuid
				498	- name: X-onap-RequestId
				499	in: header
				500	description: RequestID for http transaction
				501	schema:
				502	type: string
				503	format: uuid
				504	responses:
				505	200:
				506	description: Serialised instance of
				507	[CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
				508	containing the UUID of the automation composition deleted by this request
				509	content:
				510	application/json:
				511	schema:
				512	title: CommissioningResponse
				513	type: object
				514	example:
				515	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.json'
				516	application/yaml:
				517	schema:
				518	title: CommissioningResponse
				519	type: object
				520	example:
				521	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.yaml'
				522	401:
				523	description: Authentication Error
				524	headers:
				525	X-LatestVersion:
				526	schema:
				527	type: string
				528	X-PatchVersion:
				529	schema:
				530	type: string
				531	X-MinorVersion:
				532	schema:
				533	type: string
				534	X-onap-RequestId:
				535	schema:
				536	type: string
				537	format: uuid
				538	content: {}
				539	403:
				540	description: Authorization Error
				541	headers:
				542	X-LatestVersion:
				543	schema:
				544	type: string
				545	X-PatchVersion:
				546	schema:
				547	type: string
				548	X-MinorVersion:
				549	schema:
				550	type: string
				551	X-onap-RequestId:
				552	schema:
				553	type: string
				554	format: uuid
				555	content: {}
				556	404:
				557	description: Specified automation composition definition not found
				558	content: {}
				559	409:
				560	description: Deletion of the automation composition definition would cause a conflict and is not allowed
				561	because there are automation composition instances using this automation composition definition.
				562	content: {}
				563	500:
				564	description: Internal Server Error
				565	headers:
				566	X-LatestVersion:
				567	schema:
				568	type: string
				569	X-PatchVersion:
				570	schema:
				571	type: string
				572	X-MinorVersion:
				573	schema:
				574	type: string
				575	X-onap-RequestId:
				576	schema:
				577	type: string
				578	format: uuid
				579	content: {}
				580	security:
				581	- basicAuth: []
				582	x-interface info:
				583	api-version: 1.0.0
				584	last-mod-release: London
				585	/compositions/{compositionId}/instances:
				586	get:
				587	tags:
				588	- Automation Composition Controller
				589	summary: Query details of the requested automation composition instances
				590	description: Query details of the requested automation composition instances for the given automation composition definition ID, returning
				591	details of all its automation composition instances
				592	operationId: queryCompositionInstances
				593	parameters:
				594	- name : compositionId
				595	in: path
				596	description: The UUID of the automation composition definition for which to return instances
				597	required: true
				598	schema:
				599	type: string
				600	format: uuid
				601	- name: name
				602	in: query
				603	description: Automation composition instance name. Regular expressions are supported for filtering. If
				604	this parameter is not specified, all automation composition instances for the specified definition are returned.
				605	schema:
				606	type: string
				607	- name: version
				608	in: query
				609	description: Automation composition instance version. Regular expressions are supported for filtering. If this
				610	parameter is not specified, all automation composition instances for the specified definition that match the "name" filter are are returned.
				611	schema:
				612	type: string
				613	- name: X-onap-RequestId
				614	in: header
				615	description: RequestID for http transaction
				616	schema:
				617	type: string
				618	format: uuid
				619	responses:
				620	200:
				621	description: Serialised instance of
				622	[AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
				623	containing a list of automation composition instances found
				624	content:
				625	application/json:
				626	schema:
				627	title: AutomationCompositions
				628	type: object
				629	example:
				630	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.json'
				631	application/yaml:
				632	schema:
				633	title: AutomationCompositions
				634	type: object
				635	example:
				636	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.yaml'
				637	401:
				638	description: Authentication Error
				639	headers:
				640	X-LatestVersion:
				641	schema:
				642	type: string
				643	X-PatchVersion:
				644	schema:
				645	type: string
				646	X-MinorVersion:
				647	schema:
				648	type: string
				649	X-onap-RequestId:
				650	schema:
				651	type: string
				652	format: uuid
				653	content: {}
				654	403:
				655	description: Authorization Error
				656	headers:
				657	X-LatestVersion:
				658	schema:
				659	type: string
				660	X-PatchVersion:
				661	schema:
				662	type: string
				663	X-MinorVersion:
				664	schema:
				665	type: string
				666	X-onap-RequestId:
				667	schema:
				668	type: string
				669	format: uuid
				670	content: {}
				671	404:
				672	description: The specified automation composition definition was not found
				673	content: {}
				674	500:
				675	description: Internal Server Error
				676	headers:
				677	X-LatestVersion:
				678	schema:
				679	type: string
				680	X-PatchVersion:
				681	schema:
				682	type: string
				683	X-MinorVersion:
				684	schema:
				685	type: string
				686	X-onap-RequestId:
				687	schema:
				688	type: string
				689	format: uuid
				690	content: {}
				691	security:
				692	- basicAuth: []
				693	x-interface info:
				694	api-version: 1.0.0
				695	last-mod-release: London
				696	post:
				697	tags:
				698	- Automation Composition Controller
				699	summary: Create automation composition instances
				700	description: Creates automation composition instances that use the sepcified automation composition definition. The IDs of the created
				701	automation composition instances are returned.
				702	operationId: createCompositionInstances
				703	parameters:
				704	- name : compositionId
				705	in: path
				706	description: The UUID of the automation composition definition on which to create instances
				707	required: true
				708	schema:
				709	type: string
				710	format: uuid
				711	- name: X-onap-RequestId
				712	in: header
				713	description: RequestID for http transaction
				714	schema:
				715	type: string
				716	format: uuid
				717	requestBody:
				718	description: Serialised instance of
				719	[AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
				720	containing a list of automation composition instances to create
				721	content:
				722	application/json:
				723	schema:
				724	title: AutomationCompositions
				725	type: object
				726	example:
				727	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstances.json'
				728	application/yaml:
				729	schema:
				730	title: AutomationCompositions
				731	type: object
				732	example:
				733	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstances.yaml'
				734	required: true
				735	responses:
				736	200:
				737	description: Serialised instance of
				738	[InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
				739	containing the UUIDs of the created automation composition instances
				740	content:
				741	application/json:
				742	schema:
				743	title: InstantiationResponse
				744	type: object
				745	example:
				746	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.json'
				747	application/yaml:
				748	schema:
				749	title: InstantiationResponse
				750	type: object
				751	example:
				752	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.yaml'
				753	201:
				754	description: Created
				755	content: {}
				756	401:
				757	description: Authentication Error
				758	headers:
				759	X-LatestVersion:
				760	schema:
				761	type: string
				762	X-PatchVersion:
				763	schema:
				764	type: string
				765	X-MinorVersion:
				766	schema:
				767	type: string
				768	X-onap-RequestId:
				769	schema:
				770	type: string
				771	format: uuid
				772	content: {}
				773	403:
				774	description: Authorization Error
				775	headers:
				776	X-LatestVersion:
				777	schema:
				778	type: string
				779	X-PatchVersion:
				780	schema:
				781	type: string
				782	X-MinorVersion:
				783	schema:
				784	type: string
				785	X-onap-RequestId:
				786	schema:
				787	type: string
				788	format: uuid
				789	content: {}
				790	404:
				791	description: The specified automation composition definition was not found
				792	content: {}
				793	500:
				794	description: Internal Server Error
				795	headers:
				796	X-LatestVersion:
				797	schema:
				798	type: string
				799	X-PatchVersion:
				800	schema:
				801	type: string
				802	X-MinorVersion:
				803	schema:
				804	type: string
				805	X-onap-RequestId:
				806	schema:
				807	type: string
				808	format: uuid
				809	content: {}
				810	security:
				811	- basicAuth: []
				812	x-interface info:
				813	api-version: 1.0.0
				814	last-mod-release: London
				815	x-codegen-request-body-name: body
				816	/compositions/{compositionId}/instances/{instanceId}:
				817	get:
				818	tags:
				819	- Automation Composition Controller
				820	summary: Get automation composition instance details.
				821	description: Get details of the requested automation composition instance.
				822	operationId: getCompositionInstance
				823	parameters:
				824	- name : compositionId
				825	in: path
				826	description: The UUID of the automation composition definition on which to get an instance
				827	required: true
				828	schema:
				829	type: string
				830	format: uuid
				831	- name : instanceId
				832	in: path
				833	description: The UUID of the automation composition instance to get
				834	required: true
				835	schema:
				836	type: string
				837	format: uuid
				838	- name: X-onap-RequestId
				839	in: header
				840	description: RequestID for http transaction
				841	schema:
				842	type: string
				843	format: uuid
				844	responses:
				845	200:
				846	description: Serialised instance of
				847	[AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
				848	containing a list of automation composition instances with one entry
				849	content:
				850	application/json:
				851	schema:
				852	title: AutomationCompositions
				853	type: object
				854	example:
				855	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstanceResponse.json'
				856	application/yaml:
				857	schema:
				858	title: AutomationCompositions
				859	type: object
				860	example:
				861	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstanceResponse.yaml'
				862	401:
				863	description: Authentication Error
				864	headers:
				865	X-LatestVersion:
				866	schema:
				867	type: string
				868	X-PatchVersion:
				869	schema:
				870	type: string
				871	X-MinorVersion:
				872	schema:
				873	type: string
				874	X-onap-RequestId:
				875	schema:
				876	type: string
				877	format: uuid
				878	content: {}
				879	403:
				880	description: Authorization Error
				881	headers:
				882	X-LatestVersion:
				883	schema:
				884	type: string
				885	X-PatchVersion:
				886	schema:
				887	type: string
				888	X-MinorVersion:
				889	schema:
				890	type: string
				891	X-onap-RequestId:
				892	schema:
				893	type: string
				894	format: uuid
				895	content: {}
				896	404:
				897	description: The automation composition instance was not found
				898	content: {}
				899	500:
				900	description: Internal Server Error
				901	headers:
				902	X-LatestVersion:
				903	schema:
				904	type: string
				905	X-PatchVersion:
				906	schema:
				907	type: string
				908	X-MinorVersion:
				909	schema:
				910	type: string
				911	X-onap-RequestId:
				912	schema:
				913	type: string
				914	format: uuid
				915	content: {}
				916	security:
				917	- basicAuth: []
				918	x-interface info:
				919	api-version: 1.0.0
				920	last-mod-release: London
				921	put:
				922	tags:
				923	- Automation Composition Controller
				924	summary: Update an automation composition instance
				925	description: THis request updates an automation composition instance. It may update instance properties or change the state of the automation composition instance
				926	operationId: updateCompositionInstance
				927	parameters:
				928	- name : compositionId
				929	in: path
				930	description: The UUID of the automation composition definition on which to update an instance
				931	required: true
				932	schema:
				933	type: string
				934	format: uuid
				935	- name : instanceId
				936	in: path
				937	description: The UUID of the automation composition instance to update
				938	required: true
				939	schema:
				940	type: string
				941	format: uuid
				942	- name: X-onap-RequestId
				943	in: header
				944	description: RequestID for http transaction
				945	schema:
				946	type: string
				947	format: uuid
				948	requestBody:
				949	description: Serialised instance of
				950	[InstantiationUpdate](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationUpdate.java)
				951	which specifies the update operation to be carried out on the automation concept instance
				952	content:
				953	application/json:
				954	schema:
				955	title: InstantiationUpdate
				956	type: object
				957	example:
				958	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdate.json'
				959	application/yaml:
				960	schema:
				961	title: InstantiationUpdate
				962	type: object
				963	example:
				964	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdate.yaml'
				965	required: true
				966	responses:
				967	200:
				968	description: Serialised instance of
				969	[InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
				970	containing the UUID of the updated automation composition instance
				971	content:
				972	application/json:
				973	schema:
				974	title: InstantiationResponse
				975	type: object
				976	example:
				977	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdateResponse.json'
				978	application/yaml:
				979	schema:
				980	title: InstantiationResponse
				981	type: object
				982	example:
				983	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdateResponse.yaml'
				984	201:
				985	description: Created
				986	content: {}
				987	401:
				988	description: Authentication Error
				989	headers:
				990	X-LatestVersion:
				991	schema:
				992	type: string
				993	X-PatchVersion:
				994	schema:
				995	type: string
				996	X-MinorVersion:
				997	schema:
				998	type: string
				999	X-onap-RequestId:
				1000	schema:
				1001	type: string
				1002	format: uuid
				1003	content: {}
				1004	403:
				1005	description: Authorization Error
				1006	headers:
				1007	X-LatestVersion:
				1008	schema:
				1009	type: string
				1010	X-PatchVersion:
				1011	schema:
				1012	type: string
				1013	X-MinorVersion:
				1014	schema:
				1015	type: string
				1016	X-onap-RequestId:
				1017	schema:
				1018	type: string
				1019	format: uuid
				1020	content: {}
				1021	404:
				1022	description: The specified automation composition instance was not found
				1023	content: {}
				1024	406:
				1025	description: Specified updates to the automation composition instance are not acceptable. See the content for error messages.
				1026	content: {}
				1027	409:
				1028	description: Update of this automation composition instance would cause a conflict because the automation composition instance is deployed.
				1029	Update is not allowed. See the content for error messages.
				1030	content: {}
				1031	500:
				1032	description: Internal Server Error
				1033	headers:
				1034	X-LatestVersion:
				1035	schema:
				1036	type: string
				1037	X-PatchVersion:
				1038	schema:
				1039	type: string
				1040	X-MinorVersion:
				1041	schema:
				1042	type: string
				1043	X-onap-RequestId:
				1044	schema:
				1045	type: string
				1046	format: uuid
				1047	content: {}
				1048	security:
				1049	- basicAuth: []
				1050	x-interface info:
				1051	api-version: 1.0.0
				1052	last-mod-release: London
				1053	x-codegen-request-body-name: body
				1054	delete:
				1055	tags:
				1056	- Automation Composition Controller
				1057	summary: Delete an automation composition instance
				1058	description: Deletes a automation composition instance, returning the UUID of the deleted automation composition instance
				1059	operationId: deleteCompositionInstance
				1060	parameters:
				1061	- name : compositionId
				1062	in: path
				1063	description: The UUID of the automation composition definition on which to delete an instance
				1064	required: true
				1065	schema:
				1066	type: string
				1067	format: uuid
				1068	- name : instanceId
				1069	in: path
				1070	description: The UUID of the automation composition instance to delete
				1071	required: true
				1072	schema:
				1073	type: string
				1074	format: uuid
				1075	- name: X-onap-RequestId
				1076	in: header
				1077	description: RequestID for http transaction
				1078	schema:
				1079	type: string
				1080	format: uuid
				1081	responses:
				1082	200:
				1083	description: Serialised instance of
				1084	[InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
				1085	containing the UUID of the deleted automation composition instance
				1086	content:
				1087	application/json:
				1088	schema:
				1089	title: InstantiationResponse
				1090	type: object
				1091	example:
				1092	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.json'
				1093	application/yaml:
				1094	schema:
				1095	title: InstantiationResponse
				1096	type: object
				1097	example:
				1098	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.yaml'
				1099	401:
				1100	description: Authentication Error
				1101	headers:
				1102	X-LatestVersion:
				1103	schema:
				1104	type: string
				1105	X-PatchVersion:
				1106	schema:
				1107	type: string
				1108	X-MinorVersion:
				1109	schema:
				1110	type: string
				1111	X-onap-RequestId:
				1112	schema:
				1113	type: string
				1114	format: uuid
				1115	content: {}
				1116	403:
				1117	description: Authorization Error
				1118	headers:
				1119	X-LatestVersion:
				1120	schema:
				1121	type: string
				1122	X-PatchVersion:
				1123	schema:
				1124	type: string
				1125	X-MinorVersion:
				1126	schema:
				1127	type: string
				1128	X-onap-RequestId:
				1129	schema:
				1130	type: string
				1131	format: uuid
				1132	content: {}
				1133	404:
				1134	description: The specified automation composition instance was not found
				1135	content: {}
				1136	409:
				1137	description: Deletion of this automation composition instance would cause a conflict because the automation composition instance is deployed.
				1138	Deletion is not allowed. See the content for error messages.
				1139	content: {}
				1140	500:
				1141	description: Internal Server Error
				1142	headers:
				1143	X-LatestVersion:
				1144	schema:
				1145	type: string
				1146	X-PatchVersion:
				1147	schema:
				1148	type: string
				1149	X-MinorVersion:
				1150	schema:
				1151	type: string
				1152	X-onap-RequestId:
				1153	schema:
				1154	type: string
				1155	format: uuid
				1156	content: {}
				1157	security:
				1158	- basicAuth: []
				1159	x-interface info:
				1160	api-version: 1.0.0
				1161	last-mod-release: London
				1162
				1163	components:
				1164	securitySchemes:
				1165	basicAuth:
				1166	type: http
				1167	scheme: basic