Skip to content

feat: swagger spec created for get bid/id #12

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

Merged
Merged
Changes from all commits
Commits
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
45 changes: 45 additions & 0 deletions static/swag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/bids/{bid_id}:
# --------------------------------------------
get:
tags:
- bids
summary: Returns a single bid
description: Returns a single bid
operationId: get_bid
parameters:
- name: bid_id
in: path
description: ID of bid to return
required: true
schema:
type: string
format: uuid
responses:
'200':
description: A single bid
content:
application/json:
schema:
$ref: '#/components/schemas/Bid'
'404':
description: Bid not found
content:
application/json:
schema:
type: object
example: {
"Error": "Bid not found"
}
'500':
$ref: '#/components/responses/InternalServerError'
# --------------------------------------------




# --------------------------------------------
# Schemas
_id:
type: string
format: uuid
example: "9af94206-adff-476c-b2f9-ed7be3468944"