435 lines
15 KiB
HTML
435 lines
15 KiB
HTML
<!doctype html>
|
|
<html class="no-js" lang="">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
<title>hometask documentation</title>
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
|
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
|
|
<link rel="stylesheet" href="../styles/style.css">
|
|
<link rel="stylesheet" href="../styles/dark.css">
|
|
<link rel="stylesheet" href="../styles/readthedocs.css">
|
|
</head>
|
|
<body>
|
|
|
|
<div class="navbar navbar-default navbar-fixed-top visible-xs">
|
|
<a href="../" class="navbar-brand">hometask documentation</a>
|
|
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
|
|
</div>
|
|
|
|
<div class="xs-menu menu" id="mobile-menu">
|
|
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
|
|
</div>
|
|
|
|
<div class="container-fluid main">
|
|
<div class="row main">
|
|
<div class="hidden-xs menu">
|
|
<compodoc-menu mode="normal"></compodoc-menu>
|
|
</div>
|
|
<!-- START CONTENT -->
|
|
<div class="content controller">
|
|
<div class="content-data">
|
|
|
|
|
|
|
|
|
|
|
|
<ol class="breadcrumb">
|
|
<li>Controllers</li>
|
|
<li >PapersController</li>
|
|
</ol>
|
|
|
|
<ul class="nav nav-tabs" role="tablist">
|
|
<li class="active">
|
|
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
|
|
</li>
|
|
<li >
|
|
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
|
|
</li>
|
|
</ul>
|
|
|
|
<div class="tab-content">
|
|
<div class="tab-pane fade active in" id="c-info">
|
|
<p class="comment">
|
|
<h3>File</h3>
|
|
</p>
|
|
<p class="comment">
|
|
<code>src/application/controller/papers.controller.ts</code>
|
|
</p>
|
|
|
|
|
|
|
|
<p class="comment">
|
|
<h3>Description</h3>
|
|
</p>
|
|
<p class="comment">
|
|
<p>/papers/ route controller</p>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h3 id="index">Index</h3>
|
|
<table class="table table-sm table-bordered index-table">
|
|
<tbody>
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<h6><b>Methods</b></h6>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<ul class="index-list">
|
|
<li>
|
|
<a href="#getByContext" >getByContext</a>
|
|
</li>
|
|
<li>
|
|
<a href="#getByID" >getByID</a>
|
|
</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
|
|
<section>
|
|
|
|
<h3 id="methods">
|
|
Methods
|
|
</h3>
|
|
<table class="table table-sm table-bordered">
|
|
<tbody>
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<a name="getByContext"></a>
|
|
<span class="name">
|
|
<span ><b>getByContext</b></span>
|
|
<a href="#getByContext"><span class="icon ion-ios-link"></span></a>
|
|
</span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<code>getByContext(request: <a href="../classes/RequestDto.html" target="_self">RequestDto</a>)</code>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<b>Decorators : </b>
|
|
<br />
|
|
<code>@ApiTags('Search')<br />@ApiOperation({summary: 'Finds papers by context based on the query'})<br />@ApiResponse({status: 200, description: 'Returns back a page with acquired papers', type: PageDto})<br />@ApiGatewayTimeoutResponse({description: 'Elasticsearch request timed out'})<br />@Get('search')<br />@UseInterceptors(PageInterceptor)<br />@HttpCode(200)<br /></code>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<div class="io-line">Defined in <a href="" data-line="43"
|
|
class="link-to-prism">src/application/controller/papers.controller.ts:43</a></div>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<div class="io-description"><p>Request handler for: GET /papers/search</p>
|
|
</div>
|
|
|
|
<div class="io-description">
|
|
<b>Parameters :</b>
|
|
|
|
<table class="params">
|
|
<thead>
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Optional</td>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>request</td>
|
|
<td>
|
|
<code><a href="../classes/RequestDto.html" target="_self" >RequestDto</a></code>
|
|
</td>
|
|
|
|
<td>
|
|
No
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
</div>
|
|
<div class="io-description">
|
|
<b>Returns : </b> <code><a href="../classes/EsResponseDto.html" target="_self" >Promise<EsResponseDto></a></code>
|
|
|
|
</div>
|
|
<div class="io-description">
|
|
<p>a response with a set of matching papers</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<table class="table table-sm table-bordered">
|
|
<tbody>
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<a name="getByID"></a>
|
|
<span class="name">
|
|
<span ><b>getByID</b></span>
|
|
<a href="#getByID"><span class="icon ion-ios-link"></span></a>
|
|
</span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<code>getByID(uuid: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<b>Decorators : </b>
|
|
<br />
|
|
<code>@ApiTags('Search')<br />@ApiOperation({summary: 'Finds paper by its UUID', tags: undefined})<br />@ApiResponse({status: 200, description: 'Returns back a paper', type: PaperDto})<br />@ApiGatewayTimeoutResponse({description: 'Elasticsearch request timed out'})<br />@Get(':uuid')<br />@HttpCode(200)<br /></code>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<div class="io-line">Defined in <a href="" data-line="75"
|
|
class="link-to-prism">src/application/controller/papers.controller.ts:75</a></div>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<div class="io-description"><p>Request handler for GET /papers/{uuid}</p>
|
|
</div>
|
|
|
|
<div class="io-description">
|
|
<b>Parameters :</b>
|
|
|
|
<table class="params">
|
|
<thead>
|
|
<tr>
|
|
<td>Name</td>
|
|
<td>Type</td>
|
|
<td>Optional</td>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>uuid</td>
|
|
<td>
|
|
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
|
|
</td>
|
|
|
|
<td>
|
|
No
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
</div>
|
|
<div class="io-description">
|
|
<b>Returns : </b> <code><a href="../classes/PaperDto.html" target="_self" >Promise<PaperDto></a></code>
|
|
|
|
</div>
|
|
<div class="io-description">
|
|
<p>a response with a requested object</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section> </div>
|
|
|
|
|
|
<div class="tab-pane fade tab-source-code" id="c-source">
|
|
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Controller, Get, HttpCode, Param, ParseUUIDPipe, Req, UseFilters, UseInterceptors } from "@nestjs/common";
|
|
import { SearchService } from "../../core/services/common/search.service";
|
|
import { PageInterceptor } from "../../core/interceptors/page.interceptor";
|
|
import { ApiExtraModels, ApiGatewayTimeoutResponse, ApiOperation, ApiResponse, ApiTags } from "@nestjs/swagger";
|
|
import { RequestDto } from "../../core/domain/dtos/request.dto";
|
|
import { EsHitDto, EsResponseDto, PageDto, PaperDto } from "../../core/domain";
|
|
import { HttpExceptionFilter } from "src/core/filters/http-exception.filter";
|
|
|
|
/**
|
|
* /papers/ route controller
|
|
*/
|
|
@UseFilters(HttpExceptionFilter)
|
|
@Controller({
|
|
version: '1',
|
|
path: 'papers',
|
|
})
|
|
@ApiExtraModels(RequestDto, EsHitDto, EsResponseDto)
|
|
// @UseInterceptors(CacheInterceptor)
|
|
export class PapersController {
|
|
constructor(private searchService: SearchService) {}
|
|
|
|
/**
|
|
* Request handler for: GET /papers/search
|
|
* @param query
|
|
* @param response
|
|
* @returns a response with a set of matching papers
|
|
*/
|
|
@ApiTags('Search')
|
|
@ApiOperation({
|
|
summary: 'Finds papers by context based on the query',
|
|
})
|
|
@ApiResponse({
|
|
status: 200,
|
|
description: 'Returns back a page with acquired papers',
|
|
type: PageDto
|
|
})
|
|
@ApiGatewayTimeoutResponse({
|
|
description: 'Elasticsearch request timed out'
|
|
})
|
|
@Get('search')
|
|
@UseInterceptors(PageInterceptor)
|
|
@HttpCode(200)
|
|
getByContext(@Req() request: RequestDto): Promise<EsResponseDto> {
|
|
return this.searchService.findByContext(request.es_query).then(
|
|
(response) => {
|
|
return response;
|
|
},
|
|
(error) => {
|
|
throw error;
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Request handler for GET /papers/{uuid}
|
|
* @param uuid
|
|
* @param response
|
|
* @returns a response with a requested object
|
|
*/
|
|
@ApiTags('Search')
|
|
@ApiOperation({
|
|
summary: 'Finds paper by its UUID',
|
|
tags: ['Search']
|
|
})
|
|
@ApiResponse({
|
|
status: 200,
|
|
description: 'Returns back a paper',
|
|
type: PaperDto
|
|
})
|
|
@ApiGatewayTimeoutResponse({
|
|
description: 'Elasticsearch request timed out'
|
|
})
|
|
@Get(':uuid')
|
|
@HttpCode(200)
|
|
getByID(@Param('uuid', ParseUUIDPipe) uuid: string): Promise<PaperDto> {
|
|
return this.searchService.findByID(uuid).then(
|
|
(response: EsResponseDto) => {
|
|
return response.hits.hits[0]?._source;
|
|
},
|
|
(error) => {
|
|
throw error;
|
|
}
|
|
);
|
|
}
|
|
}</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div><div class="search-results">
|
|
<div class="has-results">
|
|
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
|
|
<ul class="search-results-list"></ul>
|
|
</div>
|
|
<div class="no-results">
|
|
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<!-- END CONTENT -->
|
|
</div>
|
|
</div>
|
|
|
|
<label class="dark-mode-switch">
|
|
<input type="checkbox">
|
|
<span class="slider">
|
|
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
|
|
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
|
|
</svg>
|
|
</span>
|
|
</label>
|
|
|
|
<script>
|
|
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
|
|
var COMPODOC_CURRENT_PAGE_CONTEXT = 'controller';
|
|
var COMPODOC_CURRENT_PAGE_URL = 'PapersController.html';
|
|
var MAX_SEARCH_RESULTS = 15;
|
|
</script>
|
|
|
|
<script src="../js/libs/custom-elements.min.js"></script>
|
|
<script src="../js/libs/lit-html.js"></script>
|
|
|
|
<script src="../js/menu-wc.js" defer></script>
|
|
<script nomodule src="../js/menu-wc_es5.js" defer></script>
|
|
|
|
<script src="../js/libs/bootstrap-native.js"></script>
|
|
|
|
<script src="../js/libs/es6-shim.min.js"></script>
|
|
<script src="../js/libs/EventDispatcher.js"></script>
|
|
<script src="../js/libs/promise.min.js"></script>
|
|
<script src="../js/libs/zepto.min.js"></script>
|
|
|
|
<script src="../js/compodoc.js"></script>
|
|
|
|
<script src="../js/tabs.js"></script>
|
|
<script src="../js/menu.js"></script>
|
|
<script src="../js/libs/clipboard.min.js"></script>
|
|
<script src="../js/libs/prism.js"></script>
|
|
<script src="../js/sourceCode.js"></script>
|
|
<script src="../js/search/search.js"></script>
|
|
<script src="../js/search/lunr.min.js"></script>
|
|
<script src="../js/search/search-lunr.js"></script>
|
|
<script src="../js/search/search_index.js"></script>
|
|
<script src="../js/lazy-load-graphs.js"></script>
|
|
|
|
|
|
</body>
|
|
</html>
|