Contents

# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.

# typed: true
# frozen_string_literal: true


module OpenApiSDK
  module Shared
  
    # An ApiEndpoint is a description of an Endpoint for an API.
    class ApiEndpointInput < ::OpenApiSDK::Utils::FieldAugmented
      extend T::Sig

      # The ID of this ApiEndpoint. This is a hash of the method and path.
      field :api_endpoint_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('api_endpoint_id') } }
      # A detailed description of the ApiEndpoint.
      field :description, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
      # A human-readable name for the ApiEndpoint.
      field :display_name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('display_name') } }
      # HTTP verb.
      field :method, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('method') } }
      # Path that handles this Api.
      field :path, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('path') } }
      # The version ID of the Api this ApiEndpoint belongs to.
      field :version_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('version_id') } }


      sig { params(api_endpoint_id: ::String, description: ::String, display_name: ::String, method: ::String, path: ::String, version_id: ::String).void }
      def initialize(api_endpoint_id: nil, description: nil, display_name: nil, method: nil, path: nil, version_id: nil)
        @api_endpoint_id = api_endpoint_id
        @description = description
        @display_name = display_name
        @method = method
        @path = path
        @version_id = version_id
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
speakeasy_client_sdk_ruby-4.2.24	lib/open_api_sdk/models/shared/apiendpoint_input.rb