Skip to content

Comments

docs(teams-api): fix README inaccuracies against actual source#19

Open
rodmhgl wants to merge 1 commit intoInternalDeveloperPlatform:mainfrom
rodmhgl:fix/teams_api
Open

docs(teams-api): fix README inaccuracies against actual source#19
rodmhgl wants to merge 1 commit intoInternalDeveloperPlatform:mainfrom
rodmhgl:fix/teams_api

Conversation

@rodmhgl
Copy link
Contributor

@rodmhgl rodmhgl commented Feb 18, 2026

Updates workshop/teams-management/teams-api/README.md to align with the actual deployment manifest and API behavior.

Deployment instructions:

  • Changed kubectl apply -f k8s/ → kubectl apply -f deployment.yaml (no k8s/ subdirectory exists)

API response examples:

  • Removed non-existent message and version fields from /health endpoint examples — actual response is {"status":
    "healthy", "teams_count": 0}

Troubleshooting:

  • Corrected port-forward commands from :80 → :4200 to match the service's actual target port
  • Added missing 400 error example for duplicate team name ("Team name already exists")

Copilot AI review requested due to automatic review settings February 18, 2026 20:43
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.yaml instead of k8s/)
  • Corrected health endpoint response examples to match actual API output (removed non-existent message and version fields)
  • 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant