From 001cc6fda4c10bde2b2d8689f1802a4257b3efc8 Mon Sep 17 00:00:00 2001 From: seeflood Date: Fri, 4 Nov 2022 15:01:05 +0800 Subject: [PATCH] chore: improve issue templates && generator templates (#841) --- .../good-first-issue-component.md | 22 +- .../good-first-issue-go-demo.md | 36 ++++ .../good-first-issue-java-demo.md | 36 ++++ docs/api/v1/cryption.html | 189 ----------------- docs/api/v1/delay_queue.html | 191 +----------------- docs/api/v1/email.html | 189 ----------------- docs/api/v1/phone.html | 191 +----------------- docs/api/v1/runtime.html | 189 ----------------- docs/api/v1/s3.html | 189 ----------------- docs/api/v1/sms.html | 189 ----------------- docs/en/start/cryption/start.md | 2 + docs/en/start/delay_queue/start.md | 3 + docs/en/start/email/start.md | 2 + docs/en/start/lock/start.md | 5 +- docs/en/start/phone/start.md | 4 +- docs/en/start/sms/start.md | 2 + docs/template/api_ref_html.tmpl | 21 -- docs/template/quickstart.tmpl | 2 + docs/template/quickstart_zh.tmpl | 2 + docs/zh/start/cryption/start.md | 2 + docs/zh/start/delay_queue/start.md | 3 + docs/zh/start/email/start.md | 2 + docs/zh/start/phone/start.md | 4 +- docs/zh/start/sms/start.md | 2 + .../v1/delay_queue/delay_queue.proto | 2 +- spec/proto/extension/v1/phone/phone.proto | 2 +- 26 files changed, 126 insertions(+), 1355 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/good-first-issue-go-demo.md create mode 100644 .github/ISSUE_TEMPLATE/good-first-issue-java-demo.md diff --git a/.github/ISSUE_TEMPLATE/good-first-issue-component.md b/.github/ISSUE_TEMPLATE/good-first-issue-component.md index 8ca5f2e9af..752ed7512a 100644 --- a/.github/ISSUE_TEMPLATE/good-first-issue-component.md +++ b/.github/ISSUE_TEMPLATE/good-first-issue-component.md @@ -22,8 +22,16 @@ For example, you can choose any one in the list below: - [ ] Mongo - [ ] Mysql - [ ] Postgresql -- [ ] MinIO - [ ] Cassandra +- [ ] MinIO +- [ ] Ceph +- [ ] Alibaba Cloud OSS +- [ ] AWS S3 +- [ ] Kafka +- [ ] RabbitMQ +- [ ] RocketMQ +- [ ] ActiveMQ +- [ ] RabbitMQ - [ ] Cloud service provided by Alibaba cloud - [ ] Cloud service provided by AWS - [ ] Cloud service provided by Azure @@ -34,16 +42,22 @@ For example, you can choose any one in the list below: **Reference(FIXME)**: -An example pull request : +Here are some resources to help you work on this issue. API quickstart doc: -API reference: +API definition(the `.proto` file): + +Component development guide: https://mosn.io/layotto/#/en/development/developing-component + +Component development guide(in chinese): https://mosn.io/layotto/#/zh/development/developing-component + +An example pull request to develop a new component: API design doc/discussion: chinese: -选择一个你喜欢的开源组件或云服务实现**XXX API(FIXME)**, +选择一个你喜欢的开源组件或云服务实现 **(FIXME) XXX** API, 参考资料见上。 diff --git a/.github/ISSUE_TEMPLATE/good-first-issue-go-demo.md b/.github/ISSUE_TEMPLATE/good-first-issue-go-demo.md new file mode 100644 index 0000000000..0026be86a9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/good-first-issue-go-demo.md @@ -0,0 +1,36 @@ +--- +name: "Good first issue (develop a golang demo)" +about: Submit a good first issue +labels: ["kind/demo", "help wanted","good first issue","easy" ] +title: "Develop a golang demo for XXX API; 为 XXX API 开发一个 golang demo" + +--- + + +**What would you like to be added**: + +Develop a golang demo for **(FIXME) XXX** API. + +Now we already have quickstart docs for this API, and we need a demo to show users how to invoke this API. + +You can take the [lock api quickstart](https://mosn.io/layotto/#/en/start/lock/start) as an example: + +![image](https://user-images.githubusercontent.com/26001097/199906600-d4c92b5e-7b93-4e61-96ca-91c9d96edc04.png) + +The golang demo of lock api is [here](https://github.com/mosn/layotto/blob/main/demo/lock/common/client.go). + +**Reference**: + +Here are some resources to help you work on this issue. + +Quickstart doc for this API: + +API definition (the .proto file): + +golang sdk: https://github.com/mosn/layotto/tree/main/sdk/go-sdk + +API design doc/discussion: + +**Why is this needed**: + +Golang users need it \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/good-first-issue-java-demo.md b/.github/ISSUE_TEMPLATE/good-first-issue-java-demo.md new file mode 100644 index 0000000000..b06989cdac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/good-first-issue-java-demo.md @@ -0,0 +1,36 @@ +--- +name: "Good first issue (develop a java demo)" +about: Submit a good first issue +labels: ["kind/demo", "help wanted","good first issue","easy" ] +title: "Develop a java demo for XXX API; 为 XXX API 开发一个 java demo" + +--- + + +**What would you like to be added**: + +Develop a java demo for **(FIXME) XXX** API. + +Now we already have quickstart docs for this API, and we need a demo to show users how to invoke this API. + +You can take the [lock api quickstart](https://mosn.io/layotto/#/en/start/lock/start) as an example: + +![image](https://user-images.githubusercontent.com/26001097/199906799-ac30da05-c983-408b-b0e9-2fd712ec492f.png) + +The java demo of lock api is [here](https://github.com/layotto/java-sdk/tree/main/examples-lock). + +**Reference**: + +Here are some resources to help you work on this issue. + +Quickstart doc for this API: + +API definition (the .proto file): + +java sdk: https://github.com/layotto/java-sdk + +API design doc/discussion: + +**Why is this needed**: + +Java users need it. \ No newline at end of file diff --git a/docs/api/v1/cryption.html b/docs/api/v1/cryption.html index 45af48805b..9f9cd4c487 100644 --- a/docs/api/v1/cryption.html +++ b/docs/api/v1/cryption.html @@ -398,194 +398,5 @@

EncryptResponse

-

Scalar Value Types

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)
diff --git a/docs/api/v1/delay_queue.html b/docs/api/v1/delay_queue.html index 54b3debfc8..21f6f00415 100644 --- a/docs/api/v1/delay_queue.html +++ b/docs/api/v1/delay_queue.html @@ -215,7 +215,7 @@

