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.

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

ticdc-open-api: add an file about ticdc open api #6846

Merged
merged 13 commits into from
Aug 16, 2021

Conversation

asddongmen
Copy link
Contributor

@asddongmen asddongmen commented Aug 12, 2021

What is changed, added or deleted? (Required)

Add docs about the new Open APIs of TiCDC.

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions (in Chinese).

  • master (the latest development version)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

What is the related PR or file link(s)?

Develop openapi for ticdc. #2411

*: add some open API to cdc. #2416

http_*: add create and update changefeed API #2472

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@asddongmen asddongmen added the status/PTAL This PR is ready for reviewing. label Aug 12, 2021
@ti-chi-bot
Copy link
Member

ti-chi-bot commented Aug 12, 2021

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • TomShawn
  • hi-rustin

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot added missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 12, 2021
@TomShawn
Copy link
Contributor

@asddongmen Please add the metadata part and TOC like other documents.

@TomShawn TomShawn self-assigned this Aug 12, 2021
@TomShawn TomShawn added sig/docs Indicates that the Issue or PR belongs to the docs SIG. area/migrate Indicates that the Issue or PR belongs to the area of TiDB migration tools. translation/doing This PR’s assignee is translating this PR. v5.2 This PR/issue applies to TiDB v5.2. and removed missing-translation-status This PR does not have translation status info. labels Aug 12, 2021
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
@sunzhaoyang
Copy link
Contributor

rest LGTM

Copy link
Member

@Rustin170506 Rustin170506 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://docs.github.com/cn/rest/reference/repos

我们在参数说明和内容组织上可不可以参考一下 GitHub API 的文档?

是不是可以把这些 API 按照资源分类加个目录在最前面?

ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
Copy link
Contributor

@zier-one zier-one left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

ticdc/manage-ticdc.md Outdated Show resolved Hide resolved
ticdc/manage-ticdc.md Outdated Show resolved Hide resolved
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Copy link
Member

@Rustin170506 Rustin170506 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

除了 capture 的中文名字,其他的 LGTM。:thumbsup:

ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Aug 16, 2021
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
ticdc/ticdc-open-api.md Outdated Show resolved Hide resolved
Copy link
Contributor

@TomShawn TomShawn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Aug 16, 2021
@TomShawn
Copy link
Contributor

/merge

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: 06527c9

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Aug 16, 2021
@ti-chi-bot ti-chi-bot merged commit 021e379 into pingcap:master Aug 16, 2021
@TomShawn TomShawn added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Aug 18, 2021

# TiCDC Open API

> **警告**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in #6881.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/migrate Indicates that the Issue or PR belongs to the area of TiDB migration tools. sig/docs Indicates that the Issue or PR belongs to the docs SIG. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. status/PTAL This PR is ready for reviewing. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. v5.2 This PR/issue applies to TiDB v5.2.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants