api

0.30.0 Opens a new window with list of versions in this module.

The canonical location of the Kubernetes API definition. For more information about how to use this package see README

Latest version published 19 days ago

GitHub

Package Health Score

93 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Active

Explore Similar Packages

Popularity

Recognized

Imported By: 4
GitHub Stars: 623
Forks: 424
Contributors: 370

Usage Popularity

Based on project statistics from the GitHub repository for the Golang package api, we found that it has been 623 times.

The popularity score for Golang modules is calculated based on the number of stars that the project has on GitHub as well as the number of imports by other modules.

Security

No known security issues

Security risks

Direct Vulnerabilities: 0
C
0
H
0
M
0
L

Indirect Vulnerabilities: Check with Snyk

Release Date

Apr 17, 2024

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like api is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 4
Open PR: 1
Last Release: 19 days ago
Last Commit: 6 days ago

Further analysis of the maintenance status of k8s.io/api based on released golang versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that k8s.io/api demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 370
Funding: No

A good and healthy external contribution signal for k8s.io/api project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Ensure all the packages you're using are healthy and well-maintained

Readme

api

Schema of the external API types that are served by the Kubernetes API server.

Purpose

This library is the canonical location of the Kubernetes API definition. Most likely interaction with this repository is as a dependency of client-go.

It is published separately to avoid diamond dependency problems for users who depend on more than one of k8s.io/client-go, k8s.io/apimachinery, k8s.io/apiserver...

Recommended Use

We recommend using the go types in this repo. You may serialize them directly to JSON.

If you want to store or interact with proto-formatted Kubernetes API objects, we recommend using the "official" serialization stack in k8s.io/apimachinery. Directly serializing these types to proto will not result in data that matches the wire format or is compatible with other kubernetes ecosystem tools. The reason is that the wire format includes a magic prefix and an envelope proto. Please see: https://kubernetes.io/docs/reference/using-api/api-concepts/#protobuf-encoding

For the same reason, we do not recommend embedding these proto objects within your own proto definitions. It is better to store Kubernetes objects as byte arrays, in the wire format, which is self-describing. This permits you to use either JSON or binary (proto) wire formats without code changes. It will be difficult for you to operate on both Custom Resources and built-in types otherwise.

Compatibility

Branches track Kubernetes branches and are compatible with that repo.

Where does it come from?

api is synced from https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/api. Code changes are made in that location, merged into k8s.io/kubernetes and later synced here.

Things you should NOT do

https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/api is synced to k8s.io/api. All changes must be made in the former. The latter is read-only.

FAQs

What is api?

The canonical location of the Kubernetes API definition. Visit Snyk Advisor to see a full health score report for api, including popularity, security, maintenance & community analysis.

Is api popular?

The golang package api receives a total of ? weekly downloads. As such, api popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is api well maintained?

We found indications that api maintenance is sustainable demonstrating some project activity. We saw a total of 370 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is api safe to use?

The golang package api was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 5 May-2024, at 04:40 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP