hc api doc #5703

StekPerepolnen · 2024-06-19T08:28:49Z

Changelog entry

hc api improvement

Changelog category

Documentation (changelog entry is not required)

Additional information

...

github-actions · 2024-06-19T08:36:38Z

✅ Documentation build

Revision built successfully
Revision preview link

ydb/docs/en/core/reference/ydb-sdk/health-check-api.md

github-actions · 2024-06-19T12:44:42Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-06-19T12:51:26Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-06-19T13:14:02Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-06-20T10:13:51Z

✅ Documentation build

Revision built successfully
Revision preview link

Co-authored-by: Ivan Blinkov <ivan@blinkov.ru>

github-actions · 2024-06-25T07:17:56Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-06-25T08:51:24Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-06-25T08:56:56Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-06-25T10:03:57Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-06-25T12:05:23Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-06-25T12:14:02Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-06-25T12:20:09Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-06-25T12:25:21Z

❌ Documentation build

Revision build failed

Build logs

Errors (1)

❌ /ru/reference/ydb-sdk/health-check-api.md: 77: YFM005/tab-list-not-closed Tab list not closed [Context: "Полный список дополнительных параметров представлен ниже:"]

github-actions · 2024-06-25T12:35:58Z

❌ Documentation build

Revision build failed

Build logs

Errors (1)

❌ /ru/reference/ydb-sdk/health-check-api.md: 78: YFM005/tab-list-not-closed Tab list not closed [Context: "Полный список дополнительных параметров представлен ниже:"]

github-actions · 2024-06-25T12:56:52Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-06-25T13:08:10Z

✅ Documentation build

Revision built successfully
Revision preview link

blinkov

many comments from the previous iteration are not fixed

ydb/docs/en/core/reference/ydb-sdk/health-check-api.md

github-actions · 2024-06-26T06:26:23Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-06-26T06:44:36Z

✅ Documentation build

Revision built successfully
Revision preview link

blinkov · 2024-06-28T12:12:37Z

ydb/docs/en/core/reference/ydb-sdk/health-check-api.md

+## Example {#examples}
+The shortest `HealthCheck` response looks like this. It is returned if there is nothing wrong with the database


Suggested change

## Example {#examples}

The shortest `HealthCheck` response looks like this. It is returned if there is nothing wrong with the database

## Example {#examples}

The shortest `HealthCheck` response looks like this. It is returned if there is nothing wrong with the database

blinkov · 2024-06-28T12:21:22Z

ydb/docs/en/core/reference/ydb-sdk/health-check-api.md

+| Parameter | Type | Description |
+|:----|:----|:----|
+| `ReturnVerboseStatus` | `bool`         | As mentioned earlier, this parameter affects the filling of the `database_status` field. Default is false. |
+| `MinimumStatus`       | `EStatusFlag`  | The minimum severity status that will appear in the response. Less severe issues will be discarded. By default, all issues will be listed. |


Let's add a link to the list of possible EStatusFlag values

blinkov · 2024-06-28T12:21:51Z

ydb/docs/en/core/reference/ydb-sdk/health-check-api.md

+|:----|:----|:----|
+| `ReturnVerboseStatus` | `bool`         | As mentioned earlier, this parameter affects the filling of the `database_status` field. Default is false. |
+| `MinimumStatus`       | `EStatusFlag`  | The minimum severity status that will appear in the response. Less severe issues will be discarded. By default, all issues will be listed. |
+| `MaximumLevel`        | `int32`        | The maximum depth of issues in the response. Issues at deeper levels will be discarded. By default, all issues will be listed. |


why is it signed? what do negative values mean?

StekPerepolnen requested a review from a team as a code owner June 19, 2024 08:28

github-actions bot added new-feature documentation Improvements or additions to documentation labels Jun 19, 2024

StekPerepolnen force-pushed the hc-api-doc branch from f903644 to 3362f67 Compare June 19, 2024 08:31

blinkov requested changes Jun 19, 2024

View reviewed changes

health check docs

af967e6

StekPerepolnen force-pushed the hc-api-doc branch from 255cab2 to af967e6 Compare June 20, 2024 10:08

Update ydb/docs/en/core/reference/ydb-sdk/health-check-api.md

63b7382

Co-authored-by: Ivan Blinkov <ivan@blinkov.ru>

doc update

e9a1b94

StekPerepolnen force-pushed the hc-api-doc branch from 3b4be0d to e9a1b94 Compare June 25, 2024 08:50

added examples

783826f

StekPerepolnen force-pushed the hc-api-doc branch from cb51390 to c51c9e4 Compare June 25, 2024 12:06

StekPerepolnen force-pushed the hc-api-doc branch from c51c9e4 to 1aeeaec Compare June 25, 2024 12:16

StekPerepolnen force-pushed the hc-api-doc branch from 1aeeaec to 0a64c0e Compare June 25, 2024 12:20

StekPerepolnen force-pushed the hc-api-doc branch from 0a64c0e to 32b6408 Compare June 25, 2024 12:29

creating client snippet

3629dbe

StekPerepolnen force-pushed the hc-api-doc branch from 32b6408 to 3629dbe Compare June 25, 2024 12:42

border line

65051bf

StekPerepolnen requested a review from blinkov June 25, 2024 12:52

tabulation

d9ef7b6

blinkov requested changes Jun 26, 2024

View reviewed changes

ydb/docs/en/core/reference/ydb-sdk/health-check-api.md Outdated Show resolved Hide resolved

ydb/docs/en/core/reference/ydb-sdk/health-check-api.md Outdated Show resolved Hide resolved

ydb/docs/en/core/reference/ydb-sdk/health-check-api.md Outdated Show resolved Hide resolved

changed namespace

c81854a

issues issue

52002db

StekPerepolnen requested a review from blinkov June 26, 2024 06:41

blinkov reviewed Jun 28, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

hc api doc #5703

hc api doc #5703

StekPerepolnen commented Jun 19, 2024 •

edited

Loading

github-actions bot commented Jun 19, 2024

github-actions bot commented Jun 19, 2024

github-actions bot commented Jun 19, 2024

github-actions bot commented Jun 19, 2024

github-actions bot commented Jun 20, 2024

github-actions bot commented Jun 25, 2024

github-actions bot commented Jun 25, 2024

github-actions bot commented Jun 25, 2024

github-actions bot commented Jun 25, 2024

github-actions bot commented Jun 25, 2024

github-actions bot commented Jun 25, 2024

github-actions bot commented Jun 25, 2024

github-actions bot commented Jun 25, 2024

github-actions bot commented Jun 25, 2024

github-actions bot commented Jun 25, 2024

github-actions bot commented Jun 25, 2024

blinkov left a comment

github-actions bot commented Jun 26, 2024

github-actions bot commented Jun 26, 2024

blinkov Jun 28, 2024

blinkov Jun 28, 2024

blinkov Jun 28, 2024

		## Example {#examples}
		The shortest `HealthCheck` response looks like this. It is returned if there is nothing wrong with the database

hc api doc #5703

Are you sure you want to change the base?

hc api doc #5703

Conversation

StekPerepolnen commented Jun 19, 2024 • edited Loading

Changelog entry

Changelog category

Additional information

github-actions bot commented Jun 19, 2024

✅ Documentation build

github-actions bot commented Jun 19, 2024

✅ Documentation build

github-actions bot commented Jun 19, 2024

✅ Documentation build

github-actions bot commented Jun 19, 2024

✅ Documentation build

github-actions bot commented Jun 20, 2024

✅ Documentation build

github-actions bot commented Jun 25, 2024

✅ Documentation build

github-actions bot commented Jun 25, 2024

✅ Documentation build

github-actions bot commented Jun 25, 2024

✅ Documentation build

github-actions bot commented Jun 25, 2024

✅ Documentation build

github-actions bot commented Jun 25, 2024

✅ Documentation build

github-actions bot commented Jun 25, 2024

✅ Documentation build

github-actions bot commented Jun 25, 2024

✅ Documentation build

github-actions bot commented Jun 25, 2024

❌ Documentation build

Build logs

Errors (1)

github-actions bot commented Jun 25, 2024

❌ Documentation build

Build logs

Errors (1)

github-actions bot commented Jun 25, 2024

✅ Documentation build

github-actions bot commented Jun 25, 2024

✅ Documentation build

blinkov left a comment

Choose a reason for hiding this comment

github-actions bot commented Jun 26, 2024

✅ Documentation build

github-actions bot commented Jun 26, 2024

✅ Documentation build

blinkov Jun 28, 2024

Choose a reason for hiding this comment

blinkov Jun 28, 2024

Choose a reason for hiding this comment

blinkov Jun 28, 2024

Choose a reason for hiding this comment

StekPerepolnen commented Jun 19, 2024 •

edited

Loading