Generated TypeScript definitions based on GitHub's OpenAPI spec
Installations
npm install @octokit/openapi-typesDeveloper Guide
Typescript
Yes
Module System
N/A
Node Version
22.12.0
NPM Version
10.9.2
Releases
Contributors
Languages
JavaScript (100%)
Developer
octokit
Download Statistics
Total Downloads
1,541,129,595
Last Day
2,813,262
Last Week
12,894,211
Last Month
56,520,326
Last Year
628,537,153
GitHub Statistics
41 Stars
470 Commits
10 Forks
9 Watching
6 Branches
16 Contributors
Maintainers
Package Meta Information
Latest Version
23.0.1
Package Id
@octokit/openapi-types@23.0.1
Unpacked Size
4.28 MB
Size
451.06 kB
File Count
4
NPM Version
10.9.2
Node Version
22.12.0
Publised On
08 Jan 2025
Total Downloads
Cumulative downloads
Total Downloads
1,541,129,595
Last day
-3.7%
2,813,262
Compared to previous day
Last week
-12%
12,894,211
Compared to previous week
Last month
6.6%
56,520,326
Compared to previous month
Last year
37.4%
628,537,153
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
No dependencies detected.
@octokit/openapi-types
Generated TypeScript definitions based on GitHub's OpenAPI spec
This package is continuously updated based on GitHub's OpenAPI specification
Usage
1import { components } from "@octokit/openapi-types"; 2 3type Repository = components["schemas"]["full-repository"];
License
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release.yml:17
Reason
0 existing vulnerabilities detected
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Warn: One or no descriptive hints of disclosure, vulnerability, and/or timelines in security policy
- Info: Found text in security policy: SECURITY.md:1
Reason
SAST tool detected but not run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Warn: 29 commits out of 30 are checked with a SAST tool
Reason
9 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 8
Reason
Found 6/7 approved changesets -- score normalized to 8
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/add_to_octokit_project.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/add_to_octokit_project.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/codeql-analysis.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/immediate-response.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/immediate-response.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/prettier.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/prettier.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/prettier.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/prettier.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-notification.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/release-notification.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-notification.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/release-notification.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/update-prettier.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/update-prettier.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/update-prettier.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/update.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/update.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/update.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/update.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/update.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/update.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/update.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/openapi-types.ts/update.yml/main?enable=pin
- Info: 0 out of 13 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 7 third-party GitHubAction dependencies pinned
- Info: 4 out of 4 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:28
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:29
- Warn: no topLevel permission defined: .github/workflows/add_to_octokit_project.yml:1
- Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1
- Warn: no topLevel permission defined: .github/workflows/prettier.yml:1
- Warn: no topLevel permission defined: .github/workflows/release-notification.yml:1
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/release.yml:11
- Warn: no topLevel permission defined: .github/workflows/update-prettier.yml:1
- Warn: no topLevel permission defined: .github/workflows/update.yml:1
- Info: no jobLevel write permissions found
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
7.1
/10
Last Scanned on 2025-01-27
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn MoreOther packages similar to @octokit/openapi-types
@octokit/openapi-webhooks-types
Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
@octokit/openapi-types-ghec
Generated TypeScript definitions based on GitHub's OpenAPI spec for ghec
@octokit/openapi-types-ghes-3.5
Generated TypeScript definitions based on GitHub's OpenAPI spec for ghes-3.5
@octokit/openapi-types-ghes-3.6
Generated TypeScript definitions based on GitHub's OpenAPI spec for ghes-3.6