Commit Graph

1194 Commits

Author SHA1 Message Date
Gary Verhaegen
cacca56833
docs: documenting this and self (#14028)
Taking a stab at #11565.

CHANGELOG_BEGIN
CHANGELOG_END
2022-05-31 16:50:53 +02:00
Gary Verhaegen
a48640e25b
docs: clarify lf <-> json spec (#14025)
Trying to summarize a discussion we had on Slack.

CHANGELOG_BEGIN
CHANGELOG_END
2022-05-31 12:53:12 +00:00
Nicu Reut
2e1cc5c61b
[KV] - Replace RESOURCE_EXHAUSTED KV error with RESOURCE_OVERLOADED [kvl-1290] (#14014) 2022-05-30 14:37:17 +00:00
Stefano Baghino
ecb3149a6d
Update pom.xml (#13984)
Fix Java bindings Maven coordinates (see [here](https://search.maven.org/search?q=a:bindings-rxjava)).

changelog_begin
changelog_end
2022-05-25 12:54:25 +00:00
Raymond Roestenburg
f9d20e0b88
Removed reactive components from docs. (#13940)
CHANGELOG_BEGIN
CHANGELOG_END
2022-05-23 16:12:01 +02:00
Raymond Roestenburg
e3f01870a3
Added readyz endpoint. (#13902)
CHANGELOG_BEGIN
The ‘/readyz’ endpoint has been added to the trigger service to support readiness probes.
CHANGELOG_END
2022-05-19 08:34:26 +02:00
Gary Verhaegen
a7d46d25ce
remove workspace_status.sh (#13866)
This script was introduced to control the date printed in the sitemap.
The sitemap is now produced in the docs repo, so there's little point in
keeping this mechanism.

Moreover, the stamp on the docs build means it gets rebuilt on every
change to the date, i.e. every day, which isn't good for caching.

CHANGELOG_BEGIN
CHANGELOG_END
2022-05-12 12:41:27 +02:00
Stephen Compall
226dcc0eea
non-reflective abstractions for Java codegen Contracts (#13724)
* shift some generated Contract code to a handwritten superclass
* generate a `COMPANION` for each template
* use the companion in some ledger reading tests
* document changes in template Java codegen

CHANGELOG_BEGIN
- [daml codegen js] Generated templates have types, inherited methods,
  and a new static ``COMPANION`` that enable writing more
  template-generic utilities directly in Java.  New classes
  ``Contract``, ``ContractWithKey``, and ``ContractCompanion``, have
  been introduced; if you are importing
  ``com.daml.ledger.javaapi.data.codegen.*`` and have imported classes
  with these names from any other package, these references will stop
  working; use individual imports instead.
  See `issue #13724 <https://github.com/digital-asset/daml/pull/13724>`__.
CHANGELOG_END
2022-05-06 18:47:17 +00:00
carrielaben-da
1b4f9bb2f8
Removing the Daml Ledgers table (#13781)
* Removing the Daml Ledgers table

Removes the existing Deploying to Daml Ledgers table and moves Deploying To A Generic Daml Ledger up in the TOC

[CHANGELOG_BEGIN]

[CHANGELOG_END]

* Update index.pdf

Conforming the pdf to the rst

[CHANGELOG_BEGIN]

[CHANGELOG_END]

* Update packages.rst

Removed reference to a deleted page.

[CHANGELOG_BEGIN]

[CHANGELOG_END]

* Update authorization.rst

Removed link to deleted page

[CHANGELOG_BEGIN]

[CHANGELOG_END]

* Update authorization.rst

Corrected

[CHANGELOG_BEGIN]

[CHANGELOG_END]

* Update authorization.rst

Additional changes to try to pass the required checks.

[CHANGELOG_BEGIN]

[CHANGELOG_END]

Co-authored-by: carrie-laben <91496516+carrie-laben@users.noreply.github.com>
2022-05-06 12:51:40 -04:00
Gary Verhaegen
b795b484fc
docs: push source tree deps (#13814)
This PR collects and pushes to Artifactory the dependencies of the
sphinx-source-tree target. This is a first step in moving the actual
source tree to the docs repo.

CHANGELOG_BEGIN
CHANGELOG_END
2022-05-06 15:42:26 +00:00
Sergey Kisel
c959812e96
Documentation for test evidence. [DPP-996] (#13545)
* Documentation for test evidence. [DPP-996]

CHANGELOG_BEGIN
CHANGELOG_END

* doc update
2022-05-05 17:28:06 +02:00
Moisés Ackerman
767442ca97
Fix snippets from code-snippets/Types.daml (#13801)
changelog_begin
changelog_end
2022-05-05 16:22:03 +02:00
matevarga-da
1b552c421b
Docs first feature links (#13787)
* Broken links in docs

Fixing broken links is docs.

CHANGELOG_BEGIN
CHANGELOG_END

* Fixing missing _ for second link
2022-05-05 10:13:54 +02:00
carrielaben-da
58c615a251
Updating Titles and Headings (#13592)
* Updating Titles and Headings

Conforming titles and headings to best practices:

- Making them descriptive and non-repetitive
- Title case for first two levels of headings on a given page, sentence case for lower levels (in keeping with DA style guide)
- Typo fixes

[CHANGELOG_BEGIN]

[CHANGELOG_END]

* Updating Titles and Headings 2

Incorporating Stefano's comments throughout.

[CHANGELOG_BEGIN]

[CHANGELOG_END]

* Update docs/source/daml/intro/10_Functional101.rst

* Update docs/source/daml/intro/10_Functional101.rst

* Update docs/source/daml/intro/10_Functional101.rst

* Update docs/source/daml/reference/contract-keys.rst

fixing the 'Specify Maintainers' link

[CHANGELOG_BEGIN]

[CHANGELOG_END]

Co-authored-by: carrie-laben <91496516+carrie-laben@users.noreply.github.com>
2022-05-02 15:22:51 -04:00
Moisés Ackerman
61cb257225
Make disclosure explicit in Daml Studio tree view (#13735)
changelog_begin
* Daml Studio: transaction tree view now differentiates between disclosed and divulged contracts
changelog_end
2022-05-02 09:18:46 +02:00
Robert Autenrieth
31015b68fc
DPP-748 Remove Java migrations (#13731)
* Remove Java migrations

changelog_begin
changelog_end

* Add test
2022-04-29 12:19:23 +02:00
Victor Peter Rouven Müller
fbead1a80d
Use correct ledger id "sandbox" in json api docs examples (#13723)
changelog_begin

- A bit of the json api documentation which still used the removed `--ledgerid` flag for starting the sandbox has been updated. This also includes updating the ledgerid to be the participant id which by default is "sandbox".

changelog_end
2022-04-28 14:19:56 +02:00
Nicu Reut
04f991a340
[kvutils] - Add errors for post execution conflicts and out of time bounds [KVL-1369] (#13710) 2022-04-27 15:07:23 +00:00
Moisés Ackerman
9af86bcc2c
Update reference and docstrings for fromInterfaceContractId and fetchFromInterface (#13712)
changelog_begin
changelog_end
2022-04-27 14:10:17 +02:00
carrielaben-da
00c944ae7f
TOC update for the Java Bindings tutorial (#13688)
* TOC update for the Java Bindings tutorial

An adjustment to the TOC to make our Java Bindings tutorial easier to find.

[CHANGELOG_BEGIN]

[CHANGELOG_END]

* Update docs/source/building-applications.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

Co-authored-by: carrie-laben <91496516+carrie-laben@users.noreply.github.com>
Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>
2022-04-26 16:50:34 -04:00
Gary Verhaegen
5101487385
redirect old trigger-service page (#13699)
It still exist (clenup is not perfect on the docs bucket) and is wrong.
Another option would be to manually delete the file on s3, but since
people seem to still find it somehow, I think a redirect to the correct
page is better than a 404.

CHANGELOG_BEGIN
CHANGELOG_END
2022-04-26 18:48:19 +02:00
Remy
7dfbf58147
Daml-script: Use curly braces notation for records in ledger export (#13634)
instead of `with` notation

fixes #13620

CHANGELOG_BEGIN
- [Daml-script] fix a bug in daml-script export formatting
  See https://github.com/digital-asset/daml/issues/13620
CHANGELOG_END
2022-04-26 16:36:18 +02:00
matevarga-da
f14c609565
Fixing userIds and extra commas in JSON API docs (#13675)
Fixes #13641

Also fixes some extra commas in the JSON data.

CHANGELOG_BEGIN
CHANGELOG_END
2022-04-25 14:36:53 +02:00
Stephen Compall
7c33a02d44
test and document error when querying with a pruned offset argument (#13633)
* pruning test successful, shows the real error
* document current pruning failure

CHANGELOG_BEGIN
CHANGELOG_END
2022-04-20 10:57:33 -04:00
matevarga-da
61c15f870c
Broken links in docs (#13637)
Fixing broken links is docs. Remedies the issue reported in enterprise support case #00001714.

CHANGELOG_BEGIN
CHANGELOG_END
2022-04-20 09:18:01 +02:00
Hubert Slojewski
16a97e8715
Move KVErrors to participant-state-kv-errors [KVL-1371] (#13604)
CHANGELOG_BEGIN
CHANGELOG_END
2022-04-19 15:22:31 +02:00
carrielaben-da
b7c4bdab85
Adding Alt tags to images (#13469)
Adding and improving alt tags to all images in the documents for accessibility.

CHANGELOG_BEGIN
CHANGELOG_END
2022-04-12 20:06:22 +00:00
Gary Verhaegen
6fe55a0344
docs: remove ops/connect/index (#13575)
This brings the docs in line with digital-asset/docs.daml.com#5.

CHANGELOG_BEGIN
CHANGELOG_END
2022-04-12 21:30:25 +02:00
Gary Verhaegen
2064443555
docs: fix intro project names (#13562)
It looks like we have changed the package naming rules such that a lot
of examples in our documentation are now producing warnings. This PR
fixes the `daml new` commands, though I believe we should rather change
the package name constraints back, as it looks like a gratuitous
backwards-compatibility break.

CHANGELOG_BEGIN
CHANGELOG_END
2022-04-12 10:47:52 +00:00
Matthias Schmalz
c21a135d4f
Changed log level of PARTICIPANT_BACKPRESSURE to INFO. (#13555)
(Otherwise, an excessive rate of incoming commands will flood the log file with backpressure warnings.)

CHANGELOG_BEGIN
CHANGELOG_END
2022-04-12 09:49:55 +02:00
Stephen Compall
a62c2e1456
cross-reference associated WS and normal POST docs (#13563)
* cross-reference /v1/query and /v1/stream/query
* cross-reference /v1/fetch and /v1/stream/fetch

CHANGELOG_BEGIN
CHANGELOG_END
2022-04-11 14:49:31 -04:00
Victor Peter Rouven Müller
91a6ad7f36
Add generation of FromInterfaceContractId methods for supporting templates in the java codegen (#13460)
* Add generation of FromInterfaceContractId methods for supporting templates in the java codegen

changelog_begin

- Add generation of `unsafeFrom{InterfaceName}` methods to the `ContractId` class for templates implementing interfaces in the Java codegen. That allows to convert between interface contract IDs and template contract IDs. If a conversion was wrong it will raise an exception at runtime during the execution of a command. The conversion is thus not exception-safe.

changelog_end

* Update language-support/java/codegen/src/ledger-tests/scala/com/digitalasset/InterfacesTest.scala

Co-authored-by: Stephen Compall <stephen.compall@daml.com>

* Fix missing import

* Address https://github.com/digital-asset/daml/pull/13460#discussion_r838522450

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>
Co-authored-by: Stephen Compall <stephen.compall@daml.com>
Co-authored-by: Stefano Baghino <stefano.baghino@digitalasset.com>
2022-04-11 08:49:12 +00:00
carrielaben-da
ad7a8f420b
Updating the TOC index pages (#13528)
Incorporated Stefano's suggestions.

[CHANGELOG_BEGIN]

[CHANGELOG_END]

Co-authored-by: carrie-laben <91496516+carrie-laben@users.noreply.github.com>
2022-04-08 16:07:03 -04:00
Moisés Ackerman
4ca8abf185
Update interface ref docs to clarify that {pre,post}consuming qualifiers are not supported (#13523)
changelog_begin
changelog_end
2022-04-07 14:35:43 +02:00
Gary Verhaegen
b9c9acfb9e
docs: remove tools redirect (#13514)
The existing redirect breaks the intention behind #12880.

CHANGELOG_BEGIN
CHANGELOG_END
2022-04-06 11:16:35 +00:00
Sergey Kisel
7ba6b739a4
Clarify the correlation between mTLS client cert and application id. (#13496)
* Clarify the correlation between mTLS client certificate and application id.

CHANGELOG_BEGIN
CHANGELOG_END

* Apply suggestions from code review

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Point to the instruction instead of RFC

* Apply suggestions from code review

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>

* new line

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
2022-04-06 12:25:41 +02:00
carrielaben-da
3ff5cb6292
TOC index pages (#13468)
Adding text to the previously blank index pages on the Daml side of the documentation (text for the Canton side to follow.)

[CHANGELOG_BEGIN]

[CHANGELOG_END]

Co-authored-by: carrie-laben <91496516+carrie-laben@users.noreply.github.com>
2022-03-31 11:12:58 -04:00
Gary Verhaegen
3629d1915a
docs: fix canton ref (#13482)
The referenced section is here:
https://github.com/DACH-NY/canton/blob/main/docs-open/src/sphinx/architecture/ha.rst

It already contains a label definition, but it doesn't directly match
the title. I've tested this fix locally by building the combined docs.

CHANGELOG_BEGIN
CHANGELOG_END
2022-03-31 14:29:39 +00:00
davidrichards-da
a010f7cf5b
Enterprise v open source table (#13459)
* Added differences between the enterprise & open source editions

Added differences between the enterprise & open source editions & clearer instructions on how to download Canton.

* Empty commit with changelog notation

CHANGELOG_BEGIN
CHANGELOG_END

* Apply suggestions from code review

Typo's spotted by Carrie.

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>

* Updated the enterprise v open source table

Updated the enterprise v open source table with links and making sure all rows are relevant

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
2022-03-31 11:17:22 +01:00
Artúr Poór
3193d54246
docs: highlight json api supports multi-party submissions (#13409)
* docs: highlight json api supports multi-party submissions

CHANGELOG_BEGIN
CHANGELOG_END
2022-03-31 11:41:05 +02:00
davidrichards-da
ef55141788
Added clarity around security risk errors (#13407)
* Adding section to error codes page and updating descriptions

CHANGELOG_BEGIN
CHANGELOG_END
Added a section in the error codes page and improved description to errors

* Removing the multi-line descriptions

* Changing the added sentence

swapping 'due to security reasons' 'for security reasons'

* Updated formatting

Ran the fmt.sh script to give me the correct formatting.

* Updating the generated error codes

CHANGELOG_BEGIN
CHANGELOG_END
Updating the generated error codes
2022-03-30 15:50:00 +01:00
Victor Peter Rouven Müller
cc06073333
Java bindings/interface support (#13366)
* WIP

* First working version of java codegen daml interface support

* Update language-support/java/codegen/BUILD.bazel

Co-authored-by: Remy <remy.haemmerle@daml.com>

* Fix compile errors

* Simplify code massivly, enjoy less duplication

changelog_begin

- The Java codegen now has basic support for daml interface definitions. Converting a contract id of a template implementing an interface to a contract id of the interface is possible and both executing interface choices is possible on the contract id of the interface and implementing template.

changelog_end

* Rename the test file to reflect it is a test file & enhance the inner test name & extend it further

* Fix test

* Refactor parts of TemplateClass.scala into multiple files

* Format that files!

* Minimize duplication further

* Remove unused comment

* Simplify code
Co-authored-by: Stephen Compall <stephen.compall@daml.com>

* Update language-support/java/codegen/src/main/scala/com/digitalasset/daml/lf/codegen/CodeGenRunner.scala

Co-authored-by: Stephen Compall <stephen.compall@daml.com>

* Further refactoring and renaming of the TemplateClassSpec to ContractIdClassBuilderSpec

* Fix formatting

* Add interface docs

* Remove unnecessary code generation of the Contract class for interface types

* Use less bool flags and more good function names :)

* Fix build

Co-authored-by: Remy <remy.haemmerle@daml.com>
Co-authored-by: Stephen Compall <stephen.compall@daml.com>
2022-03-29 12:38:00 +02:00
Gary Verhaegen
a994288f96
damlc visual docs: remove <> (#13398)
These characters have a special meaning in Bash, so it's better to avoid
them as placeholders.

CHANGELOG_BEGIN
CHANGELOG_END
2022-03-24 15:07:39 +00:00
Moisés Ackerman
a88079e41a
Interface reference docs, cont. (#13378)
changelog_begin
changelog_end
2022-03-23 18:33:03 +01:00
Stefano Baghino
d1feab0796
Address review comments on documentation improvements (#13386)
* Address review comments on documentation improvements

Address https://github.com/digital-asset/daml/pull/13381#pullrequestreview-918754656

changelog_begin
changelog_end

* Address https://github.com/digital-asset/daml/pull/13381#discussion_r833249949

* Address https://github.com/digital-asset/daml/pull/13381#discussion_r833253079

* Address https://github.com/digital-asset/daml/pull/13381#discussion_r833254062
2022-03-23 10:57:08 -04:00
Stefano Baghino
30acaaea77
Document how to connect HTTP JSON API Service to an HA participant (#13381)
* Document how to connect HTTP JSON API Service to an HA participant

Fixes https://github.com/digital-asset/daml/issues/13369

changelog_begin
changelog_end

* Add dummy Canton docs ref for `high-availability`
2022-03-23 13:05:15 +01:00
Moisés Ackerman
9f6c1757bc
Interface reference docs (#13337)
* Prefix contract keys and exceptions reference docs with 'Reference:' to match siblings

* Interface reference docs: syntax

* Interface reference docs: functions

changelog_begin
changelog_end
2022-03-23 10:43:39 +01:00
Stephen Compall
d37a63f56e
interface choices in json-api (#13301)
This expands the domain of the exercise endpoint to accept interface IDs
instead of template IDs when exercising by contract ID. The argument is
still [compatibly] called templateId; interface IDs are accepted nowhere
else.

CHANGELOG_BEGIN
- [JSON API] Supports interface choices, including exercise by contract
  ID accompanied by an interface ID.
  See `issue #13301 <https://github.com/digital-asset/daml/pull/13301>`__.
CHANGELOG_END
2022-03-18 17:47:30 +00:00
Stefano Baghino
0b662a77bd
Fix typo in HTTP JSON API Service docs (#13331)
Addresses https://github.com/digital-asset/daml/pull/13330/files#r829985080

changelog_begin
changelog_end
2022-03-18 15:29:46 +01:00
Stefano Baghino
a4abb4ef9e
Remove mentions of the token for package retrieval (#13330)
It has been removed some time ago.

changelog_begin
changelog_end
2022-03-18 12:53:30 +00:00