Skip to content

feat: contract composer apis #2

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: contract composer apis #2

wants to merge 5 commits into from

Conversation

THLyon
Copy link
Contributor

@THLyon THLyon commented May 28, 2025

No description provided.

Copy link
Contributor

@ParkerVR ParkerVR left a comment

Choose a reason for hiding this comment

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

General Revisions

@@ -27,6 +27,12 @@ service EqualIQ {
GetContractSignatures
UpdateSignatureStatus
DeleteContractSignature
CreateComposerContract
UpdateComposerContract
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 split out different kinds of updates?

CreateComposerContract
UpdateComposerContract
ListComposerContracts
GetComposerContract
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 split different kinds of Gets? Maybe we should use Meta vs Content?

@@ -27,6 +27,12 @@ service EqualIQ {
GetContractSignatures
UpdateSignatureStatus
DeleteContractSignature
CreateComposerContract
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 use smithy Resources?

@@ -98,6 +104,18 @@ enum SignContractResult {
FAILURE
}

enum ComposerContractStatus {
DRAFT
FINALIZED
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should treat this more like a cache structure for now:

NEW
CLEAN_IN_VAULT
DIRTY
ARCHIVED

sectionId: String
name: String
content: String
plainTextSummary: String
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's leave this in the frontend for now

@@ -698,3 +716,130 @@ structure DeleteContractSignatureOutput {
message: String
}


structure ComposerContractSection {
sectionId: String
Copy link
Contributor

Choose a reason for hiding this comment

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

Enum

structure ComposerContractSection {
sectionId: String
name: String
content: String
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of 'name'/'content' let's add specific structured type for each section with the required fields.

}

list ComposerContractList {
member: ComposerContract
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's split out a Metadata type so that we don't need the full composer data for every item in the list

@required
title: String
@required
type: ContractType
Copy link
Contributor

Choose a reason for hiding this comment

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

We should take the input form details as well

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