delay_queue.proto

Top

[gRPC Service] DelayQueue

-

DelayQueue is a special kind of message queue, which lets you postpone the delivery of new messages to consumers.

+

DelayQueue is a special kind of message queue, which lets you postpone the delivery of new messages to consumers.

For example, you can invoke this API and tell the message queue "please send this message to the consumers after 5 minutes".

@@ -360,194 +360,5 @@

DelayMessageRe -

Scalar Value Types

-
Method NameRequest TypeResponse TypeDescription
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)
diff --git a/docs/api/v1/email.html b/docs/api/v1/email.html index 15a47be189..3559d9bfed 100644 --- a/docs/api/v1/email.html +++ b/docs/api/v1/email.html @@ -542,194 +542,5 @@

SendEmailWi -

Scalar Value Types

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)
diff --git a/docs/api/v1/phone.html b/docs/api/v1/phone.html index 60d0ae05d4..38631404f0 100644 --- a/docs/api/v1/phone.html +++ b/docs/api/v1/phone.html @@ -219,7 +219,7 @@

phone.proto

Top

[gRPC Service] PhoneCallService

-

PhoneCallService is one of Notify APIs. It's used to send voice messages

+

PhoneCallService API is used to send voice messages.

@@ -378,194 +378,5 @@

VoiceTe -

Scalar Value Types

-
Method NameRequest TypeResponse TypeDescription
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)
diff --git a/docs/api/v1/runtime.html b/docs/api/v1/runtime.html index b7ac890a07..4fef572478 100644 --- a/docs/api/v1/runtime.html +++ b/docs/api/v1/runtime.html @@ -4264,194 +4264,5 @@

UnlockResponse.Status

-

Scalar Value Types

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)
diff --git a/docs/api/v1/s3.html b/docs/api/v1/s3.html index 7e7cdcfe0d..51e6e247ec 100644 --- a/docs/api/v1/s3.html +++ b/docs/api/v1/s3.html @@ -5787,194 +5787,5 @@

UploadPartOutput

-

