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

Fixes #24043: API documentation for compliance by group #5332

Merged
merged 1 commit into from
Jan 31, 2024
Merged

Fixes #24043: API documentation for compliance by group #5332

merged 1 commit into from
Jan 31, 2024

Conversation

clarktsiory
Copy link
Contributor

@clarktsiory clarktsiory commented Jan 19, 2024 •
edited

https://issues.rudder.io/issues/24043

Add public API documentation for these endpoints :

  • /api/compliance/groups/{groupId} (global compliance)
  • /api/compliance/groups/{groupId}/target (targeted compliance)

Also, there was a limitation in redocly to generate examples for nested objects, so we set the config parameter generatedPayloadSamplesMaxDepth to 100. We also update redocly to 1.6.0

@clarktsiory
Copy link
Contributor Author

PR updated with a new commit

1 similar comment
@clarktsiory
Copy link
Contributor Author

PR updated with a new commit

@clarktsiory
Copy link
Contributor Author

PR updated with a new commit

amousset
amousset reviewed Jan 19, 2024
View reviewed changes
webapp/sources/api-doc/components/schemas/group-node-compliance-rules.yml
@@ -0,0 +1,200 @@
type: object
Copy link
Member

Choose a reason for hiding this comment

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

missing license header

Copy link
Contributor Author

Choose a reason for hiding this comment

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

🙈 Added it for all added yaml files : f3b36f7

amousset
amousset reviewed Jan 19, 2024
View reviewed changes
webapp/sources/api-doc/components/schemas/group-node-compliance-rules.yml Outdated
properties:
value:
type: string
example: tutu
Copy link
Member

Choose a reason for hiding this comment

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

we try to avoid "non-realistic" examples ("toto", "tutu", "plop", "username", etc.), and prefer something like docker or john.doe/jane.doe

Copy link
Contributor Author

Choose a reason for hiding this comment

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

(I just copied it from the directives compliance documentation)
1fda62d

@clarktsiory
Copy link
Contributor Author

PR updated with a new commit

1 similar comment
@clarktsiory
Copy link
Contributor Author

PR updated with a new commit

@Normation-Quality-Assistant
Copy link
Contributor

This PR is not mergeable to upper versions.
Since it is "Ready for merge" you must merge it by yourself using the following command:
rudder-dev merge https://github.com/Normation/rudder/pull/5332
-- Your faithful QA
Kant merge: "Science is organized knowledge. Wisdom is organized life."
(https://ci.normation.com/jenkins/job/merge-accepted-pr/79520/console)

@amousset
Copy link
Member

OK, squash merging this PR

@amousset amousset force-pushed the ust_24043/api_documentation_for_compliance_by_group branch from f3b36f7 to ed66905 Compare January 31, 2024 08:21
@amousset amousset merged commit 0566594 into Normation:branches/rudder/8.1 Jan 31, 2024
1 check was pending
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@amousset amousset amousset left review comments

@VinceMacBuche VinceMacBuche Awaiting requested review from VinceMacBuche

Assignees
No one assigned
Labels
qa: Can't merge Ready for merge
Projects
None yet
Milestone
No milestone
3 participants
@clarktsiory @Normation-Quality-Assistant @amousset