Skip to content

Commit

Permalink
Fix Semgrep schema doc (#1377)
Browse files Browse the repository at this point in the history
### Summary

Small followup to
#1368, noticed that
the schema doc is not being rendered correctly:


![image](https://github.com/user-attachments/assets/e3f34e94-a7c0-4b39-b243-460fe39acb57)

I'm not sure how to test that it will render correctly after this
change, but this format matches the existing format used by the github
schema:

https://github.com/cartography-cncf/cartography/blob/f11d7b2ff87331ed736a5de2547cde812face1a0/docs/root/modules/github/schema.md?plain=1#L210-L218

---------

Signed-off-by: Hans Wernetti <[email protected]>
  • Loading branch information
hanzo authored Nov 6, 2024
1 parent f11d7b2 commit bf8d667
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/root/modules/semgrep/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +137,9 @@ See [SemgrepDependency](#semgrepdependency) for details.
- A SemgrepDependency is required by a GithubRepository (optional)

```
(:SemgrepDependency)<-[:REQUIRES]-(:GithubRepository)
(:SemgrepDependency)<-[:REQUIRES{specifier, transitivity, url}]-(:GithubRepository)
```

Properties on REQUIRES relationship:
- specifier: A string describing the library version required by the repo (e.g. "==1.0.2")
- transitivity: A string describing whether the dependency is direct or [transitive](https://en.wikipedia.org/wiki/Transitive_dependency) (e.g. direct, transitive)
- url: The URL where the dependency is defined (e.g. https://github.com/org/repo/blob/00000000000000000000000000000000/go.mod#L6)
- url: The URL where the dependency is defined (e.g. `https://github.com/org/repo/blob/00000000000000000000000000000000/go.mod#L6`)

0 comments on commit bf8d667

Please sign in to comment.