Skip to content

Api rework #1461

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.

Sign up for GitHub

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
christianlupus merged 5 commits into from
Mar 17, 2023
Merged

Api rework #1461

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6242bfd
Create named objects instead of usage of anonymous objects in the spec
Jan 23, 2023
c30cfc0
document size query parameter on /api/v1/recipes/{id}/image
Jan 24, 2023
8e1b919
Clean up some metadata of some endpoints like default value and requi…
Jan 23, 2023
66b2319
add changelog
Jan 24, 2023
07954bf
Removed obsolete parameters from OpenAPI specs
Jan 24, 2023
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
document size query parameter on /api/v1/recipes/{id}/image 
Signed-off-by: Nikolas Rimikis <[email protected]>
  • Loading branch information
Nikolas Rimikis authored and Christian Wolf committed Mar 17, 2023
commit c30cfc0945105d75def3ed571850e89520cd6350
14 changes: 14 additions & 0 deletions docs/dev/api/0.1.1/openapi-cookbook.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,20 @@ paths:
required: true
schema:
type: integer
- in: query
name: size
description: >
The size of the requested image

* `full` - Full resolution image (size full res)
* `thumb` - thumbnail of the image (size 250px)
* `thumb16` - icon of the image (size 16px)

by default the full size image will be returned
required: false
schema:
type: string
enum: [full, thumb, thumb16]
responses:
200:
description: Image was obtained and will be in response either as image/jpeg or image/svg+xml
Expand Down