Skip to content

Commit

Permalink
adds special note about git components
Browse files Browse the repository at this point in the history
Signed-off-by: Nell Shamrell <[email protected]>
  • Loading branch information
nellshamrell committed Sep 10, 2021
1 parent 804c519 commit 0e6bd58
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/using-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,18 @@ Or, you could access it through the REST API like this:
curl -X GET "https://api.clearlydefined.io/definitions/npm/npmjs/-/lodash/4.17.21" -H "accept: */*"
```

**Special Notes**

For git components, commit hashes, rather than version numbers, are used for revisions.

For example, these coordinates:

```
git/github/react-component/tree/7b90c11c4aa3458010cbc2031ff48ac4803030e4
```

Map to this [commit](https://github.com/react-component/tree/tree/7b90c11c4aa3458010cbc2031ff48ac4803030e4).

### Advanced

As you get more comfortable with using ClearlyDefined's data, you might use these additional coordinate fields as well:
Expand Down

0 comments on commit 0e6bd58

Please sign in to comment.