GitHub API questions

Open
#94 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
20/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
github, javascript
Domain
api, documentation

Research direction

Read the linked Contents API and Git Trees API documentation, then inspect the repository-traversal gist. Determine how the root is identified and whether the referenced APIs are affected by the deprecation notice. Done means the issue has clear, current answers and links to suitable examples for traversal and file contents operations.

Written by the indexing model from the issue text.

Description

TL;DR -- How to find the root of a repo for the tree api, and are the content and tree APIs deprecated as of Oct 1?

  1. I'm using the contents API to do a traversal of the directory structure of a repository. It works. Here's a gist containing the code. It takes about three seconds to traverse the structure of my test1 repo. I'm thinking about using the tree API, hoping that it will be considerably faster. But I can't figure out how to get the sha for the root of the repo. Any suggestions much appreciated.

  2. There are notes on the GitHub API website about GitHub Services being deprecated starting October 1. At first I thought this applied to the API I'm using. Now I'm wondering. I'm just using the contents API. Is this part of the deprecated set? If so arrrrgh. And where can I find good sample code for getting and setting the contents of a file and doing a directory traversal.

Dominant language
HTML
Stars
134
Forks
10
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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 scripting/Scripting-News

All issues in scripting/Scripting-News

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.