Blame - docs/openapi/components.yml - onap/cps/ncmp-dmi-plugin

blob: 736639d8c87aa1b8594f662ea7065e5cad727b3d [file] [log] [blame]

DylanB95EST	b5a2383	2021-06-02 19:45:46 +0100	[diff] [blame]	1	components:
				2	schemas:
				3	ErrorMessage:
				4	type: object
				5	title: Error
				6	properties:
				7	status:
				8	type: string
				9	message:
				10	type: string
				11	details:
				12	type: string
				13
tragait	2270d76	2021-07-08 15:42:19 +0100	[diff] [blame]	14	CmHandles:
				15	type: object
				16	properties:
				17	cmHandles:
				18	type: array
				19	items:
				20	type: string
				21
tragait	400b6c7	2021-09-22 10:50:15 +0100	[diff] [blame]	22	DmiModuleReadRequestBody:
niamhcore	3139ece	2021-07-30 16:25:16 +0100	[diff] [blame]	23	type: object
				24	properties:
				25	operation:
				26	type: string
				27	enum: [read]
tragait	400b6c7	2021-09-22 10:50:15 +0100	[diff] [blame]	28	dataType:
				29	type: string
niamhcore	3139ece	2021-07-30 16:25:16 +0100	[diff] [blame]	30	data:
				31	type: object
				32	properties:
				33	modules:
				34	type: array
				35	items:
				36	type: object
				37	properties:
				38	name:
				39	type: string
				40	revision:
				41	type: string
				42	cmHandleProperties:
				43	type: object
				44	additionalProperties:
				45	type: string
				46	example: system-001
				47
niamhcore	577efb0	2021-08-11 16:13:53 +0100	[diff] [blame]	48	ModuleSet:
				49	type: object
				50	properties:
				51	schemas:
				52	type: array
				53	items:
				54	type: object
				55	properties:
				56	moduleName:
				57	type: string
				58	revision:
				59	type: string
				60	namespace:
				61	type: string
				62
niamhcore	4f43188	2021-09-21 16:08:29 +0100	[diff] [blame]	63	YangResources:
				64	type: array
				65	items:
				66	type: object
				67	$ref: '#/components/schemas/YangResource'
				68
				69	YangResource:
				70	properties:
				71	yangSource:
				72	type: string
				73	moduleName:
				74	type: string
				75	revision:
				76	type: string
				77
niamhcore	79e41e0	2021-08-20 11:24:06 +0100	[diff] [blame]	78	DataAccessReadRequest:
tragait	e398be5	2021-08-06 17:01:31 +0100	[diff] [blame]	79	type: object
				80	properties:
				81	operation:
				82	type: string
				83	enum: [ read ]
				84	cmHandleProperties:
				85	type: object
				86	additionalProperties:
				87	type: string
				88
niamhcore	79e41e0	2021-08-20 11:24:06 +0100	[diff] [blame]	89	DataAccessWriteRequest:
				90	type: object
				91	properties:
				92	operation:
				93	type: string
				94	enum: [ create ]
				95	dataType:
				96	type: string
				97	data:
tragait	fa11e9c	2021-09-14 13:47:52 +0100	[diff] [blame]	98	type: string
niamhcore	79e41e0	2021-08-20 11:24:06 +0100	[diff] [blame]	99	cmHandleProperties:
				100	type: object
				101	additionalProperties:
				102	type: string
				103
DylanB95EST	b5a2383	2021-06-02 19:45:46 +0100	[diff] [blame]	104	responses:
				105	NotFound:
				106	description: The specified resource was not found
				107	content:
				108	application/json:
				109	schema:
				110	$ref: '#/components/schemas/ErrorMessage'
				111	Unauthorized:
				112	description: Unauthorized
				113	content:
				114	application/json:
				115	schema:
				116	$ref: '#/components/schemas/ErrorMessage'
				117	Forbidden:
				118	description: Forbidden
				119	content:
				120	application/json:
				121	schema:
				122	$ref: '#/components/schemas/ErrorMessage'
				123	BadRequest:
				124	description: Bad Request
				125	content:
				126	application/json:
				127	schema:
				128	$ref: '#/components/schemas/ErrorMessage'
				129	Conflict:
				130	description: Conflict
				131	content:
				132	application/json:
				133	schema:
				134	$ref: '#/components/schemas/ErrorMessage'
				135	Ok:
				136	description: OK
				137	content:
				138	application/json:
				139	schema:
				140	type: object
				141	Created:
				142	description: Created
				143	content:
				144	text/plain:
				145	schema:
				146	type: string
				147	NoContent:
				148	description: No Content
				149	content: {}
niamhcore	3139ece	2021-07-30 16:25:16 +0100	[diff] [blame]	150
				151	parameters:
				152	cmHandleInPath:
				153	name: cmHandle
				154	in: path
				155	description: The identifier for a network function, network element, subnetwork, or any other cm object by managed Network CM Proxy
				156	required: true
				157	schema:
tragait	f01d567	2021-08-19 11:19:54 +0100	[diff] [blame]	158	type: string
				159
niamhcore	2fb3f66	2021-09-29 15:32:32 +0100	[diff] [blame^]	160	resourceIdentifierInQuery:
tragait	f01d567	2021-08-19 11:19:54 +0100	[diff] [blame]	161	name: resourceIdentifier
niamhcore	2fb3f66	2021-09-29 15:32:32 +0100	[diff] [blame^]	162	in: query
tragait	f01d567	2021-08-19 11:19:54 +0100	[diff] [blame]	163	description: Resource identifier to get/set the resource data
				164	required: true
niamhcore	2fb3f66	2021-09-29 15:32:32 +0100	[diff] [blame^]	165	allowReserved: true
tragait	f01d567	2021-08-19 11:19:54 +0100	[diff] [blame]	166	schema:
				167	type: string
				168
				169	acceptParamInHeader:
				170	name: accept
				171	in: header
				172	description: Accept parameter for response, if accept parameter is null, that means client can accept any format.
				173	schema:
				174	type: string
				175	enum: [ application/json, application/yang-data+json ]
				176
				177	fieldsParamInQuery:
				178	name: fields
				179	in: query
				180	description: Fields parameter to filter resource
				181	required: false
				182	schema:
				183	type: string
				184
				185	depthParamInQuery:
				186	name: depth
				187	in: query
				188	description: Depth parameter for response
				189	required: false
				190	schema:
				191	type: integer
				192	minimum: 1