Last active
January 25, 2021 14:10
-
-
Save KevinJCross/27d111d4c33ddec3bd5f1af06940ba37 to your computer and use it in GitHub Desktop.
Citrus openApi spec
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openapi: "3.0.0" | |
info: | |
version: 0.0.1 | |
title: Banner Preview | |
license: | |
name: MIT | |
servers: | |
- url: http://www.sainsburys.co.uk/gb/groceries/next | |
paths: | |
'/banner-preview': | |
get: | |
summary: Get the production preview of the citrus bannerx on the sainsburys website | |
operationId: getBanner | |
parameters: | |
- name: "bannerText" | |
in: query | |
description: Banner text | |
required: true | |
examples: | |
uat: | |
value: "Citrus UAT Banner" | |
summary: "banner text" | |
schema: | |
type: string | |
- name: "heroImage" | |
in: query | |
description: primary hero image address | |
required: true | |
examples: | |
uat: | |
value: "https://cdn.flavedo.io/s/7b965e85-64ae-4574-9d6d-4c45c448668e" | |
summary: "hero image" | |
schema: | |
type: string | |
- name: "heroImageAltText" | |
in: query | |
description: primary hero image alt text | |
required: true | |
examples: | |
uat: | |
value: "Example hero image alt text" | |
summary: "hero image alt text" | |
schema: | |
type: string | |
- name: "secondaryHeroImage" | |
in: query | |
description: secondary hero image address | |
examples: | |
uat: | |
value: "https://cdn.flavedo.io/s/02c1440c-bad4-4cf8-a208-be910827e30a" | |
summary: "secondary hero image addresse" | |
required: true | |
schema: | |
type: string | |
- name: "secondaryHeroImageAltText" | |
in: query | |
description: secondary hero image alt text | |
required: true | |
examples: | |
uat: | |
value: "Example secondary hero image alt text" | |
summary: "secondary hero image alt text" | |
schema: | |
type: string | |
- name: "ctaLink" | |
in: query | |
description: Call to action link if present | |
examples: | |
uat: | |
value: "https://cdn.flavedo.io/s/02c1440c-bad4-4cf8-a208-be910827e30a" | |
summary: "Call to action link" | |
required: false | |
schema: | |
type: string | |
- name: "gtins" | |
in: query | |
description: Comma separated list of gtins in the campaign | |
examples: | |
uat: | |
value: "7913494,6815686" | |
summary: "gtin list" | |
required: true | |
schema: | |
type: string | |
- name: "citrusContentStandardId" | |
in: query | |
description: content standardId | |
examples: | |
uat: | |
value: "bd59be89-b13f-440f-a57e-0e5a481bec8b" | |
summary: "example uatcontent standardIdk" | |
required: true | |
schema: | |
type: string | |
responses: | |
'200': | |
description: OK html response |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment