An Api is representation of a API (a collection of API Endpoints) within the Speakeasy Platform.
| Field | Type | Required | Description |
|---|---|---|---|
apiId |
String | ✔️ | The ID of this Api. This is a human-readable name (subject to change). |
createdAt |
OffsetDateTime | ✔️ | Creation timestamp. |
description |
String | ✔️ | A detailed description of the Api. |
matched |
Optional<Boolean> | ➖ | Determines if all the endpoints within the Api are found in the OpenAPI spec associated with the Api. |
metaData |
Map<String, List\<String>> | ➖ | A set of values associated with a meta_data key. This field is only set on get requests. |
updatedAt |
OffsetDateTime | ✔️ | Last update timestamp. |
versionId |
String | ✔️ | The version ID of this Api. This is semantic version identifier. |
workspaceId |
String | ✔️ | The workspace ID this Api belongs to. |