Add conjure endpoint errors #1670

mpritham · 2024-10-29T17:21:50Z

Before this PR

Expand the Conjure specification to support specifying errors that can be thrown on each endpoint.

After this PR

==COMMIT_MSG==
==COMMIT_MSG==

Possible downsides?

changelog-app · 2024-10-29T17:21:55Z

Generate changelog in `changelog/@unreleased`

What do the change types mean?

feature: A new feature of the service.
improvement: An incremental improvement in the functionality or operation of the service.
fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
and external consumers of the service's API (e.g. customer-written software or integrations).
deprecation: Advertises the intention to remove service functionality without any change to the
operation of the service itself.
manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
performing database surgery, ...) at the time of upgrade for it to succeed.
migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?

❗The break and manual task changelog types will result in a major release!
🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
✨ All others will result in a minor version release.

Type

Description

wip: Add conjure endpoint errors

Check the box to generate changelog(s)

Generate changelog entry

conjure-core/src/main/java/com/palantir/conjure/defs/EndpointErrorResolver.java

conjure-api/src/main/conjure/conjure-api.yml

conjure-core/src/main/java/com/palantir/conjure/parser/services/EndpointError.java

conjure-api/src/main/conjure/conjure-api.yml

mpritham · 2024-10-30T19:10:47Z

Back to draft, realized I didn't update the documentation.

conjure-core/src/main/java/com/palantir/conjure/parser/services/EndpointError.java

conjure.schema.json

docs/spec/conjure_definitions.md

carterkozak

Let's cut an rc, nice work!

Invalidated by push of 853ff93

carterkozak · 2024-11-05T16:37:58Z

conjure-api/src/main/conjure/conjure-api.yml

          docs: optional<Documentation>
          deprecated: optional<Documentation>
          markers: list<Type>
          tags: set<string>
      EndpointName:
        alias: string
        docs: Should be in lowerCamelCase.
+      EndpointError:
+        fields:
+          error: TypeName


I think TypeName may be a bit misleading here, there's a fair bit of overlap, but I think perhaps we should flatten the TypeName components (package + name) into this type, and name it ErrorTypeName

carterkozak · 2024-11-05T19:41:05Z

conjure-core/src/main/java/com/palantir/conjure/defs/EndpointErrorResolver.java

+    record ErrorResolutionResult(
+            String errorName, String package_, com.palantir.conjure.spec.ErrorNamespace namespace) {}


Would it make sense to use the new ErrorTypeName type here?

Yep. Updated.

carterkozak · 2024-11-05T19:42:27Z

conjure-api/src/main/conjure/conjure-api.yml

          docs: optional<Documentation>
          deprecated: optional<Documentation>
          markers: list<Type>
          tags: set<string>
      EndpointName:
        alias: string
        docs: Should be in lowerCamelCase.
+      EndpointError:


Can we rename this to ErrorTypeName? It's basically equivalent to TypeName, but for errors

sorry: this type makes sense, but should encapsulate a pair of ErrorTypeName (package/namespace/name) + docs

carterkozak

Thanks!

[skip ci]

Invalidated by push of d0d10d1

mpritham force-pushed the pm/endpoint-error-update branch from e03492f to e9c67be Compare October 30, 2024 15:41

carterkozak reviewed Oct 30, 2024

View reviewed changes

conjure-core/src/main/java/com/palantir/conjure/defs/EndpointErrorResolver.java Outdated Show resolved Hide resolved

carterkozak reviewed Oct 30, 2024

View reviewed changes

conjure-api/src/main/conjure/conjure-api.yml Outdated Show resolved Hide resolved

carterkozak reviewed Oct 30, 2024

View reviewed changes

conjure-core/src/main/java/com/palantir/conjure/parser/services/EndpointError.java Outdated Show resolved Hide resolved

Support endpoint errors

8b4e0ca

mpritham force-pushed the pm/endpoint-error-update branch from e9c67be to f353903 Compare October 30, 2024 18:15

Pritham Marupaka added 2 commits October 30, 2024 14:53

Change errorName to error, and recreate JSON

15c9332

Add error to test-service for JSON validation

caffb0e

mpritham force-pushed the pm/endpoint-error-update branch from f353903 to caffb0e Compare October 30, 2024 18:54

Update conjure.schema.json

eff122c

