Skip to content

feat: mark several API endpoints as deprecated in notifications, owners, and transactions controllers #2609

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: mark several API endpoints as deprecated in notifications, owners, and transactions controllers #2609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion src/routes/notifications/v1/notifications.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
Param,
Post,
} from '@nestjs/common';
import { ApiOkResponse, ApiTags } from '@nestjs/swagger';
import { ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger';
import { RegisterDeviceDto } from '@/routes/notifications/v1/entities/register-device.dto.entity';
import { ValidationPipe } from '@/validation/pipes/validation.pipe';
import { AddressSchema } from '@/validation/entities/schemas/address.schema';
Expand Down Expand Up @@ -36,6 +36,7 @@ export class NotificationsController {
) {}

@ApiOkResponse()
@ApiOperation({ deprecated: true })
@Post('register/notifications')
@HttpCode(200)
async registerDevice(
Expand Down Expand Up @@ -188,6 +189,7 @@ export class NotificationsController {
}
}

@ApiOperation({ deprecated: true })
@Delete('chains/:chainId/notifications/devices/:uuid')
async unregisterDevice(
@Param('chainId') _: string, // We need to keep this parameter for the swagger documentation
Expand All @@ -196,6 +198,7 @@ export class NotificationsController {
await this.notificationServiceV2.deleteDevice(uuid);
}

@ApiOperation({ deprecated: true })
@Delete('chains/:chainId/notifications/devices/:uuid/safes/:safeAddress')
async unregisterSafe(
@Param('chainId') chainId: string,
Expand Down
3 changes: 2 additions & 1 deletion src/routes/owners/owners.controller.v1.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Controller, Get, Param } from '@nestjs/common';
import { ApiOkResponse, ApiTags } from '@nestjs/swagger';
import { ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger';
import { SafeList } from '@/routes/owners/entities/safe-list.entity';
import { OwnersService } from '@/routes/owners/owners.service';
import { ValidationPipe } from '@/validation/pipes/validation.pipe';
Expand All @@ -24,6 +24,7 @@ export class OwnersControllerV1 {
}

@ApiOkResponse({ type: SafeList })
@ApiOperation({ deprecated: true, summary: 'Deprecated' })
@Get('owners/:ownerAddress/safes')
async getAllSafesByOwner(
@Param('ownerAddress', new ValidationPipe(AddressSchema))
Expand Down
10 changes: 9 additions & 1 deletion src/routes/transactions/transactions.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@ import {
Post,
Query,
} from '@nestjs/common';
import { ApiOkResponse, ApiQuery, ApiTags } from '@nestjs/swagger';
import {
ApiOkResponse,
ApiOperation,
ApiQuery,
ApiTags,
} from '@nestjs/swagger';
import { PaginationDataDecorator } from '@/routes/common/decorators/pagination.data.decorator';
import { RouteUrlDecorator } from '@/routes/common/decorators/route.url.decorator';
import { Page } from '@/routes/common/entities/page.entity';
Expand Down Expand Up @@ -66,6 +71,7 @@ export class TransactionsController {
}

@ApiOkResponse({ type: TXSMultisigTransaction })
@ApiOperation({ deprecated: true, summary: 'Deprecated' })
@Get('chains/:chainId/multisig-transactions/:safeTxHash/raw')
async getDomainMultisigTransactionBySafeTxHash(
@Param('chainId') chainId: string,
Expand Down Expand Up @@ -104,6 +110,7 @@ export class TransactionsController {
@ApiQuery({ name: 'ordering', required: false, type: String })
@ApiQuery({ name: 'limit', required: false, type: Number })
@ApiQuery({ name: 'offset', required: false, type: Number })
@ApiOperation({ deprecated: true, summary: 'Deprecated' })
@Get('chains/:chainId/safes/:safeAddress/multisig-transactions/raw')
async getDomainMultisigTransactions(
@Param('chainId') chainId: string,
Expand Down Expand Up @@ -421,6 +428,7 @@ export class TransactionsController {

@HttpCode(200)
@ApiOkResponse({ type: TXSCreationTransaction })
@ApiOperation({ deprecated: true, summary: 'Deprecated' })
@Get('chains/:chainId/safes/:safeAddress/creation/raw')
async getDomainCreationTransaction(
@Param('chainId') chainId: string,
Expand Down