Add summary to requests
This commit is contained in:
1 parent
f9a16a6a04
commit
ae2937d4c3
1 file changed
+12
-1
@@ -15,7 +15,8 @@ paths:
|
|||||||
required: true
|
required: true
|
||||||
description: The id of the CustomerProfile.
|
description: The id of the CustomerProfile.
|
||||||
get:
|
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:
|
tags:
|
||||||
- Contract
|
- Contract
|
||||||
parameters:
|
parameters:
|
||||||
@@ -73,6 +74,7 @@ paths:
|
|||||||
],
|
],
|
||||||
}
|
}
|
||||||
post:
|
post:
|
||||||
|
summary: Create a contract for an existing customer profile.
|
||||||
description: Create a contract for an existing customer profile.
|
description: Create a contract for an existing customer profile.
|
||||||
tags:
|
tags:
|
||||||
- Contract
|
- Contract
|
||||||
@@ -143,6 +145,7 @@ paths:
|
|||||||
required: true
|
required: true
|
||||||
description: The contractId of the Contract, formatted as UUID.
|
description: The contractId of the Contract, formatted as UUID.
|
||||||
get:
|
get:
|
||||||
|
summary: Get contract details of a single contract.
|
||||||
description: Get contract details of a single contract.
|
description: Get contract details of a single contract.
|
||||||
tags:
|
tags:
|
||||||
- Contract
|
- Contract
|
||||||
@@ -229,6 +232,7 @@ paths:
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
patch:
|
patch:
|
||||||
|
summary: Update an existing contract.
|
||||||
description: Update an existing contract.
|
description: Update an existing contract.
|
||||||
tags:
|
tags:
|
||||||
- Contract
|
- Contract
|
||||||
@@ -274,6 +278,7 @@ paths:
|
|||||||
required: true
|
required: true
|
||||||
description: The contractId of the Contract, formatted as UUID.
|
description: The contractId of the Contract, formatted as UUID.
|
||||||
post:
|
post:
|
||||||
|
summary: Add a version to an existing contract.
|
||||||
description: Add a version to an existing contract.
|
description: Add a version to an existing contract.
|
||||||
tags:
|
tags:
|
||||||
- ContractVersion
|
- ContractVersion
|
||||||
@@ -326,6 +331,7 @@ paths:
|
|||||||
required: true
|
required: true
|
||||||
description: The id of the ContractVersion, formatted as UUID.
|
description: The id of the ContractVersion, formatted as UUID.
|
||||||
patch:
|
patch:
|
||||||
|
summary: Add an existing contract version.
|
||||||
description: Add an existing contract version.
|
description: Add an existing contract version.
|
||||||
tags:
|
tags:
|
||||||
- ContractVersion
|
- ContractVersion
|
||||||
@@ -360,6 +366,7 @@ paths:
|
|||||||
required: true
|
required: true
|
||||||
description: The contractId of the Contract, formatted as UUID.
|
description: The contractId of the Contract, formatted as UUID.
|
||||||
post:
|
post:
|
||||||
|
summary: Add an invoice to an existing contract.
|
||||||
description: Add an invoice to an existing contract.
|
description: Add an invoice to an existing contract.
|
||||||
tags:
|
tags:
|
||||||
- ContractInvoice
|
- ContractInvoice
|
||||||
@@ -404,6 +411,7 @@ paths:
|
|||||||
required: true
|
required: true
|
||||||
description: The id of the ContractInvoice, formatted as UUID.
|
description: The id of the ContractInvoice, formatted as UUID.
|
||||||
patch:
|
patch:
|
||||||
|
summary: Update an existing invoice.
|
||||||
description: Update an existing invoice.
|
description: Update an existing invoice.
|
||||||
tags:
|
tags:
|
||||||
- ContractInvoice
|
- ContractInvoice
|
||||||
@@ -445,6 +453,7 @@ paths:
|
|||||||
required: true
|
required: true
|
||||||
description: The contractId of the Contract, formatted as UUID.
|
description: The contractId of the Contract, formatted as UUID.
|
||||||
post:
|
post:
|
||||||
|
summary: Add a new action to an existing contract.
|
||||||
description: Add a new action to an existing contract.
|
description: Add a new action to an existing contract.
|
||||||
tags:
|
tags:
|
||||||
- ContractAction
|
- ContractAction
|
||||||
@@ -480,6 +489,7 @@ paths:
|
|||||||
}
|
}
|
||||||
/contractstatuses:
|
/contractstatuses:
|
||||||
get:
|
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.
|
description: Return a list of all possible values of the ContractStatus reference table. Used for populating drop down lists for example.
|
||||||
tags:
|
tags:
|
||||||
- Reference Tables
|
- Reference Tables
|
||||||
@@ -517,6 +527,7 @@ paths:
|
|||||||
}
|
}
|
||||||
/actiontypes:
|
/actiontypes:
|
||||||
get:
|
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.
|
description: Return a list of all possible values of the ActionType reference table. Used for populating drop down lists for example.
|
||||||
tags:
|
tags:
|
||||||
- Reference Tables
|
- Reference Tables
|
||||||
|
|||||||
Reference in new issue
Block a user