Skip to content

chore(MOS-2378): Remove page section-related configuration. #100

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
robvanderlee merged 1 commit into from
Apr 23, 2025
Merged

chore(MOS-2378): Remove page section-related configuration. #100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
217 changes: 0 additions & 217 deletions spec/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1190,116 +1190,6 @@ paths:
text/xml:
schema:
$ref: "#/components/schemas/CountResponse"
"/v{version}/categories/{category_id}/sections/{language}":
get:
tags:
- Page Sections
description: Returns all sections related to a page.
operationId: getPageSections
parameters:
- $ref: "#/components/parameters/version"
- name: category_id
in: path
description: The page's unique ID.
required: true
schema:
type: integer
- $ref: "#/components/parameters/language-path"
- $ref: "#/components/parameters/format"
responses:
200:
description: A list of page sections.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/PageSection"
application/xml:
schema:
type: array
items:
$ref: "#/components/schemas/PageSection"
put:
tags:
- Page Sections
description: |
Saves the content and order of page sections for a single page.

Be careful, as the data provided will overwrite existing page section data.
operationId: savePageSections
parameters:
- $ref: "#/components/parameters/version"
- name: category_id
in: path
description: The page's unique ID.
required: true
schema:
type: integer
- $ref: "#/components/parameters/language-path"
- $ref: "#/components/parameters/format"
requestBody:
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: "#/components/schemas/BannerSectionRequest"
responses:
200:
description: A list of page sections.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/PageSection"
application/xml:
schema:
type: array
items:
$ref: "#/components/schemas/PageSection"
"/v{version}/categories/sections/image":
post:
tags:
- Page Sections
description: Uploads an image to be used in a page section.
operationId: uploadPageSectionImage
parameters:
- $ref: "#/components/parameters/version"
- $ref: "#/components/parameters/format"
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
image:
type: string
format: binary
responses:
200:
description: The uploaded image's ID.
content:
application/json:
schema:
type: object
properties:
imageId:
type: integer
description: The unique identifier of the uploaded image.
example:
imageId: 3594
application/xml:
schema:
type: object
properties:
imageId:
type: integer
description: The unique identifier of the uploaded image.
example:
imageId: 3594
"/v{version}/discountcodes":
get:
tags:
Expand Down Expand Up @@ -1969,8 +1859,6 @@ tags:
description: Subscriber details for the store's newsletter
- name: Categories (Pages)
description: Page details
- name: Page Sections
description: The building blocks that make up a page's content.
- name: Customers
description: |
Store customer accounts.
Expand Down Expand Up @@ -3893,111 +3781,6 @@ components:
methods:
- name: ideal
displayName: iDEAL
PageSection:
properties:
id:
description: The page section's unique identifier.
type: string
format: uuid
type:
description: The type of page section.
type: string
enum:
- banner
position:
description: The position of this page section in the page's section order.
type: integer
isEnabled:
description: Determines whether the page section is shown on the storefront.
type: boolean
content:
anyOf:
- type: array
items:
$ref: "#/components/schemas/BannerSectionResponse"
example:
id: 09bf1b84-645e-4f5f-ba68-407f3ee11411
type: banner
position: 1
isEnabled: true
content:
- heading: Roger Bannister
text: Just because they say it's impossible doesn't mean you can't do it.
buttonText: Run
buttonUrl: https://en.wikipedia.org/wiki/Roger_Bannister
imageId: 3594
images:
- url: https://cdn.myonlinestore.com/
width: 1280
height: 720
PageSectionImage:
properties:
url:
description: The URL to the image.
type: string
width:
description: The width of the image in pixels.
type: integer
height:
description: The height of the image in pixels.
type: integer
BannerSectionRequest:
properties:
type:
description: The type of page section.
type: string
position:
description: The position of this page section in the page's section order.
type: integer
isEnabled:
description: Determines whether the page section is shown on the storefront.
type: boolean
heading:
description: The banner's title.
type: string
text:
description: The banner's text.
type: string
buttonText:
description: The text in the banner button.
type: string
buttonUrl:
description: The target web address of the banner button.
type: string
imageId:
description: The unique identifier for the banner background image.
type: integer
example:
type: banner
position: 1
isEnabled: true
heading: Roger Bannister
text: Just because they say it's impossible doesn't mean you can't do it.
buttonText: Run
buttonUrl: https://en.wikipedia.org/wiki/Roger_Bannister
imageId: 3594
BannerSectionResponse:
properties:
heading:
description: The banner's title.
type: string
text:
description: The banner's text.
type: string
buttonText:
description: The text in the banner button.
type: string
buttonUrl:
description: The target web address of the banner button.
type: string
imageId:
description: The unique identifier for the banner background image.
type: integer
images:
description: A list of images associated with the banner.
type: array
items:
$ref: "#/components/schemas/PageSectionImage"
PaymentGateway:
description: Payment Gateway
properties:
Expand Down