chore: update all links to official API reference (DM-3537)#2496
Merged
haakonvt merged 1 commit intopysdk-release-v8from Mar 2, 2026
Merged
chore: update all links to official API reference (DM-3537)#2496haakonvt merged 1 commit intopysdk-release-v8from
haakonvt merged 1 commit intopysdk-release-v8from
Conversation
haakonvt
changed the title
haakonvt
changed the title
Contributor
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request systematically updates all external API reference links throughout the SDK's docstrings. The primary goal is to redirect users to the most current and official API documentation hosted on Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates numerous documentation links to point to the new API reference. The changes are largely correct, but I've identified one URL that appears to use an incorrect -alpha version string, which should be corrected for consistency.
|
|
||
| async def get_data_async(self) -> SimulatorModelRevisionData | None: | ||
| """`Retrieve data associated with this simulator model revision. <https://developer.cognite.com/api#tag/Simulator-Models/operation/retrieve_simulator_model_revision_data>`_ | ||
| """`Retrieve data associated with this simulator model revision. <https://api-docs.cognite.com/20230101-alpha/tag/Simulator-Models/operation/retrieve_simulator_model_revision_data>`_ |
Contributor
There was a problem hiding this comment.
The updated URL contains -alpha in the version string (20230101-alpha), which is inconsistent with the other updated URLs in this pull request that use 20230101. For consistency, this should be updated to use the 20230101 version string.
Suggested change
| """`Retrieve data associated with this simulator model revision. <https://api-docs.cognite.com/20230101-alpha/tag/Simulator-Models/operation/retrieve_simulator_model_revision_data>`_ | |
| """`Retrieve data associated with this simulator model revision. <https://api-docs.cognite.com/20230101/tag/Simulator-Models/operation/retrieve_simulator_model_revision_data>`_ |
Contributor
Author
There was a problem hiding this comment.
@gemini-code-assist yes that links to the alpha version of the docs because it is in alpha...
Contributor
There was a problem hiding this comment.
Thank you for the clarification. I understand that the -alpha in the version string is intentional for this specific link because it points to an alpha version of the documentation. My apologies for the incorrect suggestion.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## pysdk-release-v8 #2496 +/- ##
====================================================
- Coverage 64.61% 64.60% -0.02%
====================================================
Files 467 467
Lines 47745 47745
====================================================
- Hits 30852 30844 -8
- Misses 16893 16901 +8
🚀 New features to boost your workflow:
|
Contributor
Author
|
🦄 |
haakonvt
added
risk-review-ongoing
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
2 participants
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.
Manually re-apply of #2486 due to one trillion merge conflicts (attempting to merge
master->pysdk-release-v8)...