Annotations - #25
Conversation
033bee8 to
c8861fe
Compare
There was a problem hiding this comment.
Pull request overview
Adds first-class support for the mPulse Annotations REST API to the mPulseAPI Julia package, including new client functions, documentation, and test coverage.
Changes:
- Introduces
getAnnotations/getAnnotationAPI wrappers and wires in a newAnnotationsEndpoint. - Adds a new Annotations documentation page and includes it in the Documenter build.
- Extends the test suite and CI env to exercise the new Annotations functionality and endpoint switching.
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
src/mPulseAPI.jl |
Adds AnnotationsEndpoint to setEndpoints and includes the new Annotation.jl module. |
src/Annotation.jl |
Implements getAnnotations and getAnnotation with argument validation, HTTP calls, and response parsing. |
test/annotation-tests.jl |
Adds tests for argument validation, auth failures, and basic annotation retrieval behavior. |
test/runtests.jl |
Registers the new "Annotations" testset. |
test/zzz_change-url-tests.jl |
Extends endpoint-change tests to cover AnnotationsEndpoint. |
docs/src/Annotations.md |
Adds a new autodocs page for annotation APIs. |
docs/make.jl |
Includes Annotations.md in the documentation page list. |
Project.toml |
Bumps package version to 1.3.0. |
.github/workflows/CI.yml |
Adds mPulseAPIAnnotationDomainID to CI environment variables. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 9 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 9 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 9 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 9 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 10 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 11 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Add AnnotationsEndpoint global to setEndpoints() derived from the
same APIEndpoint base as all other endpoints
- Add src/Annotation.jl with:
- getAnnotation(token, annotationID) — fetch a single annotation by ID
- getAnnotations(token; domainID, dateStart, dateEnd) — fetch all
annotations for a domain within an optional time range
- Both accept DateTime or ZonedDateTime for date params
- Both follow the same HTTP/error-handling conventions as Alert.jl
- Add test/annotation-tests.jl (guard-gated on mPulseAPIAnnotationDomainID env var)
- Wire annotation-tests.jl into runtests.jl
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- actions/checkout: v4 → v6 - julia-actions/setup-julia: v1/v2 → v3 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
No description provided.