ovpay/src/openapi/products/purchased_products-crud.yaml

114 lines
3.2 KiB
YAML

openapi: "3.0.3"
info:
title: ABT Purchased Products CRUD APIs
version: "1.0"
description: CRUD APIs for ABT Purchased Products database. These are NOT the functional APIs from Service Engine.
servers:
- url: https://api.integratielaag.nl/v1
paths:
/purchasedproducts:
get:
tags:
- Purchased Product
summary: Find purchased products.
description: Find purchased products.
responses:
"200":
description: OK
post:
tags:
- Purchased Product
summary: Create a new purchased product.
description: Create a new purchased product.
responses:
"201":
description: Created
/purchasedproducts/{purchasedProductId}:
parameters:
- in: path
name: purchasedProductId
schema:
type: string
format: uuid
example: 058a1af7-897f-45d5-b691-9cc9161e387f
required: true
description: The id of the purchased product to process.
get:
tags:
- Purchased Product
summary: Get a single purchased product.
description: Get a single purchased product.
responses:
"200":
description: OK
patch:
tags:
- Purchased Product
summary: Update a purchased product.
description: Update a purchased product.
responses:
"200":
description: OK
/purchasedproducts/{purchasedProductId}/resources:
parameters:
- in: path
name: purchasedProductId
schema:
type: string
format: uuid
example: 058a1af7-897f-45d5-b691-9cc9161e387f
required: true
description: The id of the purchased product to process.
post:
tags:
- Purchased Product
summary: Add a resource to a purchased product.
description: Add a resource to a purchased product.
responses:
"201":
description: Created
/purchasedproducts/{purchasedProductId}/gboproducts:
parameters:
- in: path
name: purchasedProductId
schema:
type: string
format: uuid
example: 058a1af7-897f-45d5-b691-9cc9161e387f
required: true
description: The id of the purchased product to process.
post:
tags:
- Purchased GBO Product
summary: Add a GBO purchased product.
description: Add a GBO purchased product.
responses:
"201":
description: Created
/purchasedgboproducts:
get:
tags:
- Purchased GBO Product
summary: Find GBO purchased products.
description: Find GBO purchased products.
responses:
"201":
description: Created
/purchasedgboproducts/{purchasedGboProductId}:
parameters:
- in: path
name: purchasedProductId
schema:
type: string
format: uuid
example: 058a1af7-897f-45d5-b691-9cc9161e387f
required: true
description: The id of the purchased product to process.
patch:
tags:
- Purchased GBO Product
summary: Update a GBO purchased product.
description: Update a GBO purchased product.
responses:
"201":
description: Created