Skip to content

Commit 65c6b0b

Browse files
committed
Add annotations to action components for improved metadata
- Added 'annotations' property to multiple action components including find-customers, find-invoice, find-order, find-product, find-shipment, get-order, get-order-products, get-product, and get-shipment. - Each annotation includes 'destructiveHint', 'openWorldHint', and 'readOnlyHint' for better clarity on action behavior.
1 parent c06a591 commit 65c6b0b

File tree

9 files changed

+45
-0
lines changed

9 files changed

+45
-0
lines changed

components/lightspeed_ecom_c_series/actions/find-customers/find-customers.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ export default {
66
description: "Find a customer by ID. [See the documentation](https://developers.lightspeedhq.com/ecom/endpoints/customer/#get-all-customers)",
77
version: "0.0.1",
88
type: "action",
9+
annotations: {
10+
destructiveHint: false,
11+
openWorldHint: true,
12+
readOnlyHint: false,
13+
},
914
props: {
1015
app,
1116
customerEmail: {

components/lightspeed_ecom_c_series/actions/find-invoice/find-invoice.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ export default {
66
description: "Find an invoice by ID. [See the documentation](https://developers.lightspeedhq.com/ecom/endpoints/invoice/#get-all-invoices)",
77
version: "0.0.1",
88
type: "action",
9+
annotations: {
10+
destructiveHint: false,
11+
openWorldHint: true,
12+
readOnlyHint: false,
13+
},
914
props: {
1015
app,
1116
customerId: {

components/lightspeed_ecom_c_series/actions/find-order/find-order.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ export default {
66
description: "Find an order by ID. [See the documentation](https://developers.lightspeedhq.com/ecom/endpoints/order/#get-all-orders)",
77
version: "0.0.1",
88
type: "action",
9+
annotations: {
10+
destructiveHint: false,
11+
openWorldHint: true,
12+
readOnlyHint: false,
13+
},
914
props: {
1015
app,
1116
customerId: {

components/lightspeed_ecom_c_series/actions/find-product/find-product.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ export default {
66
description: "Find an product by ID. [See the documentation](https://developers.lightspeedhq.com/ecom/endpoints/product/#get-all-products)",
77
version: "0.0.1",
88
type: "action",
9+
annotations: {
10+
destructiveHint: false,
11+
openWorldHint: true,
12+
readOnlyHint: false,
13+
},
914
props: {
1015
app,
1116
brandId: {

components/lightspeed_ecom_c_series/actions/find-shipment/find-shipment.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ export default {
66
description: "Find a shipment by ID. [See the documentation](https://developers.lightspeedhq.com/ecom/endpoints/shipment/#get-all-shipments)",
77
version: "0.0.1",
88
type: "action",
9+
annotations: {
10+
destructiveHint: false,
11+
openWorldHint: true,
12+
readOnlyHint: false,
13+
},
914
props: {
1015
app,
1116
customerId: {

components/lightspeed_ecom_c_series/actions/get-order-products/get-order-products.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ export default {
66
description: "Get an order products by ID. [See the documentation](https://developers.lightspeedhq.com/ecom/endpoints/orderproduct/#get-all-order-products)",
77
version: "0.0.1",
88
type: "action",
9+
annotations: {
10+
destructiveHint: false,
11+
openWorldHint: true,
12+
readOnlyHint: false,
13+
},
914
props: {
1015
app,
1116
orderId: {

components/lightspeed_ecom_c_series/actions/get-order/get-order.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ export default {
66
description: "Get an order by ID. [See the documentation](https://developers.lightspeedhq.com/ecom/endpoints/order/#get-retrieve-an-order)",
77
version: "0.0.1",
88
type: "action",
9+
annotations: {
10+
destructiveHint: false,
11+
openWorldHint: true,
12+
readOnlyHint: false,
13+
},
914
props: {
1015
app,
1116
orderId: {

components/lightspeed_ecom_c_series/actions/get-product/get-product.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ export default {
66
description: "Get a product by ID. [See the documentation](https://developers.lightspeedhq.com/ecom/endpoints/product/#get-retrieve-a-product)",
77
version: "0.0.1",
88
type: "action",
9+
annotations: {
10+
destructiveHint: false,
11+
openWorldHint: true,
12+
readOnlyHint: false,
13+
},
914
props: {
1015
app,
1116
productId: {

components/lightspeed_ecom_c_series/actions/get-shipment/get-shipment.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ export default {
66
description: "Get a shipment by ID. [See the documentation](https://developers.lightspeedhq.com/ecom/endpoints/shipment/#get-retrieve-a-shipment)",
77
version: "0.0.1",
88
type: "action",
9+
annotations: {
10+
destructiveHint: false,
11+
openWorldHint: true,
12+
readOnlyHint: false,
13+
},
914
props: {
1015
app,
1116
shipmentId: {

0 commit comments

Comments
 (0)