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

EDU-10351 23H2KR5 | Promotions & Taxes API #1049

Merged
merged 40 commits into from
Nov 28, 2023

Conversation

geisecosta
Copy link
Contributor

Types of changes

  • New content (endpoints, descriptions or fields from scratch)
  • Improvement (make an endpoint's title or description even better)
  • Spelling and grammar accuracy (self-explanatory)

Changelog

Do not forget to update your changes to our Developer Portal's changelog. Did you create a release note?

  • Yes, I already created a release note about this change.
  • No, but I am going to.

Copy link

Thanks for your contribution. The .json file will be checked now with Spectral.

VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsagenotificationRequest"
Copy link
Contributor

Choose a reason for hiding this comment

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

Por que remover o schema? Isso não é uma boa prática e só torna o arquivo repetitivo

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Esta informação não se repete não havendo a necessidade do uso do schema por links, aqui foi colocado o conteúdo do schema fazendo com que essa informação esteja mais próxima do endpoint (local onde ele é usado). O schemas que se repetem foram mantidos.

VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
@@ -8500,278 +9341,6 @@
}
}
},
"PricebycontextRequest": {
Copy link
Contributor

Choose a reason for hiding this comment

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

Não recomendo deletar esse e outros schemas. Os schemas servem justamente para evitar repetições no arquivo e criar uma referência única. Acho que vale inclusive adicionar mais informações em schemas nesse arquivo.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

O schema foi removido e levada para o local onde havia o link no endpoint pois essa informacao não se repete, neste caso levei para o local de uso pois facilita o entendimento do endpoint quando ao se navegar pela documentação, visto que todas suas informacoes estão proxima.

Em informações que se repete eu mantive os schema, e aos poucos pretendo criar outros schema quando fizer sentido.

geisecosta and others added 23 commits November 17, 2023 11:02
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
@@ -1774,18 +1794,38 @@
},
"listSku1BuyTogether": {
"type": "array",
"description": "SKU first list for the promotion **Buy Together**.",
"description": "Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.",
Copy link
Contributor

Choose a reason for hiding this comment

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

O que significa "the first list of the Buy Together promotion"? (se for alterar aqui para explicar melhor, precisa alterar em todos os lugares onde essa descrição aparece)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Trata-se de um array que contém uma lista de SKU, adicionado na primeira lista da promoção compre junto.

VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
VTEX - Promotions & Taxes API.json Outdated Show resolved Hide resolved
Copy link
Contributor

@julia-rabello julia-rabello left a comment

Choose a reason for hiding this comment

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

LGTM, mas falta resolver os erros do Spectral em um PR futuro.

@geisecosta geisecosta merged commit b489ca3 into master Nov 28, 2023
0 of 3 checks passed
@geisecosta geisecosta deleted the EDU-10351-23H2KR5-Promotions-&-Taxes-API-B1 branch November 28, 2023 19:09
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