Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Better comments on APIs documentation #267

Merged
merged 4 commits into from
Feb 18, 2022
Merged

Better comments on APIs documentation #267

merged 4 commits into from
Feb 18, 2022

Conversation

ChristopheRib63
Copy link
Contributor

@ChristopheRib63 ChristopheRib63 commented Feb 15, 2022 •
edited by kbeaugrand
Loading

Description

What's new?

  • Add comment on controllers

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Tests
  • Other

@ChristopheRib63 ChristopheRib63 requested a review from a team as a code owner February 15, 2022 08:32
@codecov
Copy link

codecov bot commented Feb 15, 2022 •
edited
Loading

Codecov Report

Merging #267 (8a37677) into main (b43f317) will increase coverage by 0.56%.
The diff coverage is 50.58%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #267      +/-   ##
==========================================
+ Coverage   30.08%   30.65%   +0.56%     
==========================================
  Files          93       93              
  Lines        2672     2750      +78     
==========================================
+ Hits          804      843      +39     
- Misses       1868     1907      +39
Impacted Files Coverage Δ
...l/Server/Controllers/v1.0/DevicesControllerBase.cs 85.45% <ø> (ø)
...r/Controllers/v1.0/EdgeConfigurationsController.cs 0.00% <ø> (ø)
...trollers/v1.0/LoRaWAN/LoRaWANCommandsController.cs 79.45% <ø> (ø)
...ers/v1.0/LoRaWAN/LoRaWANConcentratorsController.cs 73.33% <ø> (ø)
...lers/v1.0/LoRaWAN/LoRaWANDeviceModelsController.cs 0.00% <0.00%> (ø)
...ntrollers/v1.0/LoRaWAN/LoRaWANDevicesController.cs 62.50% <0.00%> (-37.50%) ⬇️
...rtal/Server/Controllers/v1.0/SettingsController.cs 0.00% <ø> (ø)
...AzureIoTHub.Portal/Shared/Models/v1.0/C2Dresult.cs 0.00% <ø> (ø)
...zureIoTHub.Portal/Shared/Models/v1.0/ConfigItem.cs 71.42% <ø> (ø)
...IoTHub.Portal/Shared/Models/v1.0/ConfigListItem.cs 0.00% <ø> (ø)
... and 16 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b43f317...8a37677. Read the comment docs.

@ChristopheRib63 ChristopheRib63 changed the title add comment on controller WIP: add comment on controller Feb 15, 2022
@ChristopheRib63 ChristopheRib63 added the documentation Improvements or additions to documentation label Feb 15, 2022
@ChristopheRib63 ChristopheRib63 force-pushed the feature/248_API_documentation branch from 59ba68a to 273c36b Compare February 15, 2022 16:33
kbeaugrand
kbeaugrand requested changes Feb 16, 2022
View reviewed changes
Copy link
Member

@kbeaugrand kbeaugrand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi,

I added some review comment with suggestions.
Please add the operations names on each actions that you are commenting...

src/AzureIoTHub.Portal/Server/Controllers/v1.0/LoRaWANConcentratorsController.cs Outdated Show resolved Hide resolved
src/AzureIoTHub.Portal/Server/Controllers/v1.0/LoRaWANConcentratorsController.cs Outdated Show resolved Hide resolved
src/AzureIoTHub.Portal/Server/Controllers/v1.0/LoRaWANConcentratorsController.cs Outdated Show resolved Hide resolved
src/AzureIoTHub.Portal/Server/Controllers/v1.0/DevicesController.cs Outdated Show resolved Hide resolved
src/AzureIoTHub.Portal/Server/Controllers/v1.0/DevicesController.cs Outdated Show resolved Hide resolved
@kbeaugrand kbeaugrand linked an issue Feb 18, 2022 that may be closed by this pull request
Task: Document all APIs correctly #251
Closed
@ChristopheRib63 ChristopheRib63 force-pushed the feature/248_API_documentation branch from 9d11ccc to 2ed4824 Compare February 18, 2022 08:58
@kbeaugrand kbeaugrand force-pushed the feature/248_API_documentation branch from 2ed4824 to 597963d Compare February 18, 2022 16:39
@kbeaugrand kbeaugrand self-requested a review February 18, 2022 16:40
@kbeaugrand kbeaugrand changed the title WIP: add comment on controller Better comments on APIs documentation Feb 18, 2022
@kbeaugrand kbeaugrand force-pushed the feature/248_API_documentation branch from 597963d to 15c7e42 Compare February 18, 2022 17:33
@kbeaugrand kbeaugrand enabled auto-merge (squash) February 18, 2022 17:38
@kbeaugrand kbeaugrand merged commit 9e69ad4 into main Feb 18, 2022
@kbeaugrand kbeaugrand deleted the feature/248_API_documentation branch February 18, 2022 17:44
@github-actions github-actions bot mentioned this pull request Feb 18, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kbeaugrand kbeaugrand kbeaugrand approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Task: Document all APIs correctly
2 participants
@ChristopheRib63 @kbeaugrand