-
Epic
-
Resolution: Unresolved
-
Undefined
-
None
-
None
-
None
-
Monitoring APIs Usage Scenarios
-
False
-
None
-
False
-
Not Selected
-
NEW
-
To Do
-
NEW
-
83% To Do, 0% In Progress, 17% Done
OCP/Telco Definition of Done
Epic Template descriptions and documentation.
<--- Cut-n-Paste the entire contents of this description into your new Epic --->
Epic Goal
- Provide precise and automatically tested examples/use cases for how to use the various monitoring APIs.
Why is this important?
- Currently, the doc only provides examples for some use cases.
- The the provided examples assume the user has access to the API.
- The the provided examples are not regularly tested and can diverge.
- The rest of the examples are split across multiple KCS, which make them hard to find, also those examples are not regularly tested.
- Support requests about a procedure or a permission not working are time consuming.
Scenarios
- ...
Acceptance Criteria
Dependencies (internal and external)
- ...
Previous Work (Optional):
- ...
Open questions::
- ...
Done Checklist
- CI - CI is running, tests are automated and merged.
- Release Enablement <link to Feature Enablement Presentation>
- DEV - Upstream code and tests merged: <link to meaningful PR or GitHub Issue>
- DEV - Upstream documentation merged: <link to meaningful PR or GitHub Issue>
- DEV - Downstream build attached to advisory: <link to errata>
- QE - Test plans in Polarion: <link or reference to Polarion>
- QE - Automated tests merged: <link or reference to automated tests>
- DOC - Downstream documentation merged: <link to meaningful PR>
- is triggered by
-
OBSDOCS-899 Improve monitoring content for API access
- In Progress