Skip to content
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

CATALOG-9783: [add] Product Images: V2 REST Contract #220

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

olysenko
Copy link
Contributor

[DEVDOCS-]

What changed?

  • Added Product Images: V2 REST Contract

Release notes draft

  • Added Product Images: V2 REST Contract

Copy link
Collaborator

@bc-traciporter bc-traciporter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added editorial comments.

parameters:
- name: page
in: query
description: Specifies the page number in a limited (paginated) list of Product Images.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Specifies the page number in a limited (paginated) list of Product Images.
description: Specifies the page number in a limited (paginated) list of product images.

- name: limit
in: query
description: |-
Controls the number of items per page in a limited (paginated) list of Product Images.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Controls the number of items per page in a limited (paginated) list of Product Images.
Controls the number of items per page in a limited (paginated) list of product images.

post:
tags:
- Product Images V2
summary: Creates a new product image.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
summary: Creates a new product image.
summary: Creates New Product Image

delete:
tags:
- Product Images V2
summary: Deletes multiple Product Images.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
summary: Deletes multiple Product Images.
summary: Deletes Multiple Product Images

parameters:
- name: page
in: query
description: Specifies the page number in a limited (paginated) list of Product Images you can delete.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Specifies the page number in a limited (paginated) list of Product Images you can delete.
description: Specifies the page number in a limited (paginated) list of product images you can delete.

properties:
count:
type: integer
description: A count of the number of Product Images in the store.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: A count of the number of Product Images in the store.
description: A count of the number of product images in the store.

description: A count of the number of Product Images in the store.
example: 100
error:
title: Product Image error response
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: Product Image error response
title: Product image error response

name: errors
wrapped: true
ProductImage:
description: Get Product Image Response
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Get Product Image Response
description: Get product image Response

xml:
name: images
ProductImages:
description: Gets array of Product Images Response
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Gets array of Product Images Response
description: Gets array of product images response

name: images
wrapped: true
ProductImagesCount:
description: 'Gets a count of the total number of Product Images in the store.'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: 'Gets a count of the total number of Product Images in the store.'
description: 'Gets a count of the total number of product images in the store.'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants