https://github.com/istio/api

API definitions for the Istio project
https://github.com/istio/api

api

Last synced: 3 days ago
JSON representation

API definitions for the Istio project

• Host: GitHub
• URL: https://github.com/istio/api
• Owner: istio
• License: apache-2.0
• Created: 2016-12-15T18:47:13.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-04-22T11:14:56.000Z (8 months ago)
• Last Synced: 2024-04-22T12:31:38.639Z (8 months ago)
• Topics: api
• Language: Go
• Homepage:
• Size: 16.8 MB
• Stars: 444
• Watchers: 98
• Forks: 530
• Open Issues: 127
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS
  • Security: .github/SECURITY.md
  • Support: SUPPORT.md

Awesome Lists containing this project

• awesome-istio - API - API definitions for the Istio project. (Resources / Official Resources)

README

        
# Istio APIs and Common Configuration Definitions

This repository defines component-level APIs and common configuration formats for the Istio

platform. These definitions are specified using the [protobuf](https://github.com/google/protobuf)

syntax.

This repository depends only on the [tools](https://github.com/istio/tools) repository for tools used during build. This repository *will not* depend on any

other repositories. Except for tools, all other Istio repositories can take a dependency on the api repository.

## API Guidelines

When making changes to the protos in this repository, your changes **must** comply with the [API guidelines](./GUIDELINES.md).

## Updating

After the [protobuf](https://github.com/google/protobuf) definitions

are updated, the corresponding `*pb.go`, `_pb2.py`, `*.json` and

Kubernetes Custom Resource Definition files must be

generated by running `make gen` and submitted as

part of the same PR as the updated definitions. Also `make

gen` will update the proto.lock file with new changes.

## Backwards Incompatible Changes

If a PR tries to make backwards incompatible changes, it will be blocked by `buf breaking`.

If there are legitimate reasons to make these breaking changes forever, the configuration in [`buf.yaml`](buf.yaml) can be changed.

If it is a one-off case, the PR can be force approved skipping the test.