Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Request Bodies in API Documentation #4066

Merged
Merged
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
530b93f
Fix API docs for request body of addresses
kennyadsl May 14, 2021
e6e4ab8
Fix API docs for request body of payments
kennyadsl May 14, 2021
ff1cfe5
Fix API docs for request body of products
kennyadsl May 14, 2021
718a510
Fix API docs for request body of variants
kennyadsl May 17, 2021
defc7d8
Fix API docs for request body of line items
kennyadsl May 20, 2021
49701a5
Fix API docs for request body of orders
kennyadsl May 20, 2021
9082e28
Remove deprecated coupon code property from order's input
kennyadsl May 20, 2021
c955115
Fix API docs for request body of coupon codes
kennyadsl May 21, 2021
b0d9752
Fix API docs for request body of shipments
kennyadsl May 21, 2021
16bea19
Fix API docs for request body of zones
kennyadsl May 21, 2021
76ba37a
Fix API docs for request body of product properties
kennyadsl May 21, 2021
da32fea
Fix API docs for request body of stock locations
kennyadsl May 21, 2021
fe32401
Fix API docs for request body of taxons
kennyadsl May 21, 2021
a11c626
Fix API docs for request body of taxonomies
kennyadsl May 21, 2021
f27cf6c
Fix API docs for request body of properties
kennyadsl May 27, 2021
a41e5c9
Fix API docs for request body of images
kennyadsl May 27, 2021
bf26b5f
Fix API docs for request body of users
kennyadsl May 27, 2021
413b360
Fix API docs for request body of return authorizations
kennyadsl May 27, 2021
43f60ef
Fix API docs for request body of customer returns
kennyadsl May 27, 2021
58898c5
Fix API docs for request body of option values
kennyadsl May 27, 2021
046d3af
Fix API docs for request body of stock items
kennyadsl May 27, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix API docs for request body of stock locations
  • Loading branch information
kennyadsl committed May 21, 2021
commit da32fea044bf9968f98f718a895781eba960c646
43 changes: 34 additions & 9 deletions api/openapi/solidus-api.oas.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3010,14 +3010,29 @@ paths:
'422':
$ref: '#/components/responses/unprocessable-entity'
summary: Create stock location
description: Creates a stock location.
description: |-
Creates a stock location.

Only users with the `create` permission on `Spree::StockLocation` can perform this action.
operationId: create-stock-location
tags:
- Stock locations
security:
- api-key: []
requestBody:
$ref: '#/components/requestBodies/stock-location-input'
content:
application/json:
schema:
type: object
properties:
stock_location:
$ref: '#/components/schemas/stock-location-input'
examples:
Example:
value:
stock_location:
name: North Pole
active: true
'/stock_locations/{id}':
get:
responses:
Expand All @@ -3043,6 +3058,7 @@ paths:
required: true
schema:
type: string
description: The id of the stock location
delete:
responses:
'204':
Expand Down Expand Up @@ -3079,14 +3095,28 @@ paths:
'422':
$ref: '#/components/responses/unprocessable-entity'
summary: Update stock location
description: Updates a stock location.
description: |-
Updates a stock location.

Only users with the `update` permission on the stock location can perform this action.
operationId: update-stock-location
tags:
- Stock locations
security:
- api-key: []
requestBody:
$ref: '#/components/requestBodies/stock-location-input'
content:
application/json:
schema:
type: object
properties:
stock_location:
$ref: '#/components/schemas/stock-location-input'
examples:
Example:
value:
stock_location:
active: false
'/stock_locations/{stock_location_id}/stock_items':
get:
responses:
Expand Down Expand Up @@ -5538,11 +5568,6 @@ components:
application/json:
schema:
$ref: '#/components/schemas/taxon-input'
stock-location-input:
content:
application/json:
schema:
$ref: '#/components/schemas/stock-location-input'
property-input:
content:
application/json:
Expand Down