Project

General

Profile

Actions

Bug #15621

closed

Rudder-api-doc use dict.key parameters which are then wronlgy parsed by python

Added by Félix DALLIDET over 5 years ago. Updated 7 months ago.

Status:
Released
Priority:
N/A
Category:
Rudder API & CLI
Target version:
Severity:
UX impact:
User visibility:
Effort required:
Priority:
0
Name check:
To do
Fix check:
To do
Regression:

Description

We use in the "update node" section:
@apiParam {String} agentKey.status The agent key status (optional). Can be "certified" or "undefined".
@apiParam {String} agentKey.value The agent key value (optional) in PEM format (either certificate or public key).

which is then translated to python and "agentKey.value" is seen as a parameter name of a method which does not make sense.

Actions #1

Updated by Félix DALLIDET over 5 years ago

  • Status changed from New to In progress
  • Assignee set to Félix DALLIDET
Actions #2

Updated by Félix DALLIDET over 5 years ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from Félix DALLIDET to Vincent MEMBRÉ
  • Pull Request set to https://github.com/Normation/rudder-api-doc/pull/69
Actions #3

Updated by Félix DALLIDET over 5 years ago

  • Status changed from Pending technical review to Pending release
Actions #4

Updated by Vincent MEMBRÉ 7 months ago

  • Status changed from Pending release to Released
Actions

Also available in: Atom PDF