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 #22151: API documentation for compliance by directive #4707

Merged
merged 1 commit into from Apr 4, 2023
Merged

Fixes #22151: API documentation for compliance by directive #4707

merged 1 commit into from Apr 4, 2023

Conversation

ElaadF
Copy link
Member

@ElaadF ElaadF commented Mar 20, 2023

@ElaadF
Copy link
Member Author

ElaadF commented Mar 20, 2023

Commit modified

@ElaadF ElaadF force-pushed the ust_22151/api_documentation_for_compliance_by_directive branch from 6384be1 to ee6f2a9 Compare March 20, 2023 08:42
@ElaadF
Copy link
Member Author

ElaadF commented Mar 20, 2023

Commit modified

@ElaadF ElaadF force-pushed the ust_22151/api_documentation_for_compliance_by_directive branch from ee6f2a9 to f087615 Compare March 20, 2023 08:43
@ElaadF
Copy link
Member Author

ElaadF commented Mar 20, 2023

Commit modified

@ElaadF ElaadF force-pushed the ust_22151/api_documentation_for_compliance_by_directive branch from f087615 to 9b0e8e5 Compare March 20, 2023 09:00
@VinceMacBuche
Copy link
Member

It misses the csv

@ElaadF
Copy link
Member Author

ElaadF commented Mar 24, 2023 •
edited

the CSV part is here :
https://github.com/Normation/rudder/pull/4707/files#diff-1b55ddd0a92eb8832b193d724491a1f21cc872fa2a4118877772f9526729cf6cR7

we can't have 2 same endpoints to describe with the format in another section, maybe @amousset knows a way to doing it

@VinceMacBuche
Copy link
Member

I think it should be the same with the parameter format and a second response:
parameters:
- in: query
name: format
schema:
type: string
description: format of export
style: form
explode: false
examples:
oneId:
summary: CSV format for the export
value: [ csv ] # ?format=csv
- $ref: ../../components/parameters/directive-id.yml
responses:
"200":
description: Success

@VinceMacBuche
Copy link
Member

Or at least an example showing it

@ElaadF
Copy link
Member Author

ElaadF commented Mar 27, 2023

PR updated with a new commit

@amousset
Copy link
Member

amousset commented Apr 3, 2023

api doc tests do not pass

@ElaadF
Copy link
Member Author

ElaadF commented Apr 3, 2023

PR updated with a new commit

amousset
amousset reviewed Apr 3, 2023
View reviewed changes
webapp/sources/api-doc/components/responses/compliance-directive-id.yml Outdated
example: 9a1773c9-0889-40b6-be89-f6504443ac1b
name:
type: string
description: name of the directive
Copy link
Member

Choose a reason for hiding this comment

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

you should decide to either start description with an uppercase or not and be consistent with it. IIRC this docs has uppercase.

@ElaadF
Copy link
Member Author

ElaadF commented Apr 3, 2023

PR updated with a new commit

@ElaadF
Copy link
Member Author

ElaadF commented Apr 3, 2023

PR rebased

@ElaadF ElaadF force-pushed the ust_22151/api_documentation_for_compliance_by_directive branch from 4f6a8b3 to 6e61470 Compare April 3, 2023 12:59
@ElaadF
Copy link
Member Author

ElaadF commented Apr 3, 2023

Commit modified

@ElaadF ElaadF force-pushed the ust_22151/api_documentation_for_compliance_by_directive branch from 6e61470 to c6bbac8 Compare April 3, 2023 13:02
@ElaadF
Copy link
Member Author

ElaadF commented Apr 3, 2023

Commit modified

@ElaadF ElaadF force-pushed the ust_22151/api_documentation_for_compliance_by_directive branch from c6bbac8 to c839303 Compare April 3, 2023 13:05
@Normation-Quality-Assistant
Copy link
Contributor

OK, merging this PR

@Normation-Quality-Assistant Normation-Quality-Assistant merged commit 6a7609c into Normation:branches/rudder/7.3 Apr 4, 2023
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@amousset amousset amousset approved these changes

@VinceMacBuche VinceMacBuche Awaiting requested review from VinceMacBuche

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
4 participants
@ElaadF @VinceMacBuche @amousset @Normation-Quality-Assistant