Class Api

An API is simple container for an API Specification. For more information, see API Gateway Concepts.

Inheritance

object

Api

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ApigatewayService.Models

Assembly: OCI.DotNetSDK.Apigateway.dll

Syntax

public class Api

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment in which the resource is created.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the resource.

Remarks

Required

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type

Description

string

A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are: 'New' for just updated API Specifications 'Validating' for a document which is being validated. 'Valid' the document has been validated without any errors or warnings 'Warning' the document has been validated and contains warnings 'Error' the document has been validated and contains errors 'Failed' the document validation failed 'Canceled' the document validation was canceled For other states it may provide more details like actionable information.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Api.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Api.LifecycleStateEnum?	The current state of the API.

SpecificationType

Declaration

[JsonProperty(PropertyName = "specificationType")]
public string SpecificationType { get; set; }

Property Value

Type	Description
string	Type of API Specification file.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time this resource was created. An RFC3339 formatted datetime string.

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The time this resource was last updated. An RFC3339 formatted datetime string.

ValidationResults

Declaration

[JsonProperty(PropertyName = "validationResults")]
public List<ApiValidationResult> ValidationResults { get; set; }

Property Value

Type	Description
List<ApiValidationResult>	Status of each feature available from the API.