Contents api incomplete/incompatible #484

New Issue

cameronbraid · 2021-02-06T07:32:14Z

cameronbraid commented

2021-02-06 07:32:14 +00:00

I am wanting to use the contents api to list files in a directory using

get /repos/{owner}/{repo}/contents/{filepath}

The API docs say Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir

So this endpoint can return a single item or an array of items - however the go-sdk implenments the response type as ContentsResponse struct

Should this go-sdk change to always return a []ContentsResponse and in the case of requesnting a single file, just return a single item in the array ?

I am wanting to use the contents api to list files in a directory using **get /repos/{owner}/{repo}/contents/{filepath}** The API docs say `Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir` So this endpoint can return a single item or an array of items - however the go-sdk implenments the response type as `ContentsResponse struct` Should this go-sdk change to always return a `[]ContentsResponse` and in the case of requesnting a single file, just return a single item in the array ?

cameronbraid commented

2021-02-06 07:35:48 +00:00

Or should a new api method be introduced like ListContents which returns an []ContentsResponse and its up to the caller to call the right one based on them accssing a file or a directory ?

Or should a new api method be introduced like `ListContents` which returns an `[]ContentsResponse` and its up to the caller to call the right one based on them accssing a file or a directory ?

6543 commented

2021-02-06 07:52:10 +00:00

Good questuon, ... If you have good proposal, just let me know. I'll test what is most convinient/intuetive ...