Project

General

Profile

User story #8584

The compliance API is missing a global compliance target

Added by Matthieu CERDA over 2 years ago. Updated 9 months ago.

Status:
Released
Priority:
4
Category:
API
Target version:
Suggestion strength:
User visibility:
Effort required:

Description

I'd love to have an "/api/compliance" URL that gives the equivalent of the info we have on the dasbboard, like:
  • Global compliance
  • Compliance defails (% of success, repaired, no report, unknown, error and missing)

Moreover, we could then use this API to get the values for the dashboard when possible :)


Related issues

Related to Rudder - User story #6820: The dashboard should display something when no reporting data is available (new installation)Rejected
Related to Rudder - Bug #13149: Global compliance API is not documentedReleased

Associated revisions

Revision 7287bffd (diff)
Added by François ARMAND 10 months ago

Fixes #8584: The compliance API is missing a global compliance target

Revision a4f713d6 (diff)
Added by François ARMAND 10 months ago

Fixes #8584: The compliance API is missing a global compliance target

History

#1 Updated by François ARMAND over 2 years ago

  • Target version changed from Ideas (not version specific) to 4.0.0~rc2

#2 Updated by François ARMAND about 2 years ago

  • Tracker changed from Bug to User story
  • Target version changed from 4.0.0~rc2 to 4.1.0~beta1

#3 Updated by Vincent MEMBRÉ almost 2 years ago

  • Target version changed from 4.1.0~beta1 to 4.1.0~beta2

#4 Updated by Vincent MEMBRÉ almost 2 years ago

  • Target version changed from 4.1.0~beta2 to 4.1.0~beta3

#5 Updated by Vincent MEMBRÉ almost 2 years ago

  • Target version changed from 4.1.0~beta3 to 4.1.0~rc1

#6 Updated by François ARMAND almost 2 years ago

  • Target version changed from 4.1.0~rc1 to 4.2.0~beta1

#7 Updated by Alexis MOUSSET over 1 year ago

  • Target version changed from 4.2.0~beta1 to 4.2.0~beta2

#8 Updated by Vincent MEMBRÉ over 1 year ago

  • Target version changed from 4.2.0~beta2 to 4.2.0~beta3

#9 Updated by Vincent MEMBRÉ over 1 year ago

  • Target version changed from 4.2.0~beta3 to 4.2.0~rc1

#10 Updated by Vincent MEMBRÉ over 1 year ago

  • Target version changed from 4.2.0~rc1 to 4.2.0~rc2

#11 Updated by Vincent MEMBRÉ about 1 year ago

  • Target version changed from 4.2.0~rc2 to 4.2.0

#12 Updated by Vincent MEMBRÉ about 1 year ago

  • Target version changed from 4.2.0 to 4.2.1

#13 Updated by Vincent MEMBRÉ about 1 year ago

  • Target version changed from 4.2.1 to 4.2.2

#14 Updated by Vincent MEMBRÉ about 1 year ago

  • Target version changed from 4.2.2 to 4.2.3

#15 Updated by Vincent MEMBRÉ about 1 year ago

  • Target version changed from 4.2.3 to 4.2.4

#16 Updated by François ARMAND 10 months ago

  • Target version changed from 4.2.4 to 4.3.0~rc1

#17 Updated by François ARMAND 10 months ago

  • Status changed from New to In progress

#18 Updated by François ARMAND 10 months ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from François ARMAND to Vincent MEMBRÉ
  • Pull Request set to https://github.com/Normation/rudder/pull/1850

#19 Updated by François ARMAND 10 months ago

The PR add a new endpoint for "/compliance" with a return value of:

% curl -k -H "X-API-Token: ..." -H "Content-Type: application/json" -X GET 'https://.../api/latest/compliance'
{"action":"getGlobalCompliance","result":"success","data":{"globalCompliance":{"compliance":0,"complianceDetails"}}

When no non-system rules are defined, "compliane":-1 is returned without complianceDetails.

The PR also update rudder dashboard to print a message when no non-system rules are defined with a link toward rules.

#20 Updated by François ARMAND 10 months ago

  • Related to User story #6820: The dashboard should display something when no reporting data is available (new installation) added

#21 Updated by Normation Quality Assistant 10 months ago

  • Assignee changed from Vincent MEMBRÉ to François ARMAND

#22 Updated by François ARMAND 10 months ago

  • Status changed from Pending technical review to Pending release

#23 Updated by Vincent MEMBRÉ 9 months ago

  • Status changed from Pending release to Released

This bug has been fixed in Rudder 4.3.0~rc1 which was released today.

#24 Updated by Alexis MOUSSET 4 months ago

  • Related to Bug #13149: Global compliance API is not documented added

Also available in: Atom PDF