jbenicek
/
API_SequentMicrosystems-RPI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated descriptions of api endpoints

master
Jan Beníček 2023-11-30 17:09:08 +01:00
parent 3d415b6903
commit b2187fe3f3
2 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Controllers/PointsController.cs
View File

@ -6,7 +6,7 @@ using Microsoft.AspNetCore.Mvc;
namespace API_SequentMicrosystems.Controllers namespace API_SequentMicrosystems.Controllers
{ {
[Tags("Internal Saving Points (Recommended only use \"Actual\" endpoint for read all data at once. Saving points is not recomended)")] [Tags("Internal Saving Points (Recommended use only \"Actual\" endpoint for read all data at once. Saving points is not recomended)")]
[Route("Points")] [Route("Points")]
[ApiController] [ApiController]
public class PointsController : ControllerBase public class PointsController : ControllerBase

24
Controllers/RTDDataAcquisitionController.cs
View File

@ -19,9 +19,9 @@ namespace API_SequentMicrosystems.Controllers
// GET: api/<RTDDataAcquisitionController> // GET: api/<RTDDataAcquisitionController>
/// <summary> /// <summary>
/// Read data from all configured cards /// Read data from all configured RTD cards
/// </summary> /// </summary>
/// <returns></returns> /// <returns>SortedList with data from configured RTD-8 Cards</returns>
[HttpGet] [HttpGet]
public SortedList<byte, float[]> Get() public SortedList<byte, float[]> Get()
{ {
@ -32,7 +32,7 @@ namespace API_SequentMicrosystems.Controllers
/// <summary> /// <summary>
/// Read data from All RTD cards /// Read data from All RTD cards
/// </summary> /// </summary>
/// <returns></returns> /// <returns>SortedList with data from all conected RTD-8 cards</returns>
[HttpGet("All")] [HttpGet("All")]
public SortedList<byte, float[]> GetAll() public SortedList<byte, float[]> GetAll()
{ {
@ -41,10 +41,10 @@ namespace API_SequentMicrosystems.Controllers
// GET api/<RTDDataAcquisitionController>/5 // GET api/<RTDDataAcquisitionController>/5
/// <summary> /// <summary>
/// Read data from specified card from stack /// Read data from specified by card id
/// </summary> /// </summary>
/// <param name="stack"></param> /// <param name="stack">0-7</param>
/// <returns>data from specified card</returns> /// <returns>Array with data from specified card</returns>
[HttpGet("{stack}")] [HttpGet("{stack}")]
public float[] GetAll(byte stack) public float[] GetAll(byte stack)
{ {
@ -55,7 +55,7 @@ namespace API_SequentMicrosystems.Controllers
/// <summary> /// <summary>
/// Get Configured Names of Chanels /// Get Configured Names of Chanels
/// </summary> /// </summary>
/// <returns></returns> /// <returns>Sorted List of configured Names responded with data by Ids of SortedList and array</returns>
[HttpGet("Names")] [HttpGet("Names")]
public SortedList<byte, string[]> GetNames() public SortedList<byte, string[]> GetNames()
{ {
@ -66,7 +66,7 @@ namespace API_SequentMicrosystems.Controllers
/// <summary> /// <summary>
/// Post configured names of chanels /// Post configured names of chanels
/// </summary> /// </summary>
/// <param name="data"></param> /// <param name="data">Sorted List of configured Names responded with data by Ids of SortedList and array</param>
[HttpPost("Names")] [HttpPost("Names")]
public void PostNames([FromBody] SortedList<byte, string[]> data) public void PostNames([FromBody] SortedList<byte, string[]> data)
{ {
@ -77,7 +77,7 @@ namespace API_SequentMicrosystems.Controllers
/// <summary> /// <summary>
/// Get preconfigured Names /// Get preconfigured Names
/// </summary> /// </summary>
/// <returns></returns> /// <returns>List of preconfigured names</returns>
[HttpGet("Names/Preconfigured")] [HttpGet("Names/Preconfigured")]
public List<string> GetNamesPreconfigured() public List<string> GetNamesPreconfigured()
{ {
@ -88,7 +88,7 @@ namespace API_SequentMicrosystems.Controllers
/// <summary> /// <summary>
/// Post preconfigured names /// Post preconfigured names
/// </summary> /// </summary>
/// <param name="data"></param> /// <param name="data">List of preconfigured names</param>
[HttpPost("Names/Preconfigured")] [HttpPost("Names/Preconfigured")]
public void PostNamesPreconfigured([FromBody] List<string> data) public void PostNamesPreconfigured([FromBody] List<string> data)
{ {
@ -99,7 +99,7 @@ namespace API_SequentMicrosystems.Controllers
/// <summary> /// <summary>
/// Get Calibration data /// Get Calibration data
/// </summary> /// </summary>
/// <returns></returns> /// <returns>Sorted List of calibration data responded with data by Ids of SortedList and array</returns>
[HttpGet("Calibration")] [HttpGet("Calibration")]
public SortedList<byte, float[]> GetCalibration() public SortedList<byte, float[]> GetCalibration()
{ {
@ -110,7 +110,7 @@ namespace API_SequentMicrosystems.Controllers
/// <summary> /// <summary>
/// Post Calibration data /// Post Calibration data
/// </summary> /// </summary>
/// <param name="data"></param> /// <param name="data">Sorted List of calibration data responded with data by Ids of SortedList and array</param>
[HttpPost("Calibration")] [HttpPost("Calibration")]
public void PostCalibration([FromBody] SortedList<byte, float[]> data) public void PostCalibration([FromBody] SortedList<byte, float[]> data)
{ {