Skip to content
This repository has been archived by the owner on May 16, 2024. It is now read-only.

Update open api client to latest open api spec #412

Merged
merged 3 commits into from
Feb 6, 2024
Merged

Conversation

frankisawesome
Copy link
Contributor

@frankisawesome frankisawesome commented Feb 5, 2024

Summary

  • New primary sale related types and endpoints
  • Description and API base update to be up to date
  • Some functions are rolled forward with description changes or additional functionality
  • One endpoint (create project) is deleted from the open api spec and all functions and examples are removed (confirmed with hub team)

Why the changes

Things worth calling out

Before merging

  • For Immutable developers: Do the changes in this PR require documentation updates? Please refer to this SDK documentation guide and list links to documentation update PRs (they don't have to be merged) below (or write N/A):
    • Add documentation update 1
    • Add documentation update 2

Signed-off-by: Frank Li <[email protected]>
@frankisawesome frankisawesome requested a review from a team as a code owner February 5, 2024 02:16
@frankisawesome frankisawesome marked this pull request as draft February 5, 2024 02:16
@frankisawesome frankisawesome marked this pull request as ready for review February 5, 2024 03:07
@frankisawesome frankisawesome changed the title Add create primary sale function Update open api client to latest open api spec Feb 5, 2024
Copy link
Contributor

@CodeSchwert CodeSchwert left a comment

Choose a reason for hiding this comment

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

Majority of the changes was just adding Immutable X API as a description on auto-generated files! Wish that could have been moved to a separate PR 😅

Comment on lines -456 to -470
/**
* Create a Project
* @param ethSigner - the L1 signer
* @param request - the request object containing the parameters to be provided in the API request
* @returns a promise that resolves with the created Project
* @throws {@link index.IMXError}
*/
public async createProject(
ethSigner: EthSigner,
request: CreateProjectRequest,
) {
return this.workflows
.createProject(ethSigner, request)
.then(res => res.data)
.catch(err => {
Copy link
Contributor

Choose a reason for hiding this comment

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

@frankisawesome this feels like a potentially very small breaking change? Could we get away with a minor version bump because project creation has moved to Hub? cc: @wdinau

Copy link
Contributor

Choose a reason for hiding this comment

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

Note, this would affect Unified SDK too since Core SDK is a dependency and requests are proxied through to Core SDK.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Discussed offline - these changes are OK'd by the hub team and we've confirmed these are intentional deletions

@frankisawesome frankisawesome merged commit 9846234 into main Feb 6, 2024
3 checks passed
@frankisawesome frankisawesome deleted the TD1119 branch February 6, 2024 05:25
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants