Endpoints['GET /repos/{owner}/{repo}/git/trees/{tree_sha}'] response is too relaxed

[ojab]

What happened?

It returns components["schemas"]["git-tree"] which has tree field defined as

tree: {
  path?: string;
  mode?: string;
  type?: string;
  sha?: string;
  size?: number;
  url?: string;
}[];

while operations["git/create-tree"] has request params defined as

tree: {
  path?: string;
  mode?: "100644" | "100755" | "040000" | "160000" | "120000";
  type?: "blob" | "tree" | "commit";
  sha?: string | null;
  content?: string;
}[];

so response type is not compatible with request one.

What did you expect to happen?

mode & type should be compatible.

What the problem might be

mode & type on components["schemas"]["git-tree"] should be more strict.

[gr2m]

As in #284, may I ask you to do me a favor and report this issue in https://github.com/github/rest-api-description, similar to e.g. github/rest-api-description#228? I can do it myself eventually but I have other priorities right now. If you could report it we would get it fixed faster

[ojab]

github/rest-api-description#229

[gr2m]

Thanks @ojab. Please let us know once the problem was resolved at github/rest-api-description#229

[rpmccarter]

For folks who find this issue like I did - it's also too relaxed in the sense that path, mode, type, and sha should all be required. I created github/rest-api-description#3833 to fix this (also gave github/rest-api-description#229 a little bump 😄)