Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@github/rest-api-operations
Advanced tools
Readme
The decorated OpenAPI files are no longer generated from this repository. The code in this repository has been migrated over to github/docs-internal and a workflow automatically runs a script to decorate dereferenced OpenAPI schema files when PRs are opened in the github/docs-internal
repo by github-openapi-bot
.
A Node.js module that decorates GitHub OpenAPI schemas for rendering on docs.github.com.
curl
, @octokit/core.js, and octokit.rb. See Extensions.slug
properties to each operation for use as unique DOM ids using github-sluggercategory
and subcategory
to support legacy /v3/{category}/{subcategory}
URLsdotcom
and 2.20
This project uses semantic-release and a GitHub Actions workflow to automatically publish a new version of the npm package whenever pull requests are merged to the default branch. To enable this, we give our pull request titles semantic prefixes like fix:
and feat:
. To learn more about semantic-release
and semantic commit messages, watch this YouTube video.
npm install @github/rest-api-operations
The npm module exports a single property schemas
which is an object containing multiple versions of the GitHub REST API schema for api.github.com and all currently supported versions of GitHub Enterprise Server.
const { schemas } = require('@github/rest-api-operations')
console.log(Object.keys(schemas))
// [
// 'api.github.com',
// 'ghes-2.17',
// 'ghes-2.18',
// 'ghes-2.19',
// 'ghes-2.20'
// ]
console.log(schemas['ghes-2.20'])
// [
// { Operation },
// { Operation },
// { Operation },
// ...
// ]
Sometimes it's helpful to preview changes you've made to this module on your local checkout of the GitHub Docs website. Assuming you have the two repositories checked out in the same parent directory, run the following:
cd ~/your-checkout-of/github/docs-internal
npm link ../rest-api-operations
cd ../rest-api-operations
npm run watch
This creates a symlink between the two projects and starts a watcher process that runs the @github/rest-api-operations
build script whenever you make changes to its source files. These changes should be visible on your local development server.
When you're done previewing changes, remove the symlink:
cd ~/your-checkout-of/github/docs-internal
npm unlink ../rest-api-operations
FAQs
A Node.js module that decorates GitHub's OpenAPI schemas for rendering on docs.github.com
The npm package @github/rest-api-operations receives a total of 16 weekly downloads. As such, @github/rest-api-operations popularity was classified as not popular.
We found that @github/rest-api-operations demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 16 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.