docs: adjust summary length of endpoints (#2188)
* change titles for admin apis * adjusted titles for storefront apis * added a note about length in contribution guidelines * adjusted title for get customer endpoint
This commit is contained in:
@@ -24,7 +24,7 @@ import { validator } from "../../../../utils/validator"
|
||||
/**
|
||||
* @oas [post] /draft-orders/{id}/line-items
|
||||
* operationId: "PostDraftOrdersDraftOrderLineItems"
|
||||
* summary: "Create a Line Item for Draft Order"
|
||||
* summary: "Create a Line Item"
|
||||
* description: "Creates a Line Item for the Draft Order"
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
|
||||
@@ -11,7 +11,7 @@ import { DraftOrder } from "../../../.."
|
||||
/**
|
||||
* @oas [get] /draft-orders/{id}
|
||||
* operationId: "GetDraftOrdersDraftOrder"
|
||||
* summary: "Retrieve a Draft Order"
|
||||
* summary: "Get a Draft Order"
|
||||
* description: "Retrieves a Draft Order."
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
|
||||
@@ -13,7 +13,7 @@ import { EntityManager } from "typeorm"
|
||||
|
||||
/**
|
||||
* @oas [post] /draft-orders/{id}/pay
|
||||
* summary: "Registers a payment for a Draft Order"
|
||||
* summary: "Registers a Payment"
|
||||
* operationId: "PostDraftOrdersDraftOrderRegisterPayment"
|
||||
* description: "Registers a payment for a Draft Order."
|
||||
* x-authenticated: true
|
||||
|
||||
@@ -22,7 +22,7 @@ import { validator } from "../../../../utils/validator"
|
||||
/**
|
||||
* @oas [post] /admin/draft-orders/{id}
|
||||
* operationId: PostDraftOrdersDraftOrder
|
||||
* summary: Update a Draft Order"
|
||||
* summary: Update a Draft Order
|
||||
* description: "Updates a Draft Order."
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
|
||||
@@ -15,7 +15,7 @@ import { validator } from "../../../../utils/validator"
|
||||
/**
|
||||
* @oas [post] /draft-orders/{id}/line-items/{line_id}
|
||||
* operationId: "PostDraftOrdersDraftOrderLineItemsItem"
|
||||
* summary: "Update a Line Item for a Draft Order"
|
||||
* summary: "Update a Line Item"
|
||||
* description: "Updates a Line Item for a Draft Order"
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
|
||||
Reference in New Issue
Block a user