chore(docs): Generated API Reference (#3211)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
co-authored by
olivermrbl
parent
9997485c55
commit
14b2de94e2
@@ -1,3 +1,50 @@
|
||||
delete:
|
||||
operationId: DeleteStockLocationsStockLocation
|
||||
summary: Delete a Stock Location
|
||||
description: Delete a Stock Location
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Stock Location to delete.
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/stock-locations_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/stock-locations_{id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- StockLocation
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The ID of the deleted Stock Location.
|
||||
object:
|
||||
type: string
|
||||
description: The type of the object that was deleted.
|
||||
format: stock_location
|
||||
deleted:
|
||||
type: boolean
|
||||
description: Whether or not the Stock Location was deleted.
|
||||
default: true
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
get:
|
||||
operationId: GetStockLocationsStockLocation
|
||||
summary: Get a Stock Location
|
||||
@@ -20,15 +67,18 @@ get:
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
queryParams: AdminGetStockLocationsLocationParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/stock-locations_{id}/getundefined
|
||||
$ref: ../code_samples/JavaScript/stock-locations_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/stock-locations_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/stock-locations_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -68,15 +118,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostStockLocationsLocationReq.yaml
|
||||
x-codegen:
|
||||
method: update
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/stock-locations_{id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/stock-locations_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/stock-locations_{id}/postundefined
|
||||
$ref: ../code_samples/Shell/stock-locations_{id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
Reference in New Issue
Block a user