Share via


ApiEntityBaseContract Class

Definition

API base contract details.

public class ApiEntityBaseContract
type ApiEntityBaseContract = class
Public Class ApiEntityBaseContract
Inheritance
ApiEntityBaseContract
Derived

Constructors

ApiEntityBaseContract()

Initializes a new instance of the ApiEntityBaseContract class.

ApiEntityBaseContract(String, AuthenticationSettingsContract, SubscriptionKeyParameterNamesContract, String, String, String, Nullable<Boolean>, Nullable<Boolean>, String, String, String, Nullable<Boolean>, String, ApiContactInformation, ApiLicenseInformation)

Initializes a new instance of the ApiEntityBaseContract class.

Properties

ApiRevision

Gets or sets describes the revision of the API. If no value is provided, default revision 1 is created

ApiRevisionDescription

Gets or sets description of the API Revision.

ApiType

Gets or sets type of API. Possible values include: 'http', 'soap', 'websocket', 'graphql'

ApiVersion

Gets or sets indicates the version identifier of the API if the API is versioned

ApiVersionDescription

Gets or sets description of the API Version.

ApiVersionSetId

Gets or sets a resource identifier for the related ApiVersionSet.

AuthenticationSettings

Gets or sets collection of authentication settings included into this API.

Contact

Gets or sets contact information for the API.

Description

Gets or sets description of the API. May include HTML formatting tags.

IsCurrent

Gets or sets indicates if API revision is current api revision.

IsOnline

Gets indicates if API revision is accessible via the gateway.

License

Gets or sets license information for the API.

SubscriptionKeyParameterNames

Gets or sets protocols over which API is made available.

SubscriptionRequired

Gets or sets specifies whether an API or Product subscription is required for accessing the API.

TermsOfServiceUrl

Gets or sets A URL to the Terms of Service for the API. MUST be in the format of a URL.

Methods

Validate()

Validate the object.

Applies to