Skip to content

Commit 1cd9db3

Browse files
authored
Replace old url with new url, show client urls (#592)
This change updates the document URL and introduces multiple clients in the README. The document has switched to using GitHub Pages, moving from https://rubydoc.info/gems/line-bot-api to https://line.github.io/line-bot-sdk-ruby/. Additionally, since finding the various clients without any explanation can be challenging, an introduction has been added in the README. There's no absolute need to add this to the migration guide, as the correct link to v2 code is already provided in the comments of v1 code. related to: #588
1 parent 7a0de2b commit 1cd9db3

File tree

3 files changed

+27
-3
lines changed

3 files changed

+27
-3
lines changed

.yardopts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
-
22
*.md
3+
LICENSE

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ See the official API documentation for more information
1515

1616
Also, generated documentation by YARD is available.
1717

18-
- https://rubydoc.info/gems/line-bot-api
18+
- https://line.github.io/line-bot-sdk-ruby/
19+
- https://line.github.io/line-bot-sdk-ruby/_index.html
1920

2021
## Requirements
2122
This library requires Ruby 3.2 or later.
@@ -116,6 +117,28 @@ post '/callback' do
116117
end
117118
```
118119

120+
### Main classes
121+
You may use this classes to use LINE Messaging API features.
122+
123+
#### Webhook
124+
- [Line::Bot::V2::WebhookParser](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/WebhookParser.html) ([LINE Developers](https://developers.line.biz/en/reference/messaging-api/#webhooks))
125+
- [Line::Bot::V2::Event](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/Webhook/Event.html) ([LINE Developers](https://developers.line.biz/en/reference/messaging-api/#webhook-event-objects))
126+
127+
### Clients
128+
129+
| Class(YARD documentation) | API EndPoint | LINE Developers |
130+
|----------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
131+
| [Line::Bot::V2::ChannelAccessToken::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/ChannelAccessToken/ApiClient.html) | https://api.line.me/** (related to oauth) | https://developers.line.biz/en/reference/messaging-api/#channel-access-token |
132+
| [Line::Bot::V2::Insight::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/Insight/ApiClient.html) | https://api.line.me/v2/bot/insight/** | https://developers.line.biz/en/reference/messaging-api/#get-insight |
133+
| [Line::Bot::V2::Liff::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/Liff/ApiClient.html) | https://api.line.me/liff/** | https://developers.line.biz/en/reference/liff-server/#server-api |
134+
| [Line::Bot::V2::ManageAudience::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/ManageAudience/ApiClient.html) | https://api.line.me/v2/bot/audienceGroup/** | https://developers.line.biz/en/reference/messaging-api/#manage-audience-group |
135+
| [Line::Bot::V2::ManageAudience::ApiBlobClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/ManageAudience/ApiBlobClient.html) | https://api-data.line.me/v2/bot/audienceGroup/** | https://developers.line.biz/en/reference/messaging-api/#manage-audience-group |
136+
| [Line::Bot::V2::MessagingApi::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/MessagingApi/ApiClient.html) | https://api.line.me/v2/bot/** | https://developers.line.biz/en/reference/messaging-api/<br/>https://developers.line.biz/en/reference/partner-docs/ |
137+
| [Line::Bot::V2::MessagingApi::ApiBlobClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/MessagingApi/ApiBlobClient.html) | https://api-data.line.me/v2/bot/** | https://developers.line.biz/en/reference/messaging-api/ |
138+
| [Line::Bot::V2::Module::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/Module/ApiClient.html) | https://api.line.me/v2/bot/** (related to module) | https://developers.line.biz/en/reference/partner-docs/#module |
139+
| [Line::Bot::V2::ModuleAttach::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/ModuleAttach/ApiClient.html) | https://manager.line.biz/module/auth/v1/token/** | https://developers.line.biz/en/reference/partner-docs/#module |
140+
| [Line::Bot::V2::Shop::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/Shop/ApiClient.html) | https://api.line.me/shop/** | https://developers.line.biz/en/reference/partner-docs/#mission-stickers |
141+
119142
### Use HTTP Information
120143
You may need to store the ```x-line-request-id``` header obtained as a response from several APIs.\
121144
In this case, please use ```*_with_http_info``` methods. You can get headers and status codes.\
@@ -292,7 +315,7 @@ See https://semver.org/
292315

293316
### v1 and v2
294317
v1 and v2 are completely different implementations. Migration to v2 is strongly recommended.
295-
Please refer to [Migration guide](migration_from_v1_to_v2_guide) for migration procedure.
318+
Please refer to [Migration guide](migration_from_v1_to_v2_guide.md) for migration procedure.
296319

297320
## Media
298321
News: https://developers.line.biz/en/news/

line-bot-api.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
1717
spec.metadata = {
1818
"bug_tracker_uri" => "#{spec.homepage}/issues",
1919
"changelog_uri" => "#{spec.homepage}/releases",
20-
"documentation_uri" => "https://rubydoc.info/gems/#{spec.name}/#{spec.version}",
20+
"documentation_uri" => "https://line.github.io/line-bot-sdk-ruby/",
2121
"homepage_uri" => spec.homepage,
2222
"source_code_uri" => spec.homepage,
2323
}

0 commit comments

Comments
 (0)