Documentation topic 1

[UO289845]

Fixed the problems detected in the review

[uo289267]

What do you mean by "Apart from being in GitHub the system will have an API responsible of handling the questions generated previously from WikiData."?

[UO289845]

There was missinng a coma, now fixed.

Those are two requirements, the first one is that it will be stored and deployed via GitHub, and the second, is two draw more emphasis on the present of the two APIs, ours and the WikiData one. The WikiData one is used by us to generate the questions, and our API is used to send those questions to the game.

[uo289267]

I dont think your descriptions are 100% accurate
I would suggest changing it for:

"The system will also store the historical data of the users, thanks to the login and registering service featured in the application, and users will be able to access their information. The application will have at least English as an available language. Moreover, the project will be stored and deployed through GitHub.
Lastly, the system will give access to non sensitive user's information through a public API as well as another API for the questions generated."

If you want to reference that questions generated through wikidata will be passed to our application it is not done thorugh an API it is done through an interface that connects the question generation and the game. I have referenced in the text the apis that need to be public based on the lab description document.

I would suggest to put the text that I have rephrased instead of yours or discuss its final shape from it.
Another suggestion for the whole section is the use of connectors in the text (Moreover, On the one hand...).

[UO289845]

First of all, I believe the text you suggested is pretty good and I've no problem replacing the original one with it. However, I believe taht one of us is not fully graping the requirements of the aplication, since it explicitly states that the information about the question must be passed through an API.

The system will give access to information about the generated questions through an API.

I understand that requirement as the need of our own API for communicating the questions, not simply an interface. If you have understand it in another way, please explain it to me so we can either reach a conclusion, or pospone it until monday and discuss it with the professor.

[UO289845]

Upon rereading your last comment I've realize that the last line in the paragraph already speaks about the use of the API. My apologies for the misunderstanding.

[uo289267]

No worries

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

[uo289267]

I consider the changes to be correct