Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Publish protos #4

Merged
merged 2 commits into from
Jan 26, 2024
Merged

Publish protos #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3400f4
Publish public protos
Jan 26, 2024
590f517
Publish public protos
Jan 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CODEOWNERS
View file
Open in desktop
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @grasskode @petrjanda
265 changes: 0 additions & 265 deletions docs/core_v1.md
View file
Open in desktop

This file was deleted.

19 changes: 18 additions & 1 deletion docs/example_v1.md → docs/example/v1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
- [GetExampleRequest](#example-v1-GetExampleRequest)
- [GetExampleResponse](#example-v1-GetExampleResponse)
- [ListExamplesRequest](#example-v1-ListExamplesRequest)
- [ListExamplesResponse](#example-v1-ListExamplesResponse)
- [RemoveExampleRequest](#example-v1-RemoveExampleRequest)
- [RemoveExampleResponse](#example-v1-RemoveExampleResponse)
- [UpdateExampleRequest](#example-v1-UpdateExampleRequest)
Expand Down Expand Up @@ -122,6 +123,21 @@ ListExamplesRequest streams examples from the server.



<a name="example-v1-ListExamplesResponse"></a>

### ListExamplesResponse



| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| example | [Example](#example-v1-Example) | | |






<a name="example-v1-RemoveExampleRequest"></a>

### RemoveExampleRequest
Expand Down Expand Up @@ -160,6 +176,7 @@ UpdateExampleRequest contains updateable fields inside an example.

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [string](#string) | | Id of the example to update |
| text | [string](#string) | optional | Optional update of the example text. |
| description | [string](#string) | optional | Optional update of the example description. |

Expand Down Expand Up @@ -200,7 +217,7 @@ The service implements a basic CRUD API and contains server streaming example.
| AddExample | [AddExampleRequest](#example-v1-AddExampleRequest) | [AddExampleResponse](#example-v1-AddExampleResponse) | AddExample adds the given example to the system. |
| UpdateExample | [UpdateExampleRequest](#example-v1-UpdateExampleRequest) | [UpdateExampleResponse](#example-v1-UpdateExampleResponse) | UpdateExample updates the given example. Throws an error if the example was not found. |
| GetExample | [GetExampleRequest](#example-v1-GetExampleRequest) | [GetExampleResponse](#example-v1-GetExampleResponse) | GetExample returns the requested example. |
| ListExamples | [ListExamplesRequest](#example-v1-ListExamplesRequest) | [ExampleResponse](#example-v1-ExampleResponse) stream | ListExamples streams the requested examples. |
| ListExamples | [ListExamplesRequest](#example-v1-ListExamplesRequest) | [ListExamplesResponse](#example-v1-ListExamplesResponse) stream | ListExamples streams the requested examples. |
| RemoveExample | [RemoveExampleRequest](#example-v1-RemoveExampleRequest) | [RemoveExampleResponse](#example-v1-RemoveExampleResponse) | RemoveExample removes the provided example from the system. Fails silently if the example was not found. |


Expand Down
18 changes: 17 additions & 1 deletion docs/example_v2.md → docs/example/v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
- [GetExampleRequest](#example-v2-GetExampleRequest)
- [GetExampleResponse](#example-v2-GetExampleResponse)
- [ListExamplesRequest](#example-v2-ListExamplesRequest)
- [ListExamplesResponse](#example-v2-ListExamplesResponse)
- [RemoveExampleRequest](#example-v2-RemoveExampleRequest)
- [RemoveExampleResponse](#example-v2-RemoveExampleResponse)
- [UpdateExampleRequest](#example-v2-UpdateExampleRequest)
Expand Down Expand Up @@ -123,6 +124,21 @@ ListExamplesRequest streams examples from the server.



<a name="example-v2-ListExamplesResponse"></a>

### ListExamplesResponse



| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| example | [Example](#example-v2-Example) | | |






<a name="example-v2-RemoveExampleRequest"></a>

### RemoveExampleRequest
Expand Down Expand Up @@ -202,7 +218,7 @@ The service implements a basic CRUD API and contains server streaming example.
| AddExample | [AddExampleRequest](#example-v2-AddExampleRequest) | [AddExampleResponse](#example-v2-AddExampleResponse) | AddExample adds the given example to the system. |
| UpdateExample | [UpdateExampleRequest](#example-v2-UpdateExampleRequest) | [UpdateExampleResponse](#example-v2-UpdateExampleResponse) | UpdateExample updates the given example. Throws an error if the example was not found. |
| GetExample | [GetExampleRequest](#example-v2-GetExampleRequest) | [GetExampleResponse](#example-v2-GetExampleResponse) | GetExample returns the requested example. |
| ListExamples | [ListExamplesRequest](#example-v2-ListExamplesRequest) | [ExampleResponse](#example-v2-ExampleResponse) stream | ListExamples streams the requested examples. |
| ListExamples | [ListExamplesRequest](#example-v2-ListExamplesRequest) | [ListExamplesResponse](#example-v2-ListExamplesResponse) stream | ListExamples streams the requested examples. |
| RemoveExample | [RemoveExampleRequest](#example-v2-RemoveExampleRequest) | [RemoveExampleResponse](#example-v2-RemoveExampleResponse) | RemoveExample removes the provided example from the system. Fails silently if the example was not found. |


Expand Down
Loading