# Proto API Definitions for STAGE Northbound gRPC API

This repository contains the Protocol Buffer (`.proto`) definitions for the STAGE Northbound gRPC API. These definitions serve as the contract for communication between services and should be used to generate client and server code in various programming languages.

This repository also contains the third party api documentation that is released to customers.

## Repository Structure

- Place all `.proto` files and subfolders here, preserving the structure.
- Ensure that the directory hierarchy reflects the package structure defined in the `.proto` files.
- use the documentation folder to work on customer facing documentation.

## Usage

Use the `.proto` files to generate code for your desired language. For example, using `protoc`:
   ```
   protoc --proto_path=. --<language>_out=<output_directory> <proto_file>
   ```

Refer to the documentation in the `.proto` files for details on the API contracts.

## Contribution Guidelines

- Follow the existing directory and package structure when adding new `.proto` files.
- Ensure all `.proto` files are well-documented and validated using `protoc`.
- Submit changes via pull requests with a clear description of the updates.

