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

feat: change openapi spec for transactions to consider resource manager #2486

Merged
merged 3 commits into from
May 4, 2023

Conversation

mathnogueira
Copy link
Member

@mathnogueira mathnogueira commented May 4, 2023

This PR changes the CRUD operations on transactions to use the resource manager strategy

Checklist

  • tested locally
  • added new dependencies
  • updated the docs
  • added a test

api/openapi.yaml Outdated
items:
type: array
items:
$ref: "./transactions.yaml#/components/schemas/Transaction"
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we update this Transaction def to include the type and spec format?

Copy link
Collaborator

Choose a reason for hiding this comment

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

+1

Copy link
Member Author

Choose a reason for hiding this comment

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

oh yeah, forgot we don't have those fields in this object. Fixing that!

Copy link
Collaborator

@schoren schoren left a comment

Choose a reason for hiding this comment

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

@mathnogueira there is one change that we need to implement, regarding the use of augmented entities. We have now 2 separated fields for Steps (full test) and stepIDs (just the ids).

For backwards compatibility with the yaml file, I used the steps name for the stepIDs, and fullSteps for the field containing the entire test definition of each step. Feel free to use a better name for this.

@mathnogueira
Copy link
Member Author

fullSteps

Something like this?

Transaction:
    type: object
    properties:
        steps:
          type: array
          description: list of steps of the transaction containing just each test id
          items:
            type: string
        fullSteps:
          type: array
          description: list of steps of the transaction containing the whole test object
          items:
            $ref: "./tests.yaml#/components/schemas/Test"

@schoren
Copy link
Collaborator

schoren commented May 4, 2023

@mathnogueira yeap, exactly that!

@mathnogueira mathnogueira merged commit 22f7dd1 into main May 4, 2023
31 checks passed
@mathnogueira mathnogueira deleted the feat/transactions-openapi branch May 4, 2023 20:28
xoscar added a commit that referenced this pull request May 5, 2023
xoscar added a commit that referenced this pull request May 5, 2023
…ce manager" (#2497)

Revert "feat: change openapi spec for transactions to consider resource manager (#2486)"

This reverts commit 22f7dd1.
@xoscar xoscar restored the feat/transactions-openapi branch May 5, 2023 22:30
xoscar added a commit that referenced this pull request May 5, 2023
* change openapi spec for transactions to consider resource manager

* use resource formatted object for input and output

* add fullsteps field for transactions

* Revert "feat: change openapi spec for transactions to consider resource manager" (#2497)

Revert "feat: change openapi spec for transactions to consider resource manager (#2486)"

This reverts commit 22f7dd1.

---------

Co-authored-by: Matheus Nogueira <matheus.nogueira2008@gmail.com>
schoren pushed a commit that referenced this pull request May 9, 2023
…er (#2486)

* change openapi spec for transactions to consider resource manager

* use resource formatted object for input and output

* add fullsteps field for transactions
schoren pushed a commit that referenced this pull request May 9, 2023
…ce manager" (#2497)

Revert "feat: change openapi spec for transactions to consider resource manager (#2486)"

This reverts commit 22f7dd1.
schoren pushed a commit that referenced this pull request Jun 5, 2023
…er (#2486)

* change openapi spec for transactions to consider resource manager

* use resource formatted object for input and output

* add fullsteps field for transactions
schoren pushed a commit that referenced this pull request Jun 5, 2023
…ce manager" (#2497)

Revert "feat: change openapi spec for transactions to consider resource manager (#2486)"

This reverts commit 22f7dd1.
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.

None yet

3 participants