Skip to content

Commit 7d0dbab

Browse files
karlomikuskarlomikus
committed
Update spec
1 parent 4c7bb99 commit 7d0dbab

File tree

1 file changed

+149
-20
lines changed

1 file changed

+149
-20
lines changed

‎docs/openapi-generated.yaml‎

Lines changed: 149 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -948,6 +948,69 @@ paths:
948948
properties:
949949
data: { $ref: '#/components/schemas/APIError' }
950950
type: object
951+
'/bars/{id}/sync-datapack':
952+
post:
953+
tags:
954+
- Bars
955+
summary: 'Sync recipes'
956+
description: 'Triggers synchronization of recipes from the default datapack. Matches data by name, does not overwrite your existing recipes or ingredients.'
957+
operationId: syncBarDatapack
958+
parameters:
959+
-
960+
name: id
961+
in: path
962+
description: 'Database id of a resource'
963+
required: true
964+
schema:
965+
type: integer
966+
responses:
967+
'204':
968+
description: 'Successful response'
969+
'403':
970+
description: 'You are not authorized for this action.'
971+
headers:
972+
x-ratelimit-limit:
973+
description: 'Max number of attempts.'
974+
schema:
975+
type: integer
976+
x-ratelimit-remaining:
977+
description: 'Remaining number of attempts.'
978+
schema:
979+
type: integer
980+
content:
981+
application/json:
982+
schema:
983+
properties:
984+
data: { $ref: '#/components/schemas/APIError' }
985+
type: object
986+
'429':
987+
description: 'Reached rate limit.'
988+
headers:
989+
x-ratelimit-limit:
990+
description: 'Max number of attempts.'
991+
schema:
992+
type: integer
993+
x-ratelimit-remaining:
994+
description: 'Remaining number of attempts.'
995+
schema:
996+
type: integer
997+
'404':
998+
description: 'Resource record not found.'
999+
headers:
1000+
x-ratelimit-limit:
1001+
description: 'Max number of attempts.'
1002+
schema:
1003+
type: integer
1004+
x-ratelimit-remaining:
1005+
description: 'Remaining number of attempts.'
1006+
schema:
1007+
type: integer
1008+
content:
1009+
application/json:
1010+
schema:
1011+
properties:
1012+
data: { $ref: '#/components/schemas/APIError' }
1013+
type: object
9511014
/calculators:
9521015
get:
9531016
tags:
@@ -4025,10 +4088,15 @@ paths:
40254088
content:
40264089
application/json:
40274090
schema:
4091+
required:
4092+
- source
40284093
properties:
40294094
source:
40304095
type: string
40314096
example: 'https://www.example.com/recipe-url'
4097+
html_content:
4098+
type: [string, 'null']
4099+
example: '<p>HTML content</p>'
40324100
type: object
40334101
responses:
40344102
'200':
@@ -5766,7 +5834,7 @@ paths:
57665834
tags:
57675835
- Public
57685836
summary: 'Show bar'
5769-
description: 'Show public information about a single bar.'
5837+
description: 'Show public information about a single bar. To access this endpoint the bar must be marked as public.'
57705838
operationId: showPublicBar
57715839
parameters:
57725840
-
@@ -5776,6 +5844,12 @@ paths:
57765844
required: true
57775845
schema:
57785846
type: number
5847+
-
5848+
name: page
5849+
in: query
5850+
description: 'Set current page number'
5851+
schema:
5852+
type: integer
57795853
responses:
57805854
'200':
57815855
description: 'Successful response'
@@ -5796,8 +5870,8 @@ paths:
57965870
properties:
57975871
data: { $ref: '#/components/schemas/PublicBarResource' }
57985872
type: object
5799-
'403':
5800-
description: 'You are not authorized for this action.'
5873+
'404':
5874+
description: 'Resource record not found.'
58015875
headers:
58025876
x-ratelimit-limit:
58035877
description: 'Max number of attempts.'
@@ -5813,6 +5887,78 @@ paths:
58135887
properties:
58145888
data: { $ref: '#/components/schemas/APIError' }
58155889
type: object
5890+
security: []
5891+
'/public/{barId}/cocktails':
5892+
get:
5893+
tags:
5894+
- Public
5895+
summary: 'List cocktails'
5896+
description: 'List and filter bar cocktails. To access this endpoint the bar must be marked as public.'
5897+
operationId: listPublicBarCocktails
5898+
parameters:
5899+
-
5900+
name: barId
5901+
in: path
5902+
description: 'Database id of bar'
5903+
required: true
5904+
schema:
5905+
type: number
5906+
-
5907+
name: page
5908+
in: query
5909+
description: 'Set current page number'
5910+
schema:
5911+
type: integer
5912+
-
5913+
name: filter
5914+
in: query
5915+
description: 'Filter by attributes. You can specify multiple matching filter values by passing a comma separated list of values.'
5916+
style: deepObject
5917+
explode: true
5918+
schema:
5919+
properties:
5920+
name:
5921+
description: 'Filter by cocktail names(s) (fuzzy search)'
5922+
type: string
5923+
ingredient_name:
5924+
description: 'Filter by cocktail ingredient names(s) (fuzzy search)'
5925+
type: string
5926+
bar_shelf:
5927+
description: 'Show only cocktails on the bar shelf'
5928+
type: boolean
5929+
abv_min:
5930+
description: 'Filter by greater than or equal ABV'
5931+
type: number
5932+
abv_max:
5933+
description: 'Filter by less than or equal ABV'
5934+
type: number
5935+
type: object
5936+
-
5937+
name: sort
5938+
in: query
5939+
description: 'Sort by attributes. Available attributes: `name`, `created_at`, `average_rating`, `user_rating`, `abv`, `total_ingredients`, `missing_ingredients`, `missing_bar_ingredients`, `favorited_at`, `random`.'
5940+
schema:
5941+
type: string
5942+
responses:
5943+
'200':
5944+
description: 'Successful response'
5945+
headers:
5946+
x-ratelimit-limit:
5947+
description: 'Max number of attempts.'
5948+
schema:
5949+
type: integer
5950+
x-ratelimit-remaining:
5951+
description: 'Remaining number of attempts.'
5952+
schema:
5953+
type: integer
5954+
content:
5955+
application/json:
5956+
schema:
5957+
properties:
5958+
data: { description: 'The data for the current page', type: array, items: { $ref: '#/components/schemas/PublicCocktailResource' } }
5959+
links: { description: 'Links for pagination', properties: { first: { description: 'Link to the first page', type: [string, 'null'] }, last: { description: 'Link to the last page', type: [string, 'null'] }, prev: { description: 'Link to the previous page', type: [string, 'null'] }, next: { description: 'Link to the next page', type: [string, 'null'] } }, type: object }
5960+
meta: { properties: { current_page: { description: 'The current page number', type: integer }, from: { description: 'The starting index of the current page', type: integer }, last_page: { description: 'The last page number', type: integer }, links: { type: array, items: { description: 'Links for pagination', properties: { url: { description: 'The URL of the link', type: [string, 'null'] }, label: { description: 'The label of the link', type: [string, 'null'] }, active: { description: 'Whether the link is active', type: [boolean, 'null'] } }, type: object } }, path: { description: 'The path of the current page', type: string }, per_page: { description: 'The number of items per page', type: integer }, to: { description: 'The ending index of the current page', type: integer }, total: { description: 'The total number of items', type: integer } }, type: object }
5961+
type: object
58165962
'404':
58175963
description: 'Resource record not found.'
58185964
headers:
@@ -5873,23 +6019,6 @@ paths:
58736019
properties:
58746020
data: { $ref: '#/components/schemas/PublicCocktailResource' }
58756021
type: object
5876-
'403':
5877-
description: 'You are not authorized for this action.'
5878-
headers:
5879-
x-ratelimit-limit:
5880-
description: 'Max number of attempts.'
5881-
schema:
5882-
type: integer
5883-
x-ratelimit-remaining:
5884-
description: 'Remaining number of attempts.'
5885-
schema:
5886-
type: integer
5887-
content:
5888-
application/json:
5889-
schema:
5890-
properties:
5891-
data: { $ref: '#/components/schemas/APIError' }
5892-
type: object
58936022
'404':
58946023
description: 'Resource record not found.'
58956024
headers:

0 commit comments

Comments
 (0)