update listOrgApsMacs description#58
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the OpenAPI metadata version/date and clarifies the listOrgApsMacs endpoint description regarding how BSSIDs are derived from radio MAC addresses.
Changes:
- Bump API spec version from
2604.1.0to2604.1.1and update the published date. - Refine
listOrgApsMacsdescription to explain BSSID derivation via last nibble increment (0–F). - Apply the same updates in both spec files (
workdir/openapi.yamlandmist.openapi.yaml).
Reviewed changes
Copilot reviewed 2 out of 5 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| workdir/openapi.yaml | Updates spec version/date and clarifies the BSSID derivation description for listOrgApsMacs. |
| mist.openapi.yaml | Mirrors the same version/date bump and listOrgApsMacs description clarification. |
Comments suppressed due to low confidence (2)
workdir/openapi.yaml:1
- The description appears to be wrapped in a quoted scalar that ends with a trailing apostrophe (
'). After changing the text into multiple lines, this risks producing invalid YAML or an unintended string value (the trailing'becomes part of the description). Use a YAML block scalar (|or>) for multi-line descriptions, or ensure the quoting is correctly started/ended and remove the stray trailing apostrophe.
mist.openapi.yaml:1 - Same as in
workdir/openapi.yaml: the multi-line description now ends with a trailing apostrophe ('), which can break YAML parsing or introduce an unintended character into the rendered description. Prefer a block scalar for multi-line descriptions or correct the quoting and remove the trailing apostrophe.
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.
No description provided.