Skip to content

Commit

Permalink
feat(#9): docs
Browse files Browse the repository at this point in the history
  • Loading branch information
h1alexbel committed Oct 2, 2024
1 parent b5bee45 commit 1bf4dda
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,26 @@ query ($searchQuery: String!, $first: Int, $after: String) {
}
```

### Parsing Schema

To parse response generated by [GraphQL Query](#graphql-query), you should
provide the parsing schema. This schema should have all desired metadata field
names as keys and path to the data in response as values.

For instance:

```json
{
"repo": "nameWithOwner",
"branch": "defaultBranchRef.name",
"readme": "defaultBranchRef.target.repository.object.text",
"topics": "repositoryTopics.edges[].node.topic.name",
"lastCommitDate": "defaultBranchRef.target.history.edges[0].node.committedDate",
"commits": "defaultBranchRef.target.history.totalCount",
"workflows": "object.entries.length"
}
```

## How to contribute

Fork repository, make changes, send us a [pull request](https://www.yegor256.com/2014/04/15/github-guidelines.html).
Expand Down

0 comments on commit 1bf4dda

Please sign in to comment.