Skip to content
This repository was archived by the owner on Jul 1, 2020. It is now read-only.

Commit b127b84

Browse files
committed
Aggiunta la lista bug, fix installazione, aggiunti documenti OpenAPI
1 parent 647f146 commit b127b84

File tree

5 files changed

+61
-9
lines changed

5 files changed

+61
-9
lines changed

esterni/manuale_manutentore/res/sections/api.tex

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,15 @@ \subsection{API}
161161
\end{landscape}
162162

163163

164+
\subsubsection{Documentazione OpenAPI}
165+
166+
Per le API è stato generato un documento in formato OpenAPI con un file YAML. Questo documento è stato convertito in PDF per comodità di lettura, e contiene tutte le specifiche delle API realizzate con le relative chiamate e i relativi codici di errore in risposta.
167+
I file in questione sono i seguenti:
168+
\begin{itemize}
169+
\item \verb!OpenAPI/riot-api.v1.pdf! - documento PDF descrittivo di tutte le API realizzate;
170+
\item \textit!OpenAPI/riot-api.v1.yml! - documento in formato YAML auto-generato tramite Spring.
171+
\end{itemize}
172+
164173
\subsubsection{Estensione}
165174
\paragraph{Aggiungere una richiesta API}
166175
Per inserire una nuova richiesta, se non si usano le classi già esistenti, è necessario che la nuova classe creata implementi l'interfaccia RestController, tramite la notazione \textit{@RestController}, da inserire precedentemente alla definizione della classe.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
2+
% ---------------------------
3+
% + CONFIGURAZIONE AGGIUNTIVA
4+
% ---------------------------
5+
6+
\newpage
7+
8+
\appendix
9+
\addcontentsline{toc}{section}{Appendice}
10+
11+
\section{Lista dei Bug}
12+
13+
In questa sezione è riportata una \textit{fotocopia} dei bugs riscontrati a partire dall'incremento V, a seguito della realizzazione del \textit{proof of concept}. Si riportano anche i link ai principali \textit{Issue Tracking System} (ITS) di tutte le componenti.
14+
15+
\begin{itemize}
16+
\item \href{https://github.com/RedRoundRobin/swe-gateway/issues}{ITS, swe-gateway}
17+
\item \href{https://github.com/RedRoundRobin/swe-kafka-db/issues}{ITS, swe-kafka-db}
18+
\item \href{https://github.com/RedRoundRobin/swe-api/issues}{ITS, swe-api}
19+
\item \href{https://github.com/RedRoundRobin/swe-webapp/issues}{ITS, swe-webapp}
20+
\item \href{https://github.com/RedRoundRobin/swe-telegram/issues}{ITS, swe-telegram}
21+
\end{itemize}
22+
23+
\begin{center}
24+
\rowcolors{2}{lightest-grayest}{white}
25+
\begin{longtable}{|c|c|p{9.5cm}|c|}
26+
\hline
27+
\rowcolor{lighter-grayer}
28+
\textbf{Periodo} & \textbf{Componente} & \textbf{Descrizione} & \textbf{Stato} \\
29+
\hline
30+
\endhead
31+
\hline
32+
\multicolumn{3}{|c|}{\textit{Continua nella pagina successiva...}}\\
33+
\hline
34+
\endfoot
35+
\endlastfoot
36+
37+
\hline
38+
%%%%%% Lista dei Bugs da excel - Documenti RRR %%%%%%
39+
40+
41+
42+
43+
44+
%%%%%% Fine dei bugs %%%%%%
45+
46+
\caption{Tabella contenente un riepilogo dei bug riscontrati a partire dall'incremento V}
47+
\end{longtable}
48+
\end{center}
49+

esterni/manuale_manutentore/res/sections/glossario.tex

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33
% + CONFIGURAZIONE AGGIUNTIVA
44
% ---------------------------
55

6-
\appendix
7-
\addcontentsline{toc}{section}{Appendice}
8-
96
\setcounter{secnumdepth}{1} % No section number
107
\setcounter{tocdepth}{3} % No section number
118

esterni/manuale_manutentore/res/sections/installazione.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ \section{Installazione}
2222

2323
\subsection{Installazione e avvio completo tramite Docker}
2424

25-
In alternativa, è possibile eseguire l'installazione completa di tutto il prodotto sulla propria macchina tramite Docker. Per farlo, è sufficiente eseguire il file \textit{docker-compose.yml} nel proprio terminale tramite il comando:
25+
In alternativa, è possibile eseguire l'installazione completa di tutto il prodotto sulla propria macchina tramite Docker. Per farlo, è sufficiente eseguire il file \textit{docker-compose.riot.yml} nel proprio terminale tramite il comando:
2626
\begin{verbatim}
27-
$ docker-compose up -d
27+
$ docker-compose -f docker-compose.riot.yml up -d
2828
\end{verbatim}
2929

3030
\subsection{Gateway}

esterni/manuale_manutentore/res/sezioni.tex

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,5 @@
99
\yetAnotherSectionNamed{installazione}
1010
\yetAnotherSectionNamed{test}
1111
\yetAnotherSectionNamed{architettura}
12+
\yetAnotherSectionNamed{bugs}
1213
\yetAnotherSectionNamed{glossario}
13-
14-
15-
16-

0 commit comments

Comments
 (0)