Skip to content

Commit b936d21

Browse files
docs: add source file links to readme (#273)
1 parent 6e934c0 commit b936d21

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ The asynchronous client supports the same options as the synchronous one, except
163163

164164
The SDK throws custom unchecked exception types:
165165

166-
- `OrbServiceException`: Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:
166+
- [`OrbServiceException`](orb-java-core/src/main/kotlin/com/withorb/api/errors/OrbServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:
167167

168168
| Status | Exception |
169169
| ------ | ------------------------------- |
@@ -176,11 +176,11 @@ The SDK throws custom unchecked exception types:
176176
| 5xx | `InternalServerException` |
177177
| others | `UnexpectedStatusCodeException` |
178178

179-
- `OrbIoException`: I/O networking errors.
179+
- [`OrbIoException`](orb-java-core/src/main/kotlin/com/withorb/api/errors/OrbIoException.kt): I/O networking errors.
180180

181-
- `OrbInvalidDataException`: Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.
181+
- [`OrbInvalidDataException`](orb-java-core/src/main/kotlin/com/withorb/api/errors/OrbInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.
182182

183-
- `OrbException`: Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.
183+
- [`OrbException`](orb-java-core/src/main/kotlin/com/withorb/api/errors/OrbException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.
184184

185185
## Pagination
186186

@@ -357,7 +357,7 @@ CustomerCreateParams params = CustomerCreateParams.builder()
357357

358358
These can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods. You can also set undocumented parameters on nested headers, query params, or body classes using the `putAdditionalProperty` method. These properties can be accessed on the built object later using the `_additionalProperties()` method.
359359

360-
To set a documented parameter or property to an undocumented or not yet supported _value_, pass a `JsonValue` object to its setter:
360+
To set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](orb-java-core/src/main/kotlin/com/withorb/api/core/JsonValue.kt) object to its setter:
361361

362362
```java
363363
import com.withorb.api.core.JsonValue;
@@ -427,7 +427,7 @@ if (email.isMissing()) {
427427

428428
In rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.
429429

430-
By default, the SDK will not throw an exception in this case. It will throw `OrbInvalidDataException` only if you directly access the property.
430+
By default, the SDK will not throw an exception in this case. It will throw [`OrbInvalidDataException`](orb-java-core/src/main/kotlin/com/withorb/api/errors/OrbInvalidDataException.kt) only if you directly access the property.
431431

432432
If you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:
433433

0 commit comments

Comments
 (0)