Fix variable naming for [ROS] version service #8292
Merged
Conversation
This file contains 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
chris48s
reviewed
Aug 9, 2022
| @@ -43,12 +43,12 @@ const packageSchema = Joi.object({ | |||
| export default class RosVersion extends GithubAuthV4Service { | |||
| static category = 'version' | |||
|
|
|||
| static route = { base: 'ros/v', pattern: ':distro/:packageName' } | |||
| static route = { base: 'ros/v', pattern: ':distro/:repoName' } | |||
|
|
|||
| static examples = [ | |||
| { | |||
| title: 'ROS Package Index', | |||
There was a problem hiding this comment.
Given the confusion so far, as well as changing the internal terminology (var/test names, etc) shall we attempt to clarify this a bit more in the user-facing text? We could consider changing the title here to clarify that the 'unit of versioning' (for want of a better term) here is the repo not the package. The other thing we sometimes do is include a documentation key in the example (e.g:
shields/services/osslifecycle/osslifecycle.service.js
Lines 3 to 12 in 23c0406
repoName param corresponds to in ROS-land or link to relevant documentation. I'm not 100% sure what to suggest as the platform specifics of ROS are out of my wheelhouse, but perhaps we can do a bit more to explain.
There was a problem hiding this comment.
Added some documentation:
chris48s
approved these changes
Aug 9, 2022
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.
The version information that this service is fetching is the version for a whole repository of ROS packages which all share the same version. A repository may contain only a single package with the same name, but it may also contain multiple packages, and this badge service fetches version information based on the repo name, not the package name.