Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: REST Naming convention #585

Merged
merged 2 commits into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/api/scripts/commonObject.sh
Original file line number Diff line number Diff line change
Expand Up @@ -333,8 +333,8 @@ private connectionUtils: ConnectionUtils

@ApiOperation({
operationId: 'get${ObjectCap}',
summary: 'Retrieve a ${ObjectCap}',
description: 'Retrieve a ${objectType} from any connected ${VerticalCap} software',
summary: 'Retrieve ${ObjectCap}',
description: 'Retrieve ${objectType} from any connected ${VerticalCap} software',
})
@ApiParam({
name: 'id',
Expand All @@ -360,8 +360,8 @@ private connectionUtils: ConnectionUtils

@ApiOperation({
operationId: 'add${ObjectCap}',
summary: 'Create a ${ObjectCap}',
description: 'Create a ${objectType} in any supported ${VerticalCap} software',
summary: 'Create ${ObjectCap}',
description: 'Create ${objectType} in any supported ${VerticalCap} software',
})
@ApiHeader({
name: 'x-connection-token',
Expand Down
8 changes: 4 additions & 4 deletions packages/api/src/accounting/account/account.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ export class AccountController {

@ApiOperation({
operationId: 'retrieveAccountingAccount',
summary: 'Retrieve a Account',
description: 'Retrieve a account from any connected Accounting software',
summary: 'Retrieve Accounts',
description: 'Retrieve Accounts from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down Expand Up @@ -128,8 +128,8 @@ export class AccountController {

@ApiOperation({
operationId: 'createAccountingAccount',
summary: 'Create a Account',
description: 'Create a account in any supported Accounting software',
summary: 'Accounts',
description: 'Create accounts in any supported Accounting software',
})
@ApiHeader({
name: 'x-connection-token',
Expand Down
4 changes: 2 additions & 2 deletions packages/api/src/accounting/address/address.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ export class AddressController {

@ApiOperation({
operationId: 'retrieveAccountingAddress',
summary: 'Retrieve a Address',
description: 'Retrieve a address from any connected Accounting software',
summary: 'Retrieve Addresses',
description: 'Retrieve Addresses from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ export class AttachmentController {

@ApiOperation({
operationId: 'retrieveAccountingAttachment',
summary: 'Retrieve a Attachment',
description: 'Retrieve a attachment from any connected Accounting software',
summary: 'Retrieve Attachments',
description: 'Retrieve attachments from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down Expand Up @@ -128,8 +128,8 @@ export class AttachmentController {

@ApiOperation({
operationId: 'createAccountingAttachment',
summary: 'Create a Attachment',
description: 'Create a attachment in any supported Accounting software',
summary: 'Create Attachments',
description: 'Create attachments in any supported Accounting software',
})
@ApiHeader({
name: 'x-connection-token',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ export class BalanceSheetController {

@ApiOperation({
operationId: 'retrieveAccountingBalanceSheet',
summary: 'Retrieve a BalanceSheet',
summary: 'Retrieve BalanceSheets',
description:
'Retrieve a balancesheet from any connected Accounting software',
'Retrieve BalanceSheets from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ export class CashflowStatementController {

@ApiOperation({
operationId: 'retrieveAccountingCashflowStatement',
summary: 'Retrieve a CashflowStatement',
summary: 'Retrieve Cashflow Statements',
description:
'Retrieve a cashflowstatement from any connected Accounting software',
'Retrieve Cashflow Statements from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ export class CompanyInfoController {

@ApiOperation({
operationId: 'retrieveAccountingCompanyInfo',
summary: 'Retrieve a CompanyInfo',
summary: 'Retrieve Company Infos',
description:
'Retrieve a companyinfo from any connected Accounting software',
'Retrieve Company Infos from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down
8 changes: 4 additions & 4 deletions packages/api/src/accounting/contact/contact.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ export class ContactController {

@ApiOperation({
operationId: 'retrieveAccountingContact',
summary: 'Retrieve a Contact',
description: 'Retrieve a contact from any connected Accounting software',
summary: 'Retrieve Contacts',
description: 'Retrieve Contacts from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down Expand Up @@ -128,8 +128,8 @@ export class ContactController {

@ApiOperation({
operationId: 'createAccountingContact',
summary: 'Create a Contact',
description: 'Create a contact in any supported Accounting software',
summary: 'Create Contacts',
description: 'Create contacts in any supported Accounting software',
})
@ApiHeader({
name: 'x-connection-token',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ export class CreditNoteController {

@ApiOperation({
operationId: 'retrieveAccountingCreditNote',
summary: 'Retrieve a CreditNote',
description: 'Retrieve a creditnote from any connected Accounting software',
summary: 'Retrieve Credit Notes',
description: 'Retrieve Credit Notes from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down
8 changes: 4 additions & 4 deletions packages/api/src/accounting/expense/expense.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ export class ExpenseController {

@ApiOperation({
operationId: 'retrieveAccountingExpense',
summary: 'Retrieve a Expense',
description: 'Retrieve a expense from any connected Accounting software',
summary: 'Retrieve Expenses',
description: 'Retrieve Expenses from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down Expand Up @@ -128,8 +128,8 @@ export class ExpenseController {

@ApiOperation({
operationId: 'createAccountingExpense',
summary: 'Create a Expense',
description: 'Create a expense in any supported Accounting software',
summary: 'Create Expenses',
description: 'Create Expenses in any supported Accounting software',
})
@ApiHeader({
name: 'x-connection-token',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ export class IncomeStatementController {

@ApiOperation({
operationId: 'retrieveAccountingIncomeStatement',
summary: 'Retrieve a IncomeStatement',
summary: 'Retrieve Income Statements',
description:
'Retrieve a incomestatement from any connected Accounting software',
'Retrieve Income Statements from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down
8 changes: 4 additions & 4 deletions packages/api/src/accounting/invoice/invoice.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ export class InvoiceController {

@ApiOperation({
operationId: 'retrieveAccountingInvoice',
summary: 'Retrieve a Invoice',
description: 'Retrieve a invoice from any connected Accounting software',
summary: 'Retrieve Invoices',
description: 'Retrieve Invoices from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down Expand Up @@ -128,8 +128,8 @@ export class InvoiceController {

@ApiOperation({
operationId: 'createAccountingInvoice',
summary: 'Create a Invoice',
description: 'Create a invoice in any supported Accounting software',
summary: 'Create Invoices',
description: 'Create invoices in any supported Accounting software',
})
@ApiHeader({
name: 'x-connection-token',
Expand Down
4 changes: 2 additions & 2 deletions packages/api/src/accounting/item/item.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ export class ItemController {

@ApiOperation({
operationId: 'retrieveAccountingItem',
summary: 'Retrieve a Item',
description: 'Retrieve a item from any connected Accounting software',
summary: 'Retrieve Items',
description: 'Retrieve Items from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@ export class JournalEntryController {

@ApiOperation({
operationId: 'retrieveAccountingJournalEntry',
summary: 'Retrieve a JournalEntry',
summary: 'Retrieve Journal Entries',
description:
'Retrieve a journalentry from any connected Accounting software',
'Retrieve Journal Entries from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down Expand Up @@ -129,8 +129,8 @@ export class JournalEntryController {

@ApiOperation({
operationId: 'createAccountingJournalEntry',
summary: 'Create a JournalEntry',
description: 'Create a journalentry in any supported Accounting software',
summary: 'Create Journal Entries',
description: 'Create Journal Entries in any supported Accounting software',
})
@ApiHeader({
name: 'x-connection-token',
Expand Down
8 changes: 4 additions & 4 deletions packages/api/src/accounting/payment/payment.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ export class PaymentController {

@ApiOperation({
operationId: 'retrieveAccountingPayment',
summary: 'Retrieve a Payment',
description: 'Retrieve a payment from any connected Accounting software',
summary: 'Retrieve Payments',
description: 'Retrieve Payments from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down Expand Up @@ -128,8 +128,8 @@ export class PaymentController {

@ApiOperation({
operationId: 'createAccountingPayment',
summary: 'Create a Payment',
description: 'Create a payment in any supported Accounting software',
summary: 'Create Payments',
description: 'Create Payments in any supported Accounting software',
})
@ApiHeader({
name: 'x-connection-token',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ export class PhoneNumberController {

@ApiOperation({
operationId: 'retrieveAccountingPhonenumber',
summary: 'Retrieve a PhoneNumber',
summary: 'Retrieve Phone Numbers',
description:
'Retrieve a phonenumber from any connected Accounting software',
'Retrieve Phone Numbers from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@ export class PurchaseOrderController {

@ApiOperation({
operationId: 'retrieveAccountingPurchaseOrder',
summary: 'Retrieve a PurchaseOrder',
summary: 'Retrieve Purchase Orders',
description:
'Retrieve a purchaseorder from any connected Accounting software',
'Retrieve Purchase Orders from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down Expand Up @@ -129,8 +129,8 @@ export class PurchaseOrderController {

@ApiOperation({
operationId: 'createAccountingPurchaseOrder',
summary: 'Create a PurchaseOrder',
description: 'Create a purchaseorder in any supported Accounting software',
summary: 'Create Purchase Orders',
description: 'Create Purchase Orders in any supported Accounting software',
})
@ApiHeader({
name: 'x-connection-token',
Expand Down
4 changes: 2 additions & 2 deletions packages/api/src/accounting/taxrate/taxrate.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ export class TaxRateController {

@ApiOperation({
operationId: 'retrieveAccountingTaxRate',
summary: 'Retrieve a TaxRate',
description: 'Retrieve a taxrate from any connected Accounting software',
summary: 'Retrieve Tax Rates',
description: 'Retrieve Tax Rates from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ export class TrackingCategoryController {

@ApiOperation({
operationId: 'retrieveAccountingTrackingCategory',
summary: 'Retrieve a TrackingCategory',
summary: 'Retrieve Tracking Categories',
description:
'Retrieve a trackingcategory from any connected Accounting software',
'Retrieve Tracking Categories from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ export class TransactionController {

@ApiOperation({
operationId: 'retrieveAccountingTransaction',
summary: 'Retrieve a Transaction',
summary: 'Retrieve Transactions',
description:
'Retrieve a transaction from any connected Accounting software',
'Retrieve Transactions from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ export class VendorCreditController {

@ApiOperation({
operationId: 'retrieveAccountingVendorCredit',
summary: 'Retrieve a VendorCredit',
summary: 'Retrieve Vendor Credits',
description:
'Retrieve a vendorcredit from any connected Accounting software',
'Retrieve Vendor Credits from any connected Accounting software',
})
@ApiParam({
name: 'id',
Expand Down
8 changes: 4 additions & 4 deletions packages/api/src/ats/activity/activity.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ export class ActivityController {

@ApiOperation({
operationId: 'retrieveAtsActivity',
summary: 'Retrieve a Activity',
description: 'Retrieve a activity from any connected Ats software',
summary: 'Retrieve Activities',
description: 'Retrieve Activities from any connected Ats software',
})
@ApiParam({
name: 'id',
Expand Down Expand Up @@ -126,8 +126,8 @@ export class ActivityController {

@ApiOperation({
operationId: 'createAtsActivity',
summary: 'Create a Activity',
description: 'Create a activity in any supported Ats software',
summary: 'Create Activities',
description: 'Create Activities in any supported Ats software',
})
@ApiHeader({
name: 'x-connection-token',
Expand Down
8 changes: 4 additions & 4 deletions packages/api/src/ats/application/application.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ export class ApplicationController {

@ApiOperation({
operationId: 'retrieveAtsApplication',
summary: 'Retrieve an Application',
description: 'Retrieve an application from any connected Ats software',
summary: 'Retrieve Applications',
description: 'Retrieve Applications from any connected Ats software',
})
@ApiParam({
name: 'id',
Expand Down Expand Up @@ -127,8 +127,8 @@ export class ApplicationController {

@ApiOperation({
operationId: 'createAtsApplication',
summary: 'Create an Application',
description: 'Create an application in any supported Ats software',
summary: 'Create Applications',
description: 'Create Applications in any supported Ats software',
})
@ApiHeader({
name: 'x-connection-token',
Expand Down
Loading
Loading