Skip to content

Latest commit

 

History

History
17 lines (13 loc) · 4.2 KB

File metadata and controls

17 lines (13 loc) · 4.2 KB

Api

An Api is representation of a API (a collection of API Endpoints) within the Speakeasy Platform.

Fields

Field Type Required Description
api_id ::String ✔️ The ID of this Api. This is a human-readable name (subject to change).
created_at Date ✔️ Creation timestamp.
description ::String ✔️ A detailed description of the Api.
matched T.nilable(T::Boolean) Determines if all the endpoints within the Api are found in the OpenAPI spec associated with the Api.
meta_data T::Hash[Symbol, T::Array<::String>] A set of values associated with a meta_data key. This field is only set on get requests.
updated_at Date ✔️ Last update timestamp.
version_id ::String ✔️ The version ID of this Api. This is semantic version identifier.
workspace_id ::String ✔️ The workspace ID this Api belongs to.