GitAuto: [FEATURE] Api para enviar cadastros

[gitauto-ai]

Resolves #21

O que é a funcionalidade

Adição de uma API para envio de cadastros de produtos para o e-commerce.

Por que precisamos da funcionalidade

Atualmente, o envio de produtos é realizado via webservice SOAP, o que pode ser complexo e menos eficiente para os desenvolvedores. Com a implementação de uma API RESTful, facilitaremos a integração e melhoraremos a experiência do usuário ao interagir com a plataforma de e-commerce VTEX.

Como implementar e por quê

1. Desenvolvimento dos Endpoints da API: Criar endpoints RESTful que permitam o envio, atualização e gerenciamento de cadastros de produtos de forma simplificada.
2. Autenticação e Segurança: Implementar mecanismos de autenticação robustos (como OAuth 2.0) para garantir a segurança nas operações de envio de dados.
3. Validação de Dados: Adicionar validações tanto no lado do cliente quanto no servidor para assegurar a integridade e consistência dos dados dos produtos.
4. Documentação da API: Elaborar uma documentação detalhada utilizando ferramentas como Swagger para facilitar o uso da API pelos desenvolvedores.
5. Testes Automatizados: Desenvolver testes unitários e de integração para garantir a funcionalidade e a confiabilidade da nova API.
6. Migração Gradual: Permitir que usuários existentes possam migrar de SOAP para a nova API de forma gradual, garantindo uma transição suave.

Essas etapas proporcionam uma implementação estruturada que melhora a eficiência, segurança e usabilidade da plataforma.

Sobre a compatibilidade com versões anteriores

Manter a compatibilidade com a integração existente via webservice SOAP é essencial para não interromper o fluxo de trabalho dos desenvolvedores que já utilizam a versão atual. A nova API será adicionada como uma funcionalidade complementar, permitindo que os usuários escolham entre continuar com SOAP ou adotar a nova API RESTful conforme suas necessidades.

Test these changes locally

git checkout -b gitauto/issue-21-580ca5e0-8982-43c9-9021-91ba4f11fa79
git pull origin gitauto/issue-21-580ca5e0-8982-43c9-9021-91ba4f11fa79

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[gitauto-ai]

Approve permission(s) to allow GitAuto to access the check run logs here: https://github.com/settings/installations/52064309/permissions/update

[gitauto-ai]

Committed the Check Run linter-check error fix! Running it again...

[github-actions]

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

12:11AM INF scanning for exposed secrets...
12:11AM INF 335 commits scanned.
12:11AM INF scan completed in 246ms
12:11AM INF no leaks found

[gitauto-ai]

▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 30%
Checking if I can solve it or if I should just hit you up...

[gitauto-ai]

▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 30%
Checking if I can solve it or if I should just hit you up...

[github-advanced-security]

Sonarcsharp (reported by Codacy) found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

[AppVeyorBot]

❌ Build VTEX-SDK-dotnet 2.4.43 failed (commit 24989faa5d by @gitauto-ai[bot])