[Self-service error codes] Update existing error code references [DPP-593] #11798
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
tudor-da
changed the title
tudor-da
changed the title
tudor-da
force-pushed
the
tudor/dpp-593-update-existing-error-code-references
branch
3 times, most recently
from
b7c37a0 to
03a6ad8
Compare
tudor-da
requested review from
cocreature,
meiersi-da,
stefanobaghino-da and
a team
as code owners
pbatko-da
approved these changes
Nov 22, 2021
| @@ -1,27 +1,26 @@ | |||
| .. Copyright (c) 2021 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved. | |||
| .. SPDX-License-Identifier: Apache-2.0 | |||
|
|
|||
| .. _error-codes: | |||
There was a problem hiding this comment.
So this page can be referenced from other places (e.g. https://github.com/digital-asset/daml/pull/11798/files#diff-ae34df17702f7e4de7473c6a7959b660ee7230374f1bc12173742d053310b148R13)
There was a problem hiding this comment.
But since the file name is the same might not be needed. Let me check
|
|
||
| For submitted commands, there are these response codes: | ||
| Generically, on submitted commands the Ledger API responds with the following gRPC status codes: |
There was a problem hiding this comment.
Could this section be dropped and instead we should point to the error categories inventory?
There was a problem hiding this comment.
I think this is still a good intro for getting started.
| @@ -54,6 +51,7 @@ service PartyManagementService { | |||
| // - ``UNAUTHENTICATED``: if the request does not include a valid access token | |||
| // - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation | |||
| // - ``UNIMPLEMENTED``: if synchronous party allocation is not supported by the backing participant | |||
| // - ``DEADLINE_EXCEEDED``: if the request times out | |||
There was a problem hiding this comment.
Going forward it seems to me we want to thing of signalling errors in terms of error categories, not gRpc status codes. If so, then at some point it could be easier, from maintenance standpoint, to list error categories here instead.
mziolekda
reviewed
Nov 22, 2021
ledger-api/grpc-definitions/com/daml/ledger/api/v1/admin/package_management_service.proto
Outdated
Show resolved
Hide resolved
mziolekda
reviewed
Nov 22, 2021
ledger-api/grpc-definitions/com/daml/ledger/api/v1/admin/party_management_service.proto
Outdated
Show resolved
Hide resolved
mziolekda
reviewed
Nov 22, 2021
ledger-api/grpc-definitions/com/daml/ledger/api/v1/admin/participant_pruning_service.proto
Outdated
Show resolved
Hide resolved
mziolekda
reviewed
Nov 22, 2021
ledger-api/grpc-definitions/com/daml/ledger/api/v1/command_completion_service.proto
Show resolved
Hide resolved
mziolekda
reviewed
Nov 22, 2021
ledger-api/grpc-definitions/com/daml/ledger/api/v1/transaction_service.proto
Show resolved
Hide resolved
tudor-da
requested review from
dasormeter,
garyverhaegen-da,
nickchapman-da and
S11001001
as code owners
CHANGELOG_BEGIN CHANGELOG_END
Co-authored-by: pbatko-da <[email protected]>
tudor-da
force-pushed
the
tudor/dpp-593-update-existing-error-code-references
branch
from
e96143a to
2cf371d
Compare
tudor-da
force-pushed
the
tudor/dpp-593-update-existing-error-code-references
branch
from
2cf371d to
4b83c27
Compare
tudor-da
force-pushed
the
tudor/dpp-593-update-existing-error-code-references
branch
from
4b83c27 to
7109cdc
Compare
tudor-da
added
automerge
needs-backport
mergify
bot
deleted the
tudor/dpp-593-update-existing-error-code-references
branch
tudor-da
added a commit
that referenced
this pull request
Nov 22, 2021
…-593] (#11798) * Updated Ledger API services protobuf definitions CHANGELOG_BEGIN CHANGELOG_END * Adapted Building Applications / Ledger API / gRPC section * Moved Error Codes under Building Applications / Ledger API / gRPC * Small rewording Error codes page * Updated outdated LedgerAPI / gRPC page * Apply suggestions from code review Co-authored-by: pbatko-da <[email protected]> * Moved Error Codes under Building Applications / Ledger API / gRPC * Updated outdated LedgerAPI / gRPC page * Addressed review comments * Addressed review comments * Remove unnecessary link to error-codes * `Ledger API` changed to `Common Ledger API change` Co-authored-by: pbatko-da <[email protected]>
7 tasks
S11001001
added a commit
that referenced
this pull request
Nov 22, 2021
- see c4b6a17 CHANGELOG_BEGIN CHANGELOG_END
7 tasks
tudor-da
added a commit
that referenced
this pull request
Nov 23, 2021
…-593] (#11798) * Updated Ledger API services protobuf definitions CHANGELOG_BEGIN CHANGELOG_END * Adapted Building Applications / Ledger API / gRPC section * Moved Error Codes under Building Applications / Ledger API / gRPC * Small rewording Error codes page * Updated outdated LedgerAPI / gRPC page * Apply suggestions from code review Co-authored-by: pbatko-da <[email protected]> * Moved Error Codes under Building Applications / Ledger API / gRPC * Updated outdated LedgerAPI / gRPC page * Addressed review comments * Addressed review comments * Remove unnecessary link to error-codes * `Ledger API` changed to `Common Ledger API change` Co-authored-by: pbatko-da <[email protected]>
mergify bot
pushed a commit
that referenced
this pull request
Nov 23, 2021
…-593] (#11798) (#11821) * Updated Ledger API services protobuf definitions CHANGELOG_BEGIN CHANGELOG_END * Adapted Building Applications / Ledger API / gRPC section * Moved Error Codes under Building Applications / Ledger API / gRPC * Small rewording Error codes page * Updated outdated LedgerAPI / gRPC page * Apply suggestions from code review Co-authored-by: pbatko-da <[email protected]> * Moved Error Codes under Building Applications / Ledger API / gRPC * Updated outdated LedgerAPI / gRPC page * Addressed review comments * Addressed review comments * Remove unnecessary link to error-codes * `Ledger API` changed to `Common Ledger API change` Co-authored-by: pbatko-da <[email protected]> Co-authored-by: pbatko-da <[email protected]>
azure-pipelines bot
pushed a commit
that referenced
this pull request
Nov 24, 2021
This PR has been created by a script, which is not very smart and does not have all the context. Please do double-check that the version prefix is correct before merging. @nickchapman-da is in charge of this release. Commit log: ``` bd2a685 Make ACS reader parameters configurable (#11732) 329e609 [Self-service error codes] Group explanations (#11715) 32e9c4b Bump go rules (#11829) 6df7af7 update compat versions for 1.18.0-snapshot.20211117.8399.0.a05a40ae (#11743) 9461702 [DPP-673][Self-service error codes] Split one narrow migration table into multiple narrower ones to fit in the generated pdf's pages. (#11803) 5519184 [DPP-673][Self-service error-codes] Generate error code directory compatible with both pdf and html docs (#11794) 5a2c070 Skip append-only migration tests on each PR (#11816) e6c8229 port #11798 documentation changes to json-api HTTP codes documentation (#11823) 1610d97 LF: parsing interface primitives (#11825) f2aa09c Allow encoded server key files to be in base64 [DPP-761] (#11796) cc3f551 update NOTICES file (#11824) 1bfcbc9 Refactoring for Canton compatibility on PackageServiceErrors (#11812) c4b6a17 [Self-service error codes] Update existing error code references [DPP-593] (#11798) addb2ed Drop Scala 2.13 version guards from Bazel definitions (#11819) 5785bbf Drop LF < 1.14 from supported damlc output versions (#11701) ae8391e LF Parser: handle interface (#11797) faddba4 Increase range for excluded snapshots in compatilbility tests (#11802) f8933d1 Make lookupTemplateChoice return only choices in the template. (#11808) 3e0ac71 update NOTICES file (#11801) 8e31e8e [Self-service error codes] Enabled by default [DPP-691] (#11685) ab520fb Fix es (#11784) 350ad98 Bump Windows postgres (#11804) 2d60ae8 update NOTICES file (#11799) 2d9ee20 [ledger-api-client] - Do not account for deduplication_time as timeout [KVL-1172] (#11791) f334861 LF: Simplify LF Syntax (#11795) cbe9c92 LF: Clean up Ast (#11786) 25e5bbb kvutils - Removed unused setting from conformance tests [KVL-1174] (#11785) cd52f13 Remove `@aherrmann-da` from `CODEOWNERS` (#11792) 9bb12d0 update NOTICES file (#11787) d23d113 Restructure interface desugaring (#11555) 1bb2fc2 LF: Simplify transaction versionning for interface (#11744) 4b59c57 Move select DB logic to JVM [DPP-760] (#11777) 5fb5784 Limit the number of parallel Bazel actions (#11779) a9754fe Write exception reports into the logfile in case of ssl misconfiguration (#11776) 4a8e110 Add missing export of deleteBy from DA.NonEmpty (#11716) 51f646c Add engine tests for interfaces. (#11773) ac57355 Drop Scala 2.12 compatibility layer from //daml-lf/data (#11758) 3b5f8a7 Remove precondition field from TemplateImplements (#11763) 2e789dd [DPP-417][Self-service error codes][Docs] Add more complete information for forking gRPC status codes. (#11739) 4ebdaf5 kvutils - Deprecate deduplicate_until [kvl-1174] (#11765) f5a6302 [participant-integration-api] - Use internal CommandCompletionService [KVL-1172] (#11741) 39a38d3 Update to Java 11 (#11512) 91b4fb9 Backport: Skip protobuf compatibility check for PRs to non-main (#11772) a3556a5 Retry release signature checks (#11771) 8f458d8 [ledger-api] Include the completion offset in the command_service.proto responses [KVL-1171] (#11658) e891180 participant-state: Remove the v1 API. (#11553) 869b805 Bump sandbox acquisition timeout of trigger service tests to 1m (#11764) 4106222 Fix docs regarding deduplication periods [KVL-1194] (#11738) 186ba10 Fix missing encoding of nested maps in typescript bindings (#11746) dd88ba2 kvutils - Backwards looking command deduplication [KVL-1174] (#11634) 43438c6 sandbox: Remove PostgreSQL conformance tests. (#11434) b0a1bf7 More missing error codes (#11749) 3366413 Delete empty scala test library (#11747) 85979b3 Upgrade to Postgres 10 (#11751) 39c5966 Drop aherrman-da from release rotation (#11756) c8ace8b Factor kind projector target into a variable (#11759) e78bfc7 update NOTICES file (#11757) fa76631 Drop 2.12 versioned_scala_deps (#11748) c77e150 [JSON-API] ContractDao JMH benchmarks against PG (#11718) d60cf70 rotate release duty after 1.18.0-snapshot.20211116.8395.0.ccbf7140 (#11734) bb19c0d Drop Scala 2.12 support (#11619) c2d4ea4 Add separate commands for create/fetch/exercise by template/interface. (#11724) 7e4acf9 link to doc detailing gRPC-to-HTTP code mapping (#11742) 7974427 release 1.18.0-snapshot.20211117.8399.0.a05a40ae (#11740) ``` Changelog: ``` - [Daml Compiler] Damlc can only produce Daml-LF 1.14 or newer. Passing aynthing older to `--target` is an error. If you need to produce older versions, use an older SDK. [Ledger API Specification] The Ledger API returns enriched error codes (see https://docs.daml.com/error-codes/self-service/index.html) For backwards-compatibility, a new API flag `--use-pre-1.18-error-codes` is introduced for preserving the legacy behavior for clients that want to migrate incrementally to the changed gRPC status code responses and error details format. ledger-api-client - The default command tracking timeout is no longer influenced by the deprecated deduplication_time as a deduplication period. Previously if no timeout was being set in the command and deduplication_time was set as the deduplication period then the command tracking timeout was the minimum between the deduplication_time and max tracking timeout. [ledger-api] - Include the completion offset in the responses from the command_service.proto - [Integration Kit] v1 of the participant state API is no longer supported. You will need to upgrade to v2. - [Typescript Bindings] Fix an issue where nested maps did not get encoded properly before sent to the JSON API which caused requests to fail with a decoding error on the JSON API. kvutils - The deduplication duration passed in the command is now used for command deduplication, and is no longer always overwritten with the max deduplication duration. The command deduplication duration can still be extended by the committer to account for time skews. ``` CHANGELOG_BEGIN CHANGELOG_END
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.
Updated pre-existing gRPC status code details in Daml docs.
Additionally:
Hints for review: Check the file diffs. Preview: https://htmlpreview.github.io/?https://raw.githubusercontent.com/tudor-da/docs-daml/master/gen/app-dev/grpc/error-codes.html
Pull Request Checklist
CHANGELOG_BEGINandCHANGELOG_ENDtagsNOTE: CI is not automatically run on non-members pull-requests for security
reasons. The reviewer will have to comment with
/AzurePipelines runtotrigger the build.