From ae2937d4c31b12ec1075ab225d870c2b7b1a6d44 Mon Sep 17 00:00:00 2001 From: Max Martens Date: Thu, 25 Jul 2024 12:47:55 +0200 Subject: [PATCH] Add summary to requests --- src/openapi/contracts/contracts-crud.yaml | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/src/openapi/contracts/contracts-crud.yaml b/src/openapi/contracts/contracts-crud.yaml index b0a133c..3edfe66 100644 --- a/src/openapi/contracts/contracts-crud.yaml +++ b/src/openapi/contracts/contracts-crud.yaml @@ -15,7 +15,8 @@ paths: required: true description: The id of the CustomerProfile. get: - description: List all contracts for a certail customer profile. + summary: List all contracts for a certain customer profile. + description: List all contracts for a certain customer profile. tags: - Contract parameters: @@ -73,6 +74,7 @@ paths: ], } post: + summary: Create a contract for an existing customer profile. description: Create a contract for an existing customer profile. tags: - Contract @@ -143,6 +145,7 @@ paths: required: true description: The contractId of the Contract, formatted as UUID. get: + summary: Get contract details of a single contract. description: Get contract details of a single contract. tags: - Contract @@ -229,6 +232,7 @@ paths: }, } patch: + summary: Update an existing contract. description: Update an existing contract. tags: - Contract @@ -274,6 +278,7 @@ paths: required: true description: The contractId of the Contract, formatted as UUID. post: + summary: Add a version to an existing contract. description: Add a version to an existing contract. tags: - ContractVersion @@ -326,6 +331,7 @@ paths: required: true description: The id of the ContractVersion, formatted as UUID. patch: + summary: Add an existing contract version. description: Add an existing contract version. tags: - ContractVersion @@ -360,6 +366,7 @@ paths: required: true description: The contractId of the Contract, formatted as UUID. post: + summary: Add an invoice to an existing contract. description: Add an invoice to an existing contract. tags: - ContractInvoice @@ -404,6 +411,7 @@ paths: required: true description: The id of the ContractInvoice, formatted as UUID. patch: + summary: Update an existing invoice. description: Update an existing invoice. tags: - ContractInvoice @@ -445,6 +453,7 @@ paths: required: true description: The contractId of the Contract, formatted as UUID. post: + summary: Add a new action to an existing contract. description: Add a new action to an existing contract. tags: - ContractAction @@ -480,6 +489,7 @@ paths: } /contractstatuses: get: + summary: Return a list of all possible values of the ContractStatus reference table. Used for populating drop down lists for example. description: Return a list of all possible values of the ContractStatus reference table. Used for populating drop down lists for example. tags: - Reference Tables @@ -517,6 +527,7 @@ paths: } /actiontypes: get: + summary: Return a list of all possible values of the ActionType reference table. Used for populating drop down lists for example. description: Return a list of all possible values of the ActionType reference table. Used for populating drop down lists for example. tags: - Reference Tables