An ApiEndpoint is a description of an Endpoint for an API.
| Field | Type | Required | Description |
|---|---|---|---|
api_endpoint_id |
::String | ✔️ | The ID of this ApiEndpoint. This is a hash of the method and path. |
api_id |
::String | ✔️ | The ID of the Api this ApiEndpoint belongs to. |
created_at |
Date | ✔️ | Creation timestamp. |
description |
::String | ✔️ | A detailed description of the ApiEndpoint. |
display_name |
::String | ✔️ | A human-readable name for the ApiEndpoint. |
matched |
T.nilable(T::Boolean) | ➖ | Determines if the endpoint was found in the OpenAPI spec associated with the parent Api. |
method |
::String | ✔️ | HTTP verb. |
path |
::String | ✔️ | Path that handles this Api. |
updated_at |
Date | ✔️ | Last update timestamp. |
version_id |
::String | ✔️ | The version ID of the Api this ApiEndpoint belongs to. |
workspace_id |
::String | ✔️ | The workspace ID this ApiEndpoint belongs to. |