mpritham marked this pull request as ready for review October 30, 2024 19:05

mpritham commented Oct 30, 2024

View reviewed changes

conjure-api/src/main/conjure/conjure-api.yml Show resolved Hide resolved

mpritham changed the title ~~wip: Add conjure endpoint errors~~ Add conjure endpoint errors Oct 30, 2024

mpritham marked this pull request as draft October 30, 2024 19:10

mpritham commented Oct 30, 2024

View reviewed changes

conjure-core/src/main/java/com/palantir/conjure/parser/services/EndpointError.java Outdated Show resolved Hide resolved

Update EndpointErrorResolver javadoc

d9e37b3

carterkozak reviewed Oct 30, 2024

View reviewed changes

conjure.schema.json Outdated Show resolved Hide resolved

mpritham force-pushed the pm/endpoint-error-update branch from b560b95 to 6f4ab77 Compare October 31, 2024 15:59

mpritham marked this pull request as ready for review October 31, 2024 16:00

mpritham commented Oct 31, 2024

View reviewed changes

docs/spec/conjure_definitions.md Outdated Show resolved Hide resolved

mpritham force-pushed the pm/endpoint-error-update branch 3 times, most recently from 7c06435 to 2c1f0ce Compare October 31, 2024 16:26

Update docs. Review changes

872ce14

mpritham force-pushed the pm/endpoint-error-update branch from 2c1f0ce to 872ce14 Compare October 31, 2024 17:26

mpritham requested a review from bjlaub October 31, 2024 18:06

mpritham added the do not merge label Oct 31, 2024

mpritham marked this pull request as draft October 31, 2024 18:07

carterkozak previously approved these changes Oct 31, 2024

View reviewed changes

Add error namespace to EndpointErrorDefinition in the IR

46d15a8

mpritham force-pushed the pm/endpoint-error-update branch from 853ff93 to 46d15a8 Compare November 5, 2024 16:16

carterkozak reviewed Nov 5, 2024

View reviewed changes

review change

e334bee

mpritham force-pushed the pm/endpoint-error-update branch from 505d890 to e334bee Compare November 5, 2024 18:53

carterkozak reviewed Nov 5, 2024

View reviewed changes

review changes

b7189de

mpritham force-pushed the pm/endpoint-error-update branch from 8b70e0a to b7189de Compare November 5, 2024 19:54

carterkozak previously approved these changes Nov 5, 2024

View reviewed changes

Release 4.50.0-rc2

d0d10d1

[skip ci]

mpritham mentioned this pull request Nov 13, 2024

Support endpoint errors palantir/conjure-java#2401

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add conjure endpoint errors #1670

Add conjure endpoint errors #1670

mpritham commented Oct 29, 2024 •

edited

Loading

changelog-app bot commented Oct 29, 2024

mpritham commented Oct 30, 2024 •

edited

Loading

carterkozak left a comment

carterkozak Nov 5, 2024

carterkozak Nov 5, 2024

mpritham Nov 5, 2024

carterkozak Nov 5, 2024

carterkozak Nov 5, 2024

mpritham Nov 5, 2024

carterkozak left a comment

		record ErrorResolutionResult(
		String errorName, String package_, com.palantir.conjure.spec.ErrorNamespace namespace) {}

Add conjure endpoint errors #1670

Are you sure you want to change the base?

Add conjure endpoint errors #1670

Conversation

mpritham commented Oct 29, 2024 • edited Loading

Before this PR

After this PR

Possible downsides?

changelog-app bot commented Oct 29, 2024

Generate changelog in changelog/@unreleased

mpritham commented Oct 30, 2024 • edited Loading

carterkozak left a comment

Choose a reason for hiding this comment

carterkozak Nov 5, 2024

Choose a reason for hiding this comment

carterkozak Nov 5, 2024

Choose a reason for hiding this comment

mpritham Nov 5, 2024

Choose a reason for hiding this comment

carterkozak Nov 5, 2024

Choose a reason for hiding this comment

carterkozak Nov 5, 2024

Choose a reason for hiding this comment

mpritham Nov 5, 2024

Choose a reason for hiding this comment

carterkozak left a comment

Choose a reason for hiding this comment

mpritham commented Oct 29, 2024 •

edited

Loading

Generate changelog in `changelog/@unreleased`

mpritham commented Oct 30, 2024 •

edited

Loading