fix(confighttp): do not return 200 on errors

[ReenigneArcher]

Description

• Return 400 status code on config API errors
• Add default_resource for requests that are not GET
• Remove trailing commas in API examples
• Clarify how index works when saving an app
• Change xml responses to json
• Add grouped tab code examples to API docs

TODO:

• fix fail guards, per @FrogTheFrog
• add tabbed examples for each endpoint in docs. e.g. curl, python, javascript, powershell
• trying to delete app way out of index range shows as success

  >curl -u user:pass -X DELETE -k https://localhost:47990/api/apps/5000
  {
      "status": "true"
  }
  

  Note: existing check was useless since it could never actually be fired ( < 0 is not possible due to the regex of the endpoint), instead changed it to a clamp and checked the upper bounds.

Screenshot

Issues Fixed or Closed

• Fixes Beta API: POST /api/apps returns 200 OK on invalid input JSON #3384

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Dependency update (updates to dependencies)
• Documentation update (changes to documentation)
• Repository update (changes to repository files, e.g. .github/...)

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 125 lines in your changes missing coverage. Please review.

Project coverage is 8.45%. Comparing base (80ecf19) to head (015c0ad).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
src/confighttp.cpp	0.00%	124 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##           master   #3385      +/-   ##
=========================================
+ Coverage    8.44%   8.45%   +0.01%     
=========================================
  Files          90      90              
  Lines       16074   16054      -20     
  Branches     7636    7626      -10     
=========================================
  Hits         1357    1357              
- Misses      12237   14197    +1960     
+ Partials     2480     500    -1980     

Flag	Coverage Δ
Linux	9.17% <0.00%> (+0.01%)	⬆️
Windows	6.19% <0.00%> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
src/confighttp.cpp	0.00% <0.00%> (ø)

... and 32 files with indirect coverage changes

[ReenigneArcher]

Quality Gate failed

Failed conditions 2 New issues 2 New Code Smells (required ≤ 0)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

std::format is not available in gcc 11

[ReenigneArcher]

I guess we can't return valid int/boolean json?

{
    "status_code": 400,
    "status": false,
    "error": "index out of range, max index is 1"
}

instead of:

{
    "status_code": "400",
    "status": "false",
    "error": "index out of range, max index is 1"
}

[FrogTheFrog]

I mostly looked at cpp code. Other files seem fine.

[sonarqubecloud]

Quality Gate failed

Failed conditions
4 New issues
4 New Code Smells (required ≤ 0)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE