Share via

ApiProperties interface

Package:
@azure/arm-apicenter

API properties.

Properties

contacts

The set of contacts
customProperties

The custom metadata defined for API catalog entities.
description

Description of the API.
externalDocumentation

The set of external documentation
kind

Kind of API. For example, REST or GraphQL.
license

The license information for the API.
lifecycleStage

Current lifecycle stage of the API. NOTE: This property will not be serialized. It can only be populated by the server.
summary

Short description of the API.
termsOfService

Terms of service for the API.
title

API title.

Property Details

contacts

The set of contacts

contacts?: Contact[]

Property Value

Contact[]

customProperties

The custom metadata defined for API catalog entities.

customProperties?: Record<string, unknown>

Property Value

Record<string, unknown>

description

Description of the API.

description?: string

Property Value

string

externalDocumentation

The set of external documentation

externalDocumentation?: ExternalDocumentation[]

Property Value

ExternalDocumentation[]

kind

Kind of API. For example, REST or GraphQL.

kind: string

Property Value

string

license

The license information for the API.

license?: License

Property Value

License

lifecycleStage

Current lifecycle stage of the API. NOTE: This property will not be serialized. It can only be populated by the server.

lifecycleStage?: string

Property Value

string

summary

Short description of the API.

summary?: string

Property Value

string

termsOfService

Terms of service for the API.

termsOfService?: TermsOfService

Property Value

TermsOfService

title

API title.

title: string

Property Value

string