An ApiEndpoint is a description of an Endpoint for an API.
| Field | Type | Required | Description |
|---|---|---|---|
apiEndpointId |
string | ✔️ | The ID of this ApiEndpoint. This is a hash of the method and path. |
apiId |
string | ✔️ | The ID of the Api this ApiEndpoint belongs to. |
createdAt |
\DateTime | ✔️ | Creation timestamp. |
description |
string | ✔️ | A detailed description of the ApiEndpoint. |
displayName |
string | ✔️ | A human-readable name for the ApiEndpoint. |
method |
string | ✔️ | HTTP verb. |
path |
string | ✔️ | Path that handles this Api. |
updatedAt |
\DateTime | ✔️ | Last update timestamp. |
versionId |
string | ✔️ | The version ID of the Api this ApiEndpoint belongs to. |
workspaceId |
string | ✔️ | The workspace ID this ApiEndpoint belongs to. |
matched |
?bool | ➖ | Determines if the endpoint was found in the OpenAPI spec associated with the parent Api. |