-
Notifications
You must be signed in to change notification settings - Fork 9
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
Json API v2 initial documentation #830
Open
jarekr-da
wants to merge
29
commits into
main
Choose a base branch
from
jarekr/json3_api_doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+7,312
−1,545
Open
Changes from 26 commits
Commits
Show all changes
29 commits
Select commit
Hold shift + click to select a range
dc8dc08
creating rescue
jarekr-da 4233a79
creating rescue
jarekr-da fb7db7c
after rescue
jarekr-da 0d2da0e
extended underline
jarekr-da f46cdc0
fixed CreateAndExercise
jarekr-da d914cc1
Update docs/3.1/docs/json-api/asyncapi.rst
jarekr-da 579a7b2
Update docs/3.1/docs/json-api/asyncapi.rst
jarekr-da e4e7db9
Update docs/3.1/docs/json-api/asyncapi.rst
jarekr-da 8c65059
Update docs/3.1/docs/json-api/asyncapi.rst
jarekr-da c30b215
Update docs/3.1/docs/json-api/v1/index.rst
jarekr-da 405826c
Update docs/3.1/docs/json-api/v1/index.rst
jarekr-da 5092f37
Update docs/3.1/docs/json-api/v1/index.rst
jarekr-da 5881582
Update docs/3.1/docs/json-api/v1/index.rst
jarekr-da 57a398f
Update docs/3.1/docs/json-api/v1/index.rst
jarekr-da 665a726
spelling + fixes
jarekr-da 5ec5c1a
spelling + fixes
jarekr-da f0c2cc6
spelling + fixes
jarekr-da 21ecde9
working pdf
jarekr-da 1e75a0b
working pdf
jarekr-da a2a9432
Update docs/3.1/docs/json-api/asyncapi.rst
jarekr-da 2a989f1
Update docs/3.1/docs/json-api/asyncapi.rst
jarekr-da 26de930
Update docs/3.1/docs/json-api/index.rst
jarekr-da 53cc1fc
Update docs/3.1/docs/json-api/index.rst
jarekr-da a4e8460
Update docs/3.1/docs/json-api/index.rst
jarekr-da b5c7197
Update docs/3.1/docs/json-api/index.rst
jarekr-da 5fb07c4
Update docs/3.1/docs/json-api/openapi.rst
jarekr-da 8210f32
Update docs/3.1/docs/json-api/index.rst
jarekr-da 7ba8552
working pdf
jarekr-da eb40ebc
added package names
jarekr-da File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
|
||
JSON API V2 Asyncapi definition | ||
############################### | ||
|
||
This section contains a copy of the asyncapi/openapi specification. | ||
|
||
If you start Canton with the HTTP API enabled, this specification is available under http://<host>:<port>/docs/asyncapi | ||
|
||
The sources below can be copied to `Editor swagger IO <https://editor-next.swagger.io>`_ . The editor displays a preview of the specification and generates example inputs and outputs. | ||
|
||
The specification covers streaming (websockets) endpoints - for regular endpoints (HTTP) please see :doc:`openapi` | ||
|
||
Properties of type: `{}` (any JSON) are DAML types as defined in the Daml template and formatted according to :doc:`lf-value-specification`. | ||
|
||
.. literalinclude:: openapi/asyncapi.yaml | ||
:language: yaml |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do these work yet?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Websockets work normally.