Add an example GitHub API response

trustoverip · Aug 25, 2024 · 98a717a · 98a717a
1 parent 4d1b3e6
commit 98a717a
Showing 1 changed file with 66 additions and 0 deletions.
diff --git a/docs/various-roles/developers-guide.md b/docs/various-roles/developers-guide.md
@@ -112,3 +112,69 @@ node -e "require('/Users/***/path/to/your/spec-up-t/spec-up-t/src/get-xrefs-data
 
 Adjust this based on what you need.
 
+## Github API
+
+### Example of API response:
+
+```json
+[
+  {
+    sha: '117b86fa676c0bd3030c16e8bbb87ebaa61af576',
+    node_id: 'C_kwDOMi-o_toAKDExN2I4NmZhNjc2YzBiZDMwMzBjMTZlOGJiYjg3ZWJhYTYxYWY1NzY',
+    commit: {
+      author: [Object],
+      committer: [Object],
+      message: 'first commit',
+      tree: [Object],
+      url: 'https://api.github.com/repos/****/****/git/commits/117b86fa676c0bd3030c16e8bbb87ebaa61af576',
+      comment_count: 0,
+      verification: [Object]
+    },
+    url: 'https://api.github.com/repos/****/****/commits/117b86fa676c0bd3030c16e8bbb87ebaa61af576',
+    html_url: 'https://github.com/****/****/commit/117b86fa676c0bd3030c16e8bbb87ebaa61af576',
+    comments_url: 'https://api.github.com/repos/****/****/commits/117b86fa676c0bd3030c16e8bbb87ebaa61af576/comments',
+    author: {
+      login: '****',
+      id: 0,
+      node_id: '****',
+      avatar_url: 'https://avatars.githubusercontent.com/u/****?v=4',
+      gravatar_id: '',
+      url: 'https://api.github.com/users/****',
+      html_url: 'https://github.com/****',
+      followers_url: 'https://api.github.com/users/****/followers',
+      following_url: 'https://api.github.com/users/****/following{/other_user}',
+      gists_url: 'https://api.github.com/users/****/gists{/gist_id}',
+      starred_url: 'https://api.github.com/users/****/starred{/owner}{/repo}',
+      subscriptions_url: 'https://api.github.com/users/****/subscriptions',
+      organizations_url: 'https://api.github.com/users/****/orgs',
+      repos_url: 'https://api.github.com/users/****/repos',
+      events_url: 'https://api.github.com/users/****/events{/privacy}',
+      received_events_url: 'https://api.github.com/users/****/received_events',
+      type: 'User',
+      site_admin: false
+    },
+    committer: {
+      login: '****',
+      id: 0,
+      node_id: '****',
+      avatar_url: 'https://avatars.githubusercontent.com/u/****?v=4',
+      gravatar_id: '',
+      url: 'https://api.github.com/users/****',
+      html_url: 'https://github.com/****',
+      followers_url: 'https://api.github.com/users/****/followers',
+      following_url: 'https://api.github.com/users/****/following{/other_user}',
+      gists_url: 'https://api.github.com/users/****/gists{/gist_id}',
+      starred_url: 'https://api.github.com/users/****/starred{/owner}{/repo}',
+      subscriptions_url: 'https://api.github.com/users/****/subscriptions',
+      organizations_url: 'https://api.github.com/users/****/orgs',
+      repos_url: 'https://api.github.com/users/****/repos',
+      events_url: 'https://api.github.com/users/****/events{/privacy}',
+      received_events_url: 'https://api.github.com/users/****/received_events',
+      type: 'User',
+      site_admin: false
+    },
+    parents: []
+  }
+]
+
+```