Update reference docs (conceptual and API usage) to match latest APIs#94
Merged
Update reference docs (conceptual and API usage) to match latest APIs#94
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the reference documentation to align with the latest Python API changes in the Measurement Data Services ecosystem. The updates modernize the API interface by moving types to public modules, simplifying parameter names, and clarifying enum values.
Changes:
- Updated import statements to use public API modules instead of internal
_typesmodules - Renamed API parameters for consistency (
extensions→extension,measurement_name→name, field-specific names consolidated toname) - Simplified method signatures (e.g.,
create_aliasnow takes positional parameters instead of keyword arguments) - Updated enum values to remove redundant prefixes (e.g.,
Outcome.OUTCOME_PASSED→Outcome.PASSED) - Renamed field identifiers for clarity (
data_type→value_type,type→step_type/condition_type) - Enhanced data type documentation with more specific type names
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/reference/using-measurement-data-services.md | Updated all code examples to use the latest API signatures, including imports, parameter names, enum values, and query syntax |
| docs/reference/ni-metadata-store.md | Updated field documentation to reflect renamed parameters (extension, name fields) and improved structure with "Core Entities" section |
| docs/reference/ni-data-store.md | Updated field documentation and data type descriptions to match current API, clarified enum values and type nomenclature |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
csjall
approved these changes
Jan 16, 2026
Collaborator
Author
|
@csjall I'm curious if you've read these in detail whether you think it would be at least a good starting point for language-agnostic conceptual documentation for MDS. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this Pull Request accomplish?
Updates the reference documentation to match the latest in the Python APIs
Why should this Pull Request be merged?
Accurate documentation. Also, there's a desire to have conceptual documentation for the Measurement Data Services ecosystem, so this could be a starting point for that.
What testing has been done?
Docs