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 compliance warnings in boilerplate #586

Merged
merged 2 commits into from
Jul 30, 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
3 changes: 3 additions & 0 deletions packages/api/scripts/commonObject.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
# THIS SCRIPT GENERATES THE BOILERPLATE FOR NEW COMMON OBJECTS
# Usage: ./commonObject.sh "account,other_object" "accounting"

# Warning: if the objectCap does not end with the letter 's'
[[ ! $ObjectCap =~ s$ ]] && echo "Warning: ObjectCap does not end with the letter 's' - this object maybe doesn't comply with RESTful naming conventions"

if [ "$#" -ne 2 ]; then
echo "Usage: $0 <object_types_comma_separated> <vertical_object>"
exit 1
Expand Down
2 changes: 1 addition & 1 deletion packages/api/src/accounting/account/account.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ export class AccountController {

@ApiOperation({
operationId: 'createAccountingAccount',
summary: 'Accounts',
summary: 'Create Accounts',
description: 'Create accounts in any supported Accounting software',
})
@ApiHeader({
Expand Down
2 changes: 1 addition & 1 deletion packages/api/swagger/swagger-spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5535,7 +5535,7 @@ paths:
x-speakeasy-group: accounting.accounts
post:
operationId: createAccountingAccount
summary: Accounts
summary: Create Accounts
description: Create accounts in any supported Accounting software
parameters:
- name: x-connection-token
Expand Down
Loading