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.

Sign up for GitHub

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

Jump to bottom

Add async txsub endpoint documentation #540

Merged
merged 9 commits into from
May 8, 2024
Merged

Add async txsub endpoint documentation #540

merged 9 commits into from
May 8, 2024

Conversation

aditya1702
Copy link
Contributor

@aditya1702 aditya1702 commented May 2, 2024 •
edited
Loading

This PR adds an openAPI spec to generate the documentation for the new async txsub endpoint in Horizon - stellar/go#5188

@stellar-jenkins
Copy link

Something went wrong with PR preview build please check

1 similar comment
@stellar-jenkins
Copy link

Something went wrong with PR preview build please check

@stellar-jenkins
Copy link

Preview is available here:
http://developers-pr540.previews.kube001.services.stellar-ops.com

@stellar-jenkins
Copy link

Preview is available here:
http://developers-pr540.previews.kube001.services.stellar-ops.com

@stellar-jenkins
Copy link

Preview is available here:
http://developers-pr540.previews.kube001.services.stellar-ops.com

@aditya1702 aditya1702 requested a review from JakeUrban May 2, 2024 20:56
JakeUrban
JakeUrban reviewed May 2, 2024
View reviewed changes
Copy link
Contributor

@JakeUrban JakeUrban left a comment

Choose a reason for hiding this comment

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

Looks great! I added some phrasing suggestions but nothing blocking.

openapi/horizon/bundled.yml Outdated Show resolved Hide resolved
openapi/horizon/bundled.yml Outdated Show resolved Hide resolved
openapi/horizon/bundled.yml Show resolved Hide resolved
openapi/horizon/bundled.yml Show resolved Hide resolved
openapi/horizon/components/schemas/asyncTransactionSubmissionSchema.yml Show resolved Hide resolved
ElliotFriend
ElliotFriend reviewed May 2, 2024
View reviewed changes
Copy link
Contributor

@ElliotFriend ElliotFriend left a comment

Choose a reason for hiding this comment

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

Thanks for making the additions! I don't think any of Jake's questions are blockers, either. But, I'd love to hear your thoughts before we merge.

@stellar-jenkins
Copy link

Preview is available here:
http://developers-pr540.previews.kube001.services.stellar-ops.com

@aditya1702 aditya1702 closed this May 6, 2024
@aditya1702 aditya1702 deleted the async-txsub-docs branch May 6, 2024 17:38
@aditya1702 aditya1702 restored the async-txsub-docs branch May 6, 2024 17:39
@aditya1702 aditya1702 reopened this May 6, 2024
@stellar-jenkins
Copy link

Preview is available here:
http://developers-pr540.previews.kube001.services.stellar-ops.com

1 similar comment
@stellar-jenkins
Copy link

Preview is available here:
http://developers-pr540.previews.kube001.services.stellar-ops.com

@aditya1702 aditya1702 changed the base branch from main to async-txsub-docs-final May 6, 2024 17:40
@stellar-jenkins
Copy link

Preview is available here:
http://developers-pr540.previews.kube001.services.stellar-ops.com

@stellar-jenkins
Copy link

Preview is available here:
http://developers-pr540.previews.kube001.services.stellar-ops.com

@aditya1702 aditya1702 merged commit 42fc573 into stellar:async-txsub-docs-final May 8, 2024
1 check passed
aditya1702 added a commit that referenced this pull request Jul 9, 2024
@aditya1702 @JakeUrban
horizon: Add endpoint documentation for async txsub endpoint (#758)
10f48ff 
* Add async txsub endpoint documentation (#540)

* Add async txsub endpoint documentation

* Add new line

* Add async endpoint .mdx file

* add bundled.yml

* add sidebar.js

* Update openapi/horizon/bundled.yml

Co-authored-by: Jake Urban <[email protected]>

* Change to "Asynchronously"

* Change to "Asynchronously" - 2

* Change to "Asynchronously" - 3

---------

Co-authored-by: Jake Urban <[email protected]>

* Add documentation page for async endpoint

---------

Co-authored-by: Jake Urban <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JakeUrban JakeUrban JakeUrban approved these changes

@kalepail kalepail Awaiting requested review from kalepail

@ElliotFriend ElliotFriend Awaiting requested review from ElliotFriend

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@aditya1702 @stellar-jenkins @ElliotFriend @JakeUrban