[Schema Inaccuracy] Example response for "List a connection between an external group and a team" is invalid

Open
#5,852 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
openapi
Domain
api, documentation

Research direction

Start with the example response for “List a connection between an external group and a team” in the linked REST API documentation, then compare it with the linked update operation. Done means the list response example contains only one external group, matching the documented one-group limit.

Written by the indexing model from the issue text.

Description

documentation

Schema Inaccuracy

The example response of List a connection between an external group and a team is showing an groups array with 2 groups.
But according to Update the connection between an external group and a team there can only ever be 1 group linked

Creates a connection between a team and an external group. Only one external group can be linked to a team.

Expected

The example response should show an array with 1 group only.

Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
3h 33m
Merged PRs (30d)
51

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.