Skip to content

Commit

Permalink
feat: add config documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Matthis Holleville <matthish29@gmail.com>
  • Loading branch information
matthisholleville committed May 23, 2023
1 parent b1e1059 commit ed804f9
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion protobuf/buf.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,12 @@ The `AnalyzeResponse` object contains an `Error` object, which can be used to in

The `results` field contains a list of `Result` objects, each of which describes an item analyzed by the tool. Each `Result` object contains a `kind` field that describes the type of item (e.g. Deployment, Pod, Service), a `name` field that specifies the name of the item, a list of `ErrorDetail` objects that describe any errors found during analysis of the item, a `details` field that contains additional information about the item, and a `parent_object` field that specifies the name of the parent object, if any.

The `AnalysisItem` object represents an item that can be analyzed by the tool. It contains a name field that specifies the `name` of the item, and a `description` field that provides a brief description of the item.
The `AnalysisItem` object represents an item that can be analyzed by the tool. It contains a name field that specifies the `name` of the item, and a `description` field that provides a brief description of the item.

### Config

The module `config.v1` contains a single `Service` with one rpc named `Config`. The request object for the `Config` method is `ConfigRequest`, which contains parameters for configuring the system. The response object for the `Config` method is `ConfigResponse`, which contains the status of the configuration operation.

The `ConfigRequest` object contains a `Cache` object, which is used to specify cache configuration. The `Cache` object has two fields: `region`, which represents the cache region, and `bucketName`, which represents the name of the cache bucket.

The `ConfigResponse` object contains a status field, which indicates the status of the configuration operation. The value of the status field can be either "ok" or "ko", indicating a successful or unsuccessful configuration, respectively.

0 comments on commit ed804f9

Please sign in to comment.