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

blob: dfa8ec6d174ad7ca479ad3ba2d101fefb5cf2384 [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: {}
lapentafd	41fcf35	2022-11-09 11:05:52 +0000	[diff] [blame^]	234	406:
				235	description: Specified automation composition definition is not acceptable. See the content for error messages.
				236	content: {}
lapentafd	16e6e7e	2022-11-02 10:08:16 +0000	[diff] [blame]	237	500:
				238	description: Internal Server Error
				239	headers:
				240	X-LatestVersion:
				241	schema:
				242	type: string
				243	X-PatchVersion:
				244	schema:
				245	type: string
				246	X-MinorVersion:
				247	schema:
				248	type: string
				249	X-onap-RequestId:
				250	schema:
				251	type: string
				252	format: uuid
				253	content: {}
				254	security:
				255	- basicAuth: []
				256	x-interface info:
				257	api-version: 1.0.0
				258	last-mod-release: London
				259	x-codegen-request-body-name: body
				260	/compositions/{compositionId}:
				261	get:
				262	tags:
				263	- Automation Composition Controller
				264	summary: Get details of the requested commissioned automation composition
				265	definitions
				266	description: Get details of the requested commissioned automation composition
				267	definitions, returning all automation composition details
				268	operationId: getCompositionDefinition
				269	parameters:
				270	- name : compositionId
				271	in: path
				272	description: The UUID of the automation composition definition to get
				273	required: true
				274	schema:
				275	type: string
				276	format: uuid
				277	- name: X-onap-RequestId
				278	in: header
				279	description: RequestID for http transaction
				280	schema:
				281	type: string
				282	format: uuid
				283	responses:
				284	200:
				285	description:
				286	Serialised instance of
				287	[ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
				288	containing the requested automation composition definition.
				289	content:
				290	application/json:
				291	schema:
				292	title: ToscaServiceTemplate
				293	type: object
				294	example:
				295	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.json'
				296	application/yaml:
				297	schema:
				298	title: ToscaServiceTemplate
				299	type: object
				300	example:
				301	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.yaml'
				302	401:
				303	description: Authentication Error
				304	headers:
				305	X-LatestVersion:
				306	schema:
				307	type: string
				308	X-PatchVersion:
				309	schema:
				310	type: string
				311	X-MinorVersion:
				312	schema:
				313	type: string
				314	X-onap-RequestId:
				315	schema:
				316	type: string
				317	format: uuid
				318	content: {}
				319	403:
				320	description: Authorization Error
				321	headers:
				322	X-LatestVersion:
				323	schema:
				324	type: string
				325	X-PatchVersion:
				326	schema:
				327	type: string
				328	X-MinorVersion:
				329	schema:
				330	type: string
				331	X-onap-RequestId:
				332	schema:
				333	type: string
				334	format: uuid
				335	content: {}
				336	404:
				337	description: Specified automation composition definition not found
				338	content: {}
				339	500:
				340	description: Internal Server Error
				341	headers:
				342	X-LatestVersion:
				343	schema:
				344	type: string
				345	X-PatchVersion:
				346	schema:
				347	type: string
				348	X-MinorVersion:
				349	schema:
				350	type: string
				351	X-onap-RequestId:
				352	schema:
				353	type: string
				354	format: uuid
				355	content: {}
				356	security:
				357	- basicAuth: []
				358	x-interface info:
				359	api-version: 1.0.0
				360	last-mod-release: London
				361	put:
				362	tags:
				363	- Automation Composition Controller
				364	summary: Update an automation composition definition
				365	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
				366	operationId: updateCompositionDefinition
				367	parameters:
				368	- name : compositionId
				369	in: path
				370	description: The UUID of the automation composition definition to update
				371	required: true
				372	schema:
				373	type: string
				374	format: uuid
				375	- name: X-onap-RequestId
				376	in: header
				377	description: RequestID for http transaction
				378	schema:
				379	type: string
				380	format: uuid
				381	requestBody:
				382	description: Serialised instance of
				383	[ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
				384	containing the changes to be made to the automation composition definition.
				385	content:
				386	application/json:
				387	schema:
				388	title: ToscaServiceTemplate
				389	type: object
				390	example:
				391	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.json'
				392	application/yaml:
				393	schema:
				394	title: ToscaServiceTemplate
				395	type: object
				396	example:
				397	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.yaml'
				398	required: true
				399	responses:
				400	200:
				401	description: Serialised instance of
				402	[CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
				403	containing the UUID of the automation composition updated by this request
				404	content:
				405	application/json:
				406	schema:
				407	title: CommissioningResponse
				408	type: object
				409	example:
				410	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdateResponse.json'
				411	application/yaml:
				412	schema:
				413	title: CommissioningResponse
				414	type: object
				415	example:
				416	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdateResponse.yaml'
				417	201:
				418	description: Created
				419	content: {}
				420	401:
				421	description: Authentication Error
				422	headers:
				423	X-LatestVersion:
				424	schema:
				425	type: string
				426	X-PatchVersion:
				427	schema:
				428	type: string
				429	X-MinorVersion:
				430	schema:
				431	type: string
				432	X-onap-RequestId:
				433	schema:
				434	type: string
				435	format: uuid
				436	content: {}
				437	403:
				438	description: Authorization Error
				439	headers:
				440	X-LatestVersion:
				441	schema:
				442	type: string
				443	X-PatchVersion:
				444	schema:
				445	type: string
				446	X-MinorVersion:
				447	schema:
				448	type: string
				449	X-onap-RequestId:
				450	schema:
				451	type: string
				452	format: uuid
				453	content: {}
				454	404:
				455	description: Specified automation composition definition not found
				456	content: {}
				457	406:
				458	description: Specified updates to the automation composition definition are not acceptable. See the content for error messages.
				459	content: {}
				460	409:
				461	description: Specified updates to the automation composition definition would cause a conflict and are not allowed
				462	because there are automation composition instances using this automation composition definition. See the content for error messages.
				463	content: {}
				464	500:
				465	description: Internal Server Error
				466	headers:
				467	X-LatestVersion:
				468	schema:
				469	type: string
				470	X-PatchVersion:
				471	schema:
				472	type: string
				473	X-MinorVersion:
				474	schema:
				475	type: string
				476	X-onap-RequestId:
				477	schema:
				478	type: string
				479	format: uuid
				480	content: {}
				481	security:
				482	- basicAuth: []
				483	x-interface info:
				484	api-version: 1.0.0
				485	last-mod-release: London
				486	x-codegen-request-body-name: body
				487	delete:
				488	tags:
				489	- Automation Composition Controller
				490	summary: Delete a commissioned automation composition definition
				491	description: Deletes a commissioned automation composition definition,returning the UUID of the automation composition definition deleted by this request
				492	operationId: deleteCompositionDefinition
				493	parameters:
				494	- name : compositionId
				495	in: path
				496	description: The UUID of the automation composition definition to delete
				497	required: true
				498	schema:
				499	type: string
				500	format: uuid
				501	- name: X-onap-RequestId
				502	in: header
				503	description: RequestID for http transaction
				504	schema:
				505	type: string
				506	format: uuid
				507	responses:
				508	200:
				509	description: Serialised instance of
				510	[CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
				511	containing the UUID of the automation composition deleted by this request
				512	content:
				513	application/json:
				514	schema:
				515	title: CommissioningResponse
				516	type: object
				517	example:
				518	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.json'
				519	application/yaml:
				520	schema:
				521	title: CommissioningResponse
				522	type: object
				523	example:
				524	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.yaml'
				525	401:
				526	description: Authentication Error
				527	headers:
				528	X-LatestVersion:
				529	schema:
				530	type: string
				531	X-PatchVersion:
				532	schema:
				533	type: string
				534	X-MinorVersion:
				535	schema:
				536	type: string
				537	X-onap-RequestId:
				538	schema:
				539	type: string
				540	format: uuid
				541	content: {}
				542	403:
				543	description: Authorization Error
				544	headers:
				545	X-LatestVersion:
				546	schema:
				547	type: string
				548	X-PatchVersion:
				549	schema:
				550	type: string
				551	X-MinorVersion:
				552	schema:
				553	type: string
				554	X-onap-RequestId:
				555	schema:
				556	type: string
				557	format: uuid
				558	content: {}
				559	404:
				560	description: Specified automation composition definition not found
				561	content: {}
				562	409:
				563	description: Deletion of the automation composition definition would cause a conflict and is not allowed
				564	because there are automation composition instances using this automation composition definition.
				565	content: {}
				566	500:
				567	description: Internal Server Error
				568	headers:
				569	X-LatestVersion:
				570	schema:
				571	type: string
				572	X-PatchVersion:
				573	schema:
				574	type: string
				575	X-MinorVersion:
				576	schema:
				577	type: string
				578	X-onap-RequestId:
				579	schema:
				580	type: string
				581	format: uuid
				582	content: {}
				583	security:
				584	- basicAuth: []
				585	x-interface info:
				586	api-version: 1.0.0
				587	last-mod-release: London
				588	/compositions/{compositionId}/instances:
				589	get:
				590	tags:
				591	- Automation Composition Controller
				592	summary: Query details of the requested automation composition instances
				593	description: Query details of the requested automation composition instances for the given automation composition definition ID, returning
				594	details of all its automation composition instances
				595	operationId: queryCompositionInstances
				596	parameters:
				597	- name : compositionId
				598	in: path
				599	description: The UUID of the automation composition definition for which to return instances
				600	required: true
				601	schema:
				602	type: string
				603	format: uuid
				604	- name: name
				605	in: query
				606	description: Automation composition instance name. Regular expressions are supported for filtering. If
				607	this parameter is not specified, all automation composition instances for the specified definition are returned.
				608	schema:
				609	type: string
				610	- name: version
				611	in: query
				612	description: Automation composition instance version. Regular expressions are supported for filtering. If this
				613	parameter is not specified, all automation composition instances for the specified definition that match the "name" filter are are returned.
				614	schema:
				615	type: string
				616	- name: X-onap-RequestId
				617	in: header
				618	description: RequestID for http transaction
				619	schema:
				620	type: string
				621	format: uuid
				622	responses:
				623	200:
				624	description: Serialised instance of
				625	[AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
				626	containing a list of automation composition instances found
				627	content:
				628	application/json:
				629	schema:
				630	title: AutomationCompositions
				631	type: object
				632	example:
				633	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.json'
				634	application/yaml:
				635	schema:
				636	title: AutomationCompositions
				637	type: object
				638	example:
				639	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.yaml'
				640	401:
				641	description: Authentication Error
				642	headers:
				643	X-LatestVersion:
				644	schema:
				645	type: string
				646	X-PatchVersion:
				647	schema:
				648	type: string
				649	X-MinorVersion:
				650	schema:
				651	type: string
				652	X-onap-RequestId:
				653	schema:
				654	type: string
				655	format: uuid
				656	content: {}
				657	403:
				658	description: Authorization Error
				659	headers:
				660	X-LatestVersion:
				661	schema:
				662	type: string
				663	X-PatchVersion:
				664	schema:
				665	type: string
				666	X-MinorVersion:
				667	schema:
				668	type: string
				669	X-onap-RequestId:
				670	schema:
				671	type: string
				672	format: uuid
				673	content: {}
				674	404:
				675	description: The specified automation composition definition was not found
				676	content: {}
				677	500:
				678	description: Internal Server Error
				679	headers:
				680	X-LatestVersion:
				681	schema:
				682	type: string
				683	X-PatchVersion:
				684	schema:
				685	type: string
				686	X-MinorVersion:
				687	schema:
				688	type: string
				689	X-onap-RequestId:
				690	schema:
				691	type: string
				692	format: uuid
				693	content: {}
				694	security:
				695	- basicAuth: []
				696	x-interface info:
				697	api-version: 1.0.0
				698	last-mod-release: London
				699	post:
				700	tags:
				701	- Automation Composition Controller
				702	summary: Create automation composition instances
				703	description: Creates automation composition instances that use the sepcified automation composition definition. The IDs of the created
				704	automation composition instances are returned.
				705	operationId: createCompositionInstances
				706	parameters:
				707	- name : compositionId
				708	in: path
				709	description: The UUID of the automation composition definition on which to create instances
				710	required: true
				711	schema:
				712	type: string
				713	format: uuid
				714	- name: X-onap-RequestId
				715	in: header
				716	description: RequestID for http transaction
				717	schema:
				718	type: string
				719	format: uuid
				720	requestBody:
				721	description: Serialised instance of
				722	[AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
				723	containing a list of automation composition instances to create
				724	content:
				725	application/json:
				726	schema:
				727	title: AutomationCompositions
				728	type: object
				729	example:
				730	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstances.json'
				731	application/yaml:
				732	schema:
				733	title: AutomationCompositions
				734	type: object
				735	example:
				736	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstances.yaml'
				737	required: true
				738	responses:
				739	200:
				740	description: Serialised instance of
				741	[InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
				742	containing the UUIDs of the created automation composition instances
				743	content:
				744	application/json:
				745	schema:
				746	title: InstantiationResponse
				747	type: object
				748	example:
				749	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.json'
				750	application/yaml:
				751	schema:
				752	title: InstantiationResponse
				753	type: object
				754	example:
				755	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.yaml'
				756	201:
				757	description: Created
				758	content: {}
				759	401:
				760	description: Authentication Error
				761	headers:
				762	X-LatestVersion:
				763	schema:
				764	type: string
				765	X-PatchVersion:
				766	schema:
				767	type: string
				768	X-MinorVersion:
				769	schema:
				770	type: string
				771	X-onap-RequestId:
				772	schema:
				773	type: string
				774	format: uuid
				775	content: {}
				776	403:
				777	description: Authorization Error
				778	headers:
				779	X-LatestVersion:
				780	schema:
				781	type: string
				782	X-PatchVersion:
				783	schema:
				784	type: string
				785	X-MinorVersion:
				786	schema:
				787	type: string
				788	X-onap-RequestId:
				789	schema:
				790	type: string
				791	format: uuid
				792	content: {}
				793	404:
				794	description: The specified automation composition definition was not found
				795	content: {}
lapentafd	41fcf35	2022-11-09 11:05:52 +0000	[diff] [blame^]	796	406:
				797	description: Specified automation composition instance definition is not acceptable. See the content for error messages.
				798	content: {}
lapentafd	16e6e7e	2022-11-02 10:08:16 +0000	[diff] [blame]	799	500:
				800	description: Internal Server Error
				801	headers:
				802	X-LatestVersion:
				803	schema:
				804	type: string
				805	X-PatchVersion:
				806	schema:
				807	type: string
				808	X-MinorVersion:
				809	schema:
				810	type: string
				811	X-onap-RequestId:
				812	schema:
				813	type: string
				814	format: uuid
				815	content: {}
				816	security:
				817	- basicAuth: []
				818	x-interface info:
				819	api-version: 1.0.0
				820	last-mod-release: London
				821	x-codegen-request-body-name: body
				822	/compositions/{compositionId}/instances/{instanceId}:
				823	get:
				824	tags:
				825	- Automation Composition Controller
				826	summary: Get automation composition instance details.
				827	description: Get details of the requested automation composition instance.
				828	operationId: getCompositionInstance
				829	parameters:
				830	- name : compositionId
				831	in: path
				832	description: The UUID of the automation composition definition on which to get an instance
				833	required: true
				834	schema:
				835	type: string
				836	format: uuid
				837	- name : instanceId
				838	in: path
				839	description: The UUID of the automation composition instance to get
				840	required: true
				841	schema:
				842	type: string
				843	format: uuid
				844	- name: X-onap-RequestId
				845	in: header
				846	description: RequestID for http transaction
				847	schema:
				848	type: string
				849	format: uuid
				850	responses:
				851	200:
				852	description: Serialised instance of
				853	[AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
				854	containing a list of automation composition instances with one entry
				855	content:
				856	application/json:
				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.json'
				862	application/yaml:
				863	schema:
				864	title: AutomationCompositions
				865	type: object
				866	example:
				867	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstanceResponse.yaml'
				868	401:
				869	description: Authentication Error
				870	headers:
				871	X-LatestVersion:
				872	schema:
				873	type: string
				874	X-PatchVersion:
				875	schema:
				876	type: string
				877	X-MinorVersion:
				878	schema:
				879	type: string
				880	X-onap-RequestId:
				881	schema:
				882	type: string
				883	format: uuid
				884	content: {}
				885	403:
				886	description: Authorization Error
				887	headers:
				888	X-LatestVersion:
				889	schema:
				890	type: string
				891	X-PatchVersion:
				892	schema:
				893	type: string
				894	X-MinorVersion:
				895	schema:
				896	type: string
				897	X-onap-RequestId:
				898	schema:
				899	type: string
				900	format: uuid
				901	content: {}
				902	404:
				903	description: The automation composition instance was not found
				904	content: {}
				905	500:
				906	description: Internal Server Error
				907	headers:
				908	X-LatestVersion:
				909	schema:
				910	type: string
				911	X-PatchVersion:
				912	schema:
				913	type: string
				914	X-MinorVersion:
				915	schema:
				916	type: string
				917	X-onap-RequestId:
				918	schema:
				919	type: string
				920	format: uuid
				921	content: {}
				922	security:
				923	- basicAuth: []
				924	x-interface info:
				925	api-version: 1.0.0
				926	last-mod-release: London
				927	put:
				928	tags:
				929	- Automation Composition Controller
				930	summary: Update an automation composition instance
lapentafd	41fcf35	2022-11-09 11:05:52 +0000	[diff] [blame^]	931	description: This request updates an automation composition instance. It may update instance properties or change the state of the automation composition instance
lapentafd	16e6e7e	2022-11-02 10:08:16 +0000	[diff] [blame]	932	operationId: updateCompositionInstance
				933	parameters:
				934	- name : compositionId
				935	in: path
				936	description: The UUID of the automation composition definition on which to update an instance
				937	required: true
				938	schema:
				939	type: string
				940	format: uuid
				941	- name : instanceId
				942	in: path
				943	description: The UUID of the automation composition instance to update
				944	required: true
				945	schema:
				946	type: string
				947	format: uuid
				948	- name: X-onap-RequestId
				949	in: header
				950	description: RequestID for http transaction
				951	schema:
				952	type: string
				953	format: uuid
				954	requestBody:
				955	description: Serialised instance of
				956	[InstantiationUpdate](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationUpdate.java)
				957	which specifies the update operation to be carried out on the automation concept instance
				958	content:
				959	application/json:
				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.json'
				965	application/yaml:
				966	schema:
				967	title: InstantiationUpdate
				968	type: object
				969	example:
				970	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdate.yaml'
				971	required: true
				972	responses:
				973	200:
				974	description: Serialised instance of
				975	[InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
				976	containing the UUID of the updated automation composition instance
				977	content:
				978	application/json:
				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.json'
				984	application/yaml:
				985	schema:
				986	title: InstantiationResponse
				987	type: object
				988	example:
				989	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdateResponse.yaml'
				990	201:
				991	description: Created
				992	content: {}
				993	401:
				994	description: Authentication Error
				995	headers:
				996	X-LatestVersion:
				997	schema:
				998	type: string
				999	X-PatchVersion:
				1000	schema:
				1001	type: string
				1002	X-MinorVersion:
				1003	schema:
				1004	type: string
				1005	X-onap-RequestId:
				1006	schema:
				1007	type: string
				1008	format: uuid
				1009	content: {}
				1010	403:
				1011	description: Authorization Error
				1012	headers:
				1013	X-LatestVersion:
				1014	schema:
				1015	type: string
				1016	X-PatchVersion:
				1017	schema:
				1018	type: string
				1019	X-MinorVersion:
				1020	schema:
				1021	type: string
				1022	X-onap-RequestId:
				1023	schema:
				1024	type: string
				1025	format: uuid
				1026	content: {}
				1027	404:
				1028	description: The specified automation composition instance was not found
				1029	content: {}
				1030	406:
				1031	description: Specified updates to the automation composition instance are not acceptable. See the content for error messages.
				1032	content: {}
				1033	409:
				1034	description: Update of this automation composition instance would cause a conflict because the automation composition instance is deployed.
				1035	Update is not allowed. See the content for error messages.
				1036	content: {}
				1037	500:
				1038	description: Internal Server Error
				1039	headers:
				1040	X-LatestVersion:
				1041	schema:
				1042	type: string
				1043	X-PatchVersion:
				1044	schema:
				1045	type: string
				1046	X-MinorVersion:
				1047	schema:
				1048	type: string
				1049	X-onap-RequestId:
				1050	schema:
				1051	type: string
				1052	format: uuid
				1053	content: {}
				1054	security:
				1055	- basicAuth: []
				1056	x-interface info:
				1057	api-version: 1.0.0
				1058	last-mod-release: London
				1059	x-codegen-request-body-name: body
				1060	delete:
				1061	tags:
				1062	- Automation Composition Controller
				1063	summary: Delete an automation composition instance
				1064	description: Deletes a automation composition instance, returning the UUID of the deleted automation composition instance
				1065	operationId: deleteCompositionInstance
				1066	parameters:
				1067	- name : compositionId
				1068	in: path
				1069	description: The UUID of the automation composition definition on which to delete an instance
				1070	required: true
				1071	schema:
				1072	type: string
				1073	format: uuid
				1074	- name : instanceId
				1075	in: path
				1076	description: The UUID of the automation composition instance to delete
				1077	required: true
				1078	schema:
				1079	type: string
				1080	format: uuid
				1081	- name: X-onap-RequestId
				1082	in: header
				1083	description: RequestID for http transaction
				1084	schema:
				1085	type: string
				1086	format: uuid
				1087	responses:
				1088	200:
				1089	description: Serialised instance of
				1090	[InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
				1091	containing the UUID of the deleted automation composition instance
				1092	content:
				1093	application/json:
				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.json'
				1099	application/yaml:
				1100	schema:
				1101	title: InstantiationResponse
				1102	type: object
				1103	example:
				1104	externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.yaml'
				1105	401:
				1106	description: Authentication Error
				1107	headers:
				1108	X-LatestVersion:
				1109	schema:
				1110	type: string
				1111	X-PatchVersion:
				1112	schema:
				1113	type: string
				1114	X-MinorVersion:
				1115	schema:
				1116	type: string
				1117	X-onap-RequestId:
				1118	schema:
				1119	type: string
				1120	format: uuid
				1121	content: {}
				1122	403:
				1123	description: Authorization Error
				1124	headers:
				1125	X-LatestVersion:
				1126	schema:
				1127	type: string
				1128	X-PatchVersion:
				1129	schema:
				1130	type: string
				1131	X-MinorVersion:
				1132	schema:
				1133	type: string
				1134	X-onap-RequestId:
				1135	schema:
				1136	type: string
				1137	format: uuid
				1138	content: {}
				1139	404:
				1140	description: The specified automation composition instance was not found
				1141	content: {}
				1142	409:
				1143	description: Deletion of this automation composition instance would cause a conflict because the automation composition instance is deployed.
				1144	Deletion is not allowed. See the content for error messages.
				1145	content: {}
				1146	500:
				1147	description: Internal Server Error
				1148	headers:
				1149	X-LatestVersion:
				1150	schema:
				1151	type: string
				1152	X-PatchVersion:
				1153	schema:
				1154	type: string
				1155	X-MinorVersion:
				1156	schema:
				1157	type: string
				1158	X-onap-RequestId:
				1159	schema:
				1160	type: string
				1161	format: uuid
				1162	content: {}
				1163	security:
				1164	- basicAuth: []
				1165	x-interface info:
				1166	api-version: 1.0.0
				1167	last-mod-release: London
				1168
				1169	components:
				1170	securitySchemes:
				1171	basicAuth:
				1172	type: http
				1173	scheme: basic