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:
@@ -10,7 +10,7 @@ import { FlagRouter } from "../../../../utils/flag-router"
|
||||
/**
|
||||
* @oas [get] /store
|
||||
* operationId: "GetStore"
|
||||
* summary: "Retrieve Store details."
|
||||
* summary: "Get Store details"
|
||||
* description: "Retrieves the Store details"
|
||||
* x-authenticated: true
|
||||
* x-codeSamples:
|
||||
|
||||
@@ -2,7 +2,7 @@ import { PaymentProviderService } from "../../../../services"
|
||||
/**
|
||||
* @oas [get] /store/payment-providers
|
||||
* operationId: "GetStorePaymentProviders"
|
||||
* summary: "Retrieve configured Payment Providers"
|
||||
* summary: "List Payment Providers"
|
||||
* description: "Retrieves the configured Payment Providers"
|
||||
* x-authenticated: true
|
||||
* x-codeSamples:
|
||||
|
||||
@@ -3,7 +3,7 @@ import { TaxProviderService } from "../../../../services"
|
||||
/**
|
||||
* @oas [get] /store/tax-providers
|
||||
* operationId: "GetStoreTaxProviders"
|
||||
* summary: "Retrieve configured Tax Providers"
|
||||
* summary: "List Tax Providers"
|
||||
* description: "Retrieves the configured Tax Providers"
|
||||
* x-authenticated: true
|
||||
* x-codeSamples:
|
||||
|
||||
@@ -4,7 +4,7 @@ import { EntityManager } from "typeorm"
|
||||
/**
|
||||
* @oas [delete] /store/currencies/{code}
|
||||
* operationId: "DeleteStoreCurrenciesCode"
|
||||
* summary: "Remove a Currency Code"
|
||||
* summary: "Delete a Currency Code"
|
||||
* description: "Removes a Currency Code from the available currencies."
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
|
||||
@@ -7,7 +7,7 @@ import { EntityManager } from "typeorm"
|
||||
/**
|
||||
* @oas [post] /store
|
||||
* operationId: "PostStore"
|
||||
* summary: "Update Store details."
|
||||
* summary: "Update Store Details"
|
||||
* description: "Updates the Store details"
|
||||
* x-authenticated: true
|
||||
* requestBody:
|
||||
|
||||
Reference in New Issue
Block a user