Skip to content

Commit a19163c

Browse files
docs: add source file links to readme (#239)
1 parent 166a038 commit a19163c

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
@@ -153,7 +153,7 @@ The asynchronous client supports the same options as the synchronous one, except
153153

154154
The SDK throws custom unchecked exception types:
155155

156-
- `OnebusawaySdkServiceException`: Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:
156+
- [`OnebusawaySdkServiceException`](onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/errors/OnebusawaySdkServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:
157157

158158
| Status | Exception |
159159
| ------ | ------------------------------- |
@@ -166,11 +166,11 @@ The SDK throws custom unchecked exception types:
166166
| 5xx | `InternalServerException` |
167167
| others | `UnexpectedStatusCodeException` |
168168

169-
- `OnebusawaySdkIoException`: I/O networking errors.
169+
- [`OnebusawaySdkIoException`](onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/errors/OnebusawaySdkIoException.kt): I/O networking errors.
170170

171-
- `OnebusawaySdkInvalidDataException`: 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.
171+
- [`OnebusawaySdkInvalidDataException`](onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/errors/OnebusawaySdkInvalidDataException.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.
172172

173-
- `OnebusawaySdkException`: 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.
173+
- [`OnebusawaySdkException`](onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/errors/OnebusawaySdkException.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.
174174

175175
## Logging
176176

@@ -285,7 +285,7 @@ val params: CurrentTimeRetrieveParams = CurrentTimeRetrieveParams.builder()
285285

286286
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.
287287

288-
To set a documented parameter or property to an undocumented or not yet supported _value_, pass a `JsonValue` object to its setter:
288+
To set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/core/JsonValue.kt) object to its setter:
289289

290290
```kotlin
291291
import org.onebusaway.models.CurrentTimeRetrieveParams
@@ -340,7 +340,7 @@ if (field.isMissing()) {
340340

341341
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.
342342

343-
By default, the SDK will not throw an exception in this case. It will throw `OnebusawaySdkInvalidDataException` only if you directly access the property.
343+
By default, the SDK will not throw an exception in this case. It will throw [`OnebusawaySdkInvalidDataException`](onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/errors/OnebusawaySdkInvalidDataException.kt) only if you directly access the property.
344344

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

0 commit comments

Comments
 (0)