Scalar Value Types

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)
diff --git a/docs/api/v1/sms.html b/docs/api/v1/sms.html index d08869005d..005141c587 100644 --- a/docs/api/v1/sms.html +++ b/docs/api/v1/sms.html @@ -484,194 +484,5 @@

Template.Templ -

Scalar Value Types

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)
diff --git a/docs/en/start/cryption/start.md b/docs/en/start/cryption/start.md index 801d9be9cf..dc1b0fda9b 100644 --- a/docs/en/start/cryption/start.md +++ b/docs/en/start/cryption/start.md @@ -3,6 +3,8 @@ This example shows how to invoke Layotto CryptionService API. +## What is CryptionService API used for? + CryptionService is used to encrypt or decrypt data. ## step 1. Deploy Layotto diff --git a/docs/en/start/delay_queue/start.md b/docs/en/start/delay_queue/start.md index a69580dfd1..afef77798d 100644 --- a/docs/en/start/delay_queue/start.md +++ b/docs/en/start/delay_queue/start.md @@ -3,7 +3,10 @@ This example shows how to invoke Layotto DelayQueue API. +## What is DelayQueue API used for? + DelayQueue is a special kind of message queue, which lets you postpone the delivery of new messages to consumers. +For example, you can invoke this API and tell the message queue "please send this message to the consumers after 5 minutes". ## step 1. Deploy Layotto diff --git a/docs/en/start/email/start.md b/docs/en/start/email/start.md index 496354c810..e3f063623e 100644 --- a/docs/en/start/email/start.md +++ b/docs/en/start/email/start.md @@ -3,6 +3,8 @@ This example shows how to invoke Layotto EmailService API. +## What is EmailService API used for? + EmailService is used to send emails. ## step 1. Deploy Layotto diff --git a/docs/en/start/lock/start.md b/docs/en/start/lock/start.md index 3658ca57b9..f0de2c3e7c 100644 --- a/docs/en/start/lock/start.md +++ b/docs/en/start/lock/start.md @@ -75,7 +75,10 @@ The layotto file will be generated in the directory, run it: -## step 2. Run the client program, call Layotto to add, delete, modify and query +## step 2. Run the client demo + +The client demo invokes Layotto API to lock and unlock the resource. + ### **Go** diff --git a/docs/en/start/phone/start.md b/docs/en/start/phone/start.md index 9bf0967280..b22f4bcc1c 100644 --- a/docs/en/start/phone/start.md +++ b/docs/en/start/phone/start.md @@ -3,7 +3,9 @@ This example shows how to invoke Layotto PhoneCallService API. -PhoneCallService is one of Notify APIs. It's used to send voice messages +## What is PhoneCallService API used for? + +PhoneCallService API is used to send voice messages. ## step 1. Deploy Layotto diff --git a/docs/en/start/sms/start.md b/docs/en/start/sms/start.md index 2145f4440a..008c62a181 100644 --- a/docs/en/start/sms/start.md +++ b/docs/en/start/sms/start.md @@ -3,6 +3,8 @@ This example shows how to invoke Layotto SmsService API. +## What is SmsService API used for? + SmsService is used to send SMS messages. ## step 1. Deploy Layotto diff --git a/docs/template/api_ref_html.tmpl b/docs/template/api_ref_html.tmpl index 3b8d1d4b7f..8705bb8261 100644 --- a/docs/template/api_ref_html.tmpl +++ b/docs/template/api_ref_html.tmpl @@ -414,26 +414,5 @@ {{end}} -

Scalar Value Types

- - - - - - {{range .Scalars}} - - - - - - - - - - - - {{end}} - -
.proto TypeNotesC++JavaPythonGoC#PHPRuby
{{.ProtoType}}{{.Notes}}{{.CppType}}{{.JavaType}}{{.PythonType}}{{.GoType}}{{.CSharp}}{{.PhpType}}{{.RubyType}}
diff --git a/docs/template/quickstart.tmpl b/docs/template/quickstart.tmpl index 8ccb7c009b..3f05417993 100644 --- a/docs/template/quickstart.tmpl +++ b/docs/template/quickstart.tmpl @@ -3,6 +3,8 @@ This example shows how to invoke Layotto {{.Name}} API. +## What is {{.Name}} API used for? + {{.Description}} ## step 1. Deploy Layotto diff --git a/docs/template/quickstart_zh.tmpl b/docs/template/quickstart_zh.tmpl index 0aa527850f..c98b064bf7 100644 --- a/docs/template/quickstart_zh.tmpl +++ b/docs/template/quickstart_zh.tmpl @@ -3,6 +3,8 @@ 本示例演示如何调用 Layotto {{.Name}} API. +## 什么是 {{.Name}} API ? + {{.Description}} ## step 1. 运行 Layotto diff --git a/docs/zh/start/cryption/start.md b/docs/zh/start/cryption/start.md index 7ad455b0a9..5edb3ab49b 100644 --- a/docs/zh/start/cryption/start.md +++ b/docs/zh/start/cryption/start.md @@ -3,6 +3,8 @@ 本示例演示如何调用 Layotto CryptionService API. +## 什么是 CryptionService API ? + CryptionService is used to encrypt or decrypt data. ## step 1. 运行 Layotto diff --git a/docs/zh/start/delay_queue/start.md b/docs/zh/start/delay_queue/start.md index 15c59d9bf6..5aa6674f96 100644 --- a/docs/zh/start/delay_queue/start.md +++ b/docs/zh/start/delay_queue/start.md @@ -3,7 +3,10 @@ 本示例演示如何调用 Layotto DelayQueue API. +## 什么是 DelayQueue API ? + DelayQueue is a special kind of message queue, which lets you postpone the delivery of new messages to consumers. +For example, you can invoke this API and tell the message queue "please send this message to the consumers after 5 minutes". ## step 1. 运行 Layotto diff --git a/docs/zh/start/email/start.md b/docs/zh/start/email/start.md index 2716924aad..fca423eef2 100644 --- a/docs/zh/start/email/start.md +++ b/docs/zh/start/email/start.md @@ -3,6 +3,8 @@ 本示例演示如何调用 Layotto EmailService API. +## 什么是 EmailService API ? + EmailService is used to send emails. ## step 1. 运行 Layotto diff --git a/docs/zh/start/phone/start.md b/docs/zh/start/phone/start.md index d73b03c8e5..ec75ac2487 100644 --- a/docs/zh/start/phone/start.md +++ b/docs/zh/start/phone/start.md @@ -3,7 +3,9 @@ 本示例演示如何调用 Layotto PhoneCallService API. -PhoneCallService is one of Notify APIs. It's used to send voice messages +## 什么是 PhoneCallService API ? + +PhoneCallService API is used to send voice messages. ## step 1. 运行 Layotto diff --git a/docs/zh/start/sms/start.md b/docs/zh/start/sms/start.md index b1ec5a8281..1a145566cd 100644 --- a/docs/zh/start/sms/start.md +++ b/docs/zh/start/sms/start.md @@ -3,6 +3,8 @@ 本示例演示如何调用 Layotto SmsService API. +## 什么是 SmsService API ? + SmsService is used to send SMS messages. ## step 1. 运行 Layotto diff --git a/spec/proto/extension/v1/delay_queue/delay_queue.proto b/spec/proto/extension/v1/delay_queue/delay_queue.proto index 0189e154e0..4a9b148305 100644 --- a/spec/proto/extension/v1/delay_queue/delay_queue.proto +++ b/spec/proto/extension/v1/delay_queue/delay_queue.proto @@ -7,6 +7,7 @@ option go_package = "mosn.io/layotto/spec/proto/extension/v1/delay_queue;delay_q /* @exclude skip ci_generator */ /* @exclude extends pub_subs */ // DelayQueue is a special kind of message queue, which lets you postpone the delivery of new messages to consumers. +// For example, you can invoke this API and tell the message queue "please send this message to the consumers after 5 minutes". service DelayQueue { // Publish a delay message @@ -29,7 +30,6 @@ message DelayMessageRequest { // The content type for the data (optional). string data_content_type = 4; - // The length of time, in seconds, for which the delivery // of this messages is delayed. Default: 0. int32 delay_in_seconds = 5; diff --git a/spec/proto/extension/v1/phone/phone.proto b/spec/proto/extension/v1/phone/phone.proto index 98339f898c..ce8b3fb97f 100644 --- a/spec/proto/extension/v1/phone/phone.proto +++ b/spec/proto/extension/v1/phone/phone.proto @@ -5,7 +5,7 @@ package spec.proto.extension.v1.phone; option go_package = "mosn.io/layotto/spec/proto/extension/v1/phone;phone"; /* @exclude skip ci_generator */ -// PhoneCallService is one of Notify APIs. It's used to send voice messages +// PhoneCallService API is used to send voice messages. service PhoneCallService { // Send voice using the specific template