API feedback collector

Open
#1,606 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
58/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
api

Research direction

The API changes described are under trigger serialization and build serialization; start by locating those serializers and reading the API implementation merged in #1598. Reorder trigger_purpose beside trigger in trigger output and group the build trigger fields under a trigger key. Done when both response shapes match the examples; the issue names no tests to run.

Written by the indexing model from the issue text.

Description

This is feedback on the Runbot API that got merged in #1598.

Questionable behavior

  • Under trigger serialization (API: batch > slot > trigger), the purpose is at the end of the object. when manually looking at the output it's nice to have key 'trigger_purpose' close to its name.
    { trigger: 'xx', 'trigger_purpose': 'xx', manual: false, .. }
  • Under build serialization (API: build), the trigger data is split over multiple keys. for clearer responses and closer matching the runbot model move these properties under a single 'trigger' key.
    { children: [], trigger: { trigger: 'xx', trigger_purpose: 'xx' }, .. }

Feature requests

  • Under bundle serialization (API: bundle), return external links (if any). this mimics behavior of the current runbot frontend where you can click through to the branch commit/github PR.

Positive feedback

  • The logs array (API: batch > slot > trigger > build, build) is a good addition. People were parsing the log txt-files themselves before.
    This statement says nothing about the structure of the log object.
Dominant language
Python
Stars
166
Forks
160
Avg merge
2d 14h
Merged PRs (30d)
32

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from odoo/runbot

All issues in odoo/runbot

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.