fix(docs): move a few API doc comments to descriptions (#15381)

Previously, the comments were being used as the summaries, and thus were
displayed as the “title” of these endpoints
This commit is contained in:
Ben Cochran 2025-01-29 08:58:10 -08:00 committed by GitHub
parent a0aea021a1
commit b4a4abbf51
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 50 additions and 14 deletions

View file

@ -1,5 +1,5 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Post, Put, Query } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { EndpointLifecycle } from 'src/decorators';
import { AssetResponseDto, MemoryLaneResponseDto } from 'src/dtos/asset-response.dto';
import {
@ -41,6 +41,10 @@ export class AssetController {
* Get all asset of a device that are in the database, ID only.
*/
@Get('/device/:deviceId')
@ApiOperation({
summary: 'getAllUserAssetsByDeviceId',
description: 'Get all asset of a device that are in the database, ID only.',
})
@Authenticated()
getAllUserAssetsByDeviceId(@Auth() auth: AuthDto, @Param() { deviceId }: DeviceIdDto) {
return this.service.getUserAssetsByDeviceId(auth, deviceId);