Multiple Dropper v0.2.0 API improvements #299
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Now the caller can specify `contract_id` or `contract_address` as a query parameter. At least one of those parameters should be provided. `registered_contract_id` in response is now `contract_id`. The response also contains a `contract_address` field.
This allows them to create call requests by contract_id *or* by
contract_address.
I have added `"contract_id"` and `"contract_address"` keys to
`CreateCallRequestsAPIRequest`:
```python
class CreateCallRequestsAPIRequest(BaseModel):
contract_id: Optional[UUID] = None
contract_address: Optional[str] = None
specifications: List[CallSpecification] = Field(default_factory=list)
ttl_days: Optional[int] = None
```
At least one of those keys must have a non-null value.
Resolves #298
zomglings
force-pushed
the
dropper-v0.2.0-api-improvements
branch
from
7e0b57b
to
28e0c35
Compare
Using Pydantic root validator to ensure that at least one of contract_id or contract_address is provided in the request body (these are optional fields in the JSON).
This makes the API more RESTful. - - - The `POST /contracts/` endpoint also now displays the `contract_type` enum values in API docs. Resolves #276 - - - Also added a PUT `/contracts/<contract_id>` endpoint, which allows users to modify the title, description, and image URI for a contract. These changes only apply to the Moonstream Engine API. Resolves #296
The constraint now includes `moonstream_user_id`. This allows multiple users to register the same contract. Resolves #295
when `call_requests` are created from the API. Also fixed a bug where the `CallRequest` response object did not respect `null` `expired_at` fields.
|
@bugout-dev check
|
kompotkot
reviewed
May 3, 2023
| @@ -160,6 +160,7 @@ class RegisteredContract(Base): # type: ignore | |||
| __table_args__ = ( | |||
| UniqueConstraint( | |||
| "blockchain", | |||
| "moonstream_user_id", | |||
There was a problem hiding this comment.
Are we sure if we run migration we will not get error bacause of hitting uniqe constraint?
There was a problem hiding this comment.
Yeah, this feature was just launched into production and there are only two rows in production database under this relation currently.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Queries and responses on
/contracts/requestsnow showcontract_addressNow the caller can specify
contract_idorcontract_addressas a query parameter.At least one of those parameters should be provided.
registered_contract_idin response is nowcontract_id.The response also contains a
contract_addressfield.Resolves #283
Create
call_requestsusing contract ID or contract addressThis change allows users to create call requests by posting to
/contracts/requestswith a JSON body which contains a"contract_id"key or a"contract_address"key.This change also removes the old
/contracts/<contract_id>/requestsPOST endpoint.Resolves #298
Moved
POST /contracts/registertoPOST /contracts/This makes the API more RESTful.
POST /contracts/documentation showscontract_typeas an enumPreviously, this parameter of the request body was being displayed as a string.
Resolves #276
Allow users to edit registered contracts
added a PUT
/contracts/<contract_id>endpoint, which allows users to modify the title, description, and image URI for a contract. These changes only apply to the Moonstream Engine API.Resolves #296
Updated
waggleto respect new API changes/contracts/requestscall_requestsusing contract ID or contract addressUnique constraint on
registered_contractsmodified to includemoonstream_user_idThis allows different users to register the same contract under their respective accounts.
Resolves #295
ttl_daysis not longer directly inserted into raw SQLAlso fixed a bug on how the list call requests endpoint handled call requests with
nullexpires_atfields - it led to a 500 error before.Resolves #300
How to test these changes?
Tested manually.