[DOCS] Adds description to Rollup APIs #2253

szabosteve · 2023-08-28T15:31:36Z

Overview

Related to #964.

Adds descriptions to Rollup API properties. Source of info:

abdonpijpelink

LGTM. Left a minor suggestion.

specification/rollup/_types/Groupings.ts

Co-authored-by: Abdon Pijpelink <[email protected]>

github-actions · 2023-08-28T18:21:39Z

Following you can find the validation results for the APIs you have changed.

API	Status	Request	Response
`rollup.delete_job`	🟢	3/3	3/3
`rollup.get_jobs`	🟢	11/11	11/11
`rollup.get_rollup_caps`	🟢	3/3	3/3
`rollup.get_rollup_index_caps`	🟢	7/7	7/7
`rollup.put_job`	🟢	23/23	23/23
`rollup.rollup_search`	🟢	18/18	18/18
`rollup.start_job`	🟢	8/8	8/8
`rollup.stop_job`	🟢	5/5	5/5

You can validate these APIs yourself by using the make validate target.

[DOCS] Adds description to rollup APIs.

658677a

szabosteve requested a review from abdonpijpelink August 28, 2023 15:31

github-actions bot added the specification label Aug 28, 2023

Merge branch 'main' into szabosteve/rollups

882c4e7

szabosteve mentioned this pull request Aug 28, 2023

[DOCS] Add descriptions to API spec files #964

Closed

64 tasks

szabosteve marked this pull request as ready for review August 28, 2023 15:32

abdonpijpelink approved these changes Aug 28, 2023

View reviewed changes

specification/rollup/_types/Groupings.ts Outdated Show resolved Hide resolved

Update specification/rollup/_types/Groupings.ts

4cc014e

Co-authored-by: Abdon Pijpelink <[email protected]>

szabosteve merged commit f7a647c into main Aug 28, 2023
5 checks passed

szabosteve deleted the szabosteve/rollups branch August 28, 2023 18:23