Add operation IDs
This commit is contained in:
parent
6f32fc1071
commit
390f81061c
1 changed files with 13 additions and 0 deletions
13
openapi.yaml
13
openapi.yaml
|
@ -57,6 +57,7 @@ x-tagGroups:
|
||||||
paths:
|
paths:
|
||||||
/auth/session/:
|
/auth/session/:
|
||||||
post:
|
post:
|
||||||
|
operationId: getSessionInfo
|
||||||
tags: ["auth"]
|
tags: ["auth"]
|
||||||
summary: Get session information
|
summary: Get session information
|
||||||
description: >
|
description: >
|
||||||
|
@ -75,6 +76,7 @@ paths:
|
||||||
$ref: "#/components/schemas/Session"
|
$ref: "#/components/schemas/Session"
|
||||||
/auth/signup/:
|
/auth/signup/:
|
||||||
post:
|
post:
|
||||||
|
operationId: signup
|
||||||
tags: ["auth"]
|
tags: ["auth"]
|
||||||
summary: Sign up
|
summary: Sign up
|
||||||
requestBody:
|
requestBody:
|
||||||
|
@ -94,6 +96,7 @@ paths:
|
||||||
description: Email is taken
|
description: Email is taken
|
||||||
/auth/login/:
|
/auth/login/:
|
||||||
post:
|
post:
|
||||||
|
operationId: login
|
||||||
tags: ["auth"]
|
tags: ["auth"]
|
||||||
summary: Log in
|
summary: Log in
|
||||||
requestBody:
|
requestBody:
|
||||||
|
@ -113,6 +116,7 @@ paths:
|
||||||
description: Wrong credentials
|
description: Wrong credentials
|
||||||
/auth/logout/:
|
/auth/logout/:
|
||||||
post:
|
post:
|
||||||
|
operationId: logout
|
||||||
tags: ["auth"]
|
tags: ["auth"]
|
||||||
summary: Log out
|
summary: Log out
|
||||||
responses:
|
responses:
|
||||||
|
@ -120,6 +124,7 @@ paths:
|
||||||
description: Successfully logged out.
|
description: Successfully logged out.
|
||||||
/auth/profile/:
|
/auth/profile/:
|
||||||
get:
|
get:
|
||||||
|
operationId: getProfileInfo
|
||||||
tags: ["auth"]
|
tags: ["auth"]
|
||||||
summary: Get profile information
|
summary: Get profile information
|
||||||
responses:
|
responses:
|
||||||
|
@ -133,6 +138,7 @@ paths:
|
||||||
description: Unauthorized
|
description: Unauthorized
|
||||||
/products/:
|
/products/:
|
||||||
get:
|
get:
|
||||||
|
operationId: getProducts
|
||||||
tags: ["products"]
|
tags: ["products"]
|
||||||
summary: Get a list of all products
|
summary: Get a list of all products
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -159,6 +165,7 @@ paths:
|
||||||
$ref: "#/components/schemas/ProductList"
|
$ref: "#/components/schemas/ProductList"
|
||||||
/products/{productId}/:
|
/products/{productId}/:
|
||||||
get:
|
get:
|
||||||
|
operationId: getProduct
|
||||||
tags: ["products"]
|
tags: ["products"]
|
||||||
summary: Get product information
|
summary: Get product information
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -180,6 +187,7 @@ paths:
|
||||||
description: Product not found
|
description: Product not found
|
||||||
/properties/:
|
/properties/:
|
||||||
get:
|
get:
|
||||||
|
operationId: getProperties
|
||||||
tags: ["products"]
|
tags: ["products"]
|
||||||
summary: Get descriptions of all properties.
|
summary: Get descriptions of all properties.
|
||||||
description: >
|
description: >
|
||||||
|
@ -193,6 +201,7 @@ paths:
|
||||||
$ref: "#/components/schemas/ProductPropertySchemaList"
|
$ref: "#/components/schemas/ProductPropertySchemaList"
|
||||||
/cart/:
|
/cart/:
|
||||||
get:
|
get:
|
||||||
|
operationId: getCartInfo
|
||||||
tags: ["cart"]
|
tags: ["cart"]
|
||||||
summary: Get items from cart
|
summary: Get items from cart
|
||||||
responses:
|
responses:
|
||||||
|
@ -203,6 +212,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/Cart"
|
$ref: "#/components/schemas/Cart"
|
||||||
post:
|
post:
|
||||||
|
operationId: updateCartItem
|
||||||
tags: ["cart"]
|
tags: ["cart"]
|
||||||
summary: Change quantity of items in cart
|
summary: Change quantity of items in cart
|
||||||
requestBody:
|
requestBody:
|
||||||
|
@ -240,6 +250,7 @@ paths:
|
||||||
example: 1
|
example: 1
|
||||||
/cart/product/{productId}/:
|
/cart/product/{productId}/:
|
||||||
get:
|
get:
|
||||||
|
operationId: getProductQuantityInCart
|
||||||
tags: ["cart"]
|
tags: ["cart"]
|
||||||
summary: Get the quantity of product in the cart
|
summary: Get the quantity of product in the cart
|
||||||
description: >
|
description: >
|
||||||
|
@ -269,6 +280,7 @@ paths:
|
||||||
format: int64
|
format: int64
|
||||||
/cart/cost/:
|
/cart/cost/:
|
||||||
get:
|
get:
|
||||||
|
operationId: getTotalCartCost
|
||||||
tags: ["cart"]
|
tags: ["cart"]
|
||||||
summary: Get the cost of the items in the cart.
|
summary: Get the cost of the items in the cart.
|
||||||
responses:
|
responses:
|
||||||
|
@ -283,6 +295,7 @@ paths:
|
||||||
$ref: "#/components/schemas/Price"
|
$ref: "#/components/schemas/Price"
|
||||||
/cart/checkout/:
|
/cart/checkout/:
|
||||||
post:
|
post:
|
||||||
|
operationId: checkout
|
||||||
tags: ["cart"]
|
tags: ["cart"]
|
||||||
summary: Checkout
|
summary: Checkout
|
||||||
description: Places an order with all current items in the cart.
|
description: Places an order with all current items in the cart.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue