docs(teams-api): fix README inaccuracies against actual source#19
Open
rodmhgl wants to merge 1 commit intoInternalDeveloperPlatform:mainfrom
Open
docs(teams-api): fix README inaccuracies against actual source#19rodmhgl wants to merge 1 commit intoInternalDeveloperPlatform:mainfrom
rodmhgl wants to merge 1 commit intoInternalDeveloperPlatform:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request fixes documentation inaccuracies in the Teams API README by aligning deployment instructions, API response examples, and troubleshooting commands with the actual implementation and deployment manifests.
Changes:
- Updated deployment instructions to reference the correct file path (
deployment.yamlinstead ofk8s/) - Corrected health endpoint response examples to match actual API output (removed non-existent
messageandversionfields) - Fixed port-forward commands to use the correct service port (4200 instead of 80)
- Added missing error handling example for duplicate team names
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Updates workshop/teams-management/teams-api/README.md to align with the actual deployment manifest and API behavior.
Deployment instructions:
API response examples:
"healthy", "teams_count": 0}
Troubleshooting: