ApiProperties interface

Пакет:

@azure/arm-apicenter

Свойства API.

Свойства

contacts	Набор контактов
customProperties	Пользовательские метаданные, определенные для сущностей каталога API.
description	Описание API.
externalDocumentation	Набор внешней документации
kind	Вид API. Например, REST или GraphQL.
license	Сведения о лицензии для API.
lifecycleStage	Текущий этап жизненного цикла API. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
summary	Краткое описание API.
termsOfService	Условия обслуживания ДЛЯ API.
title	Заголовок API.

Сведения о свойстве

contacts

Набор контактов

contacts?: Contact[]

Значение свойства

Contact[]

customProperties

Пользовательские метаданные, определенные для сущностей каталога API.

customProperties?: Record<string, unknown>

Значение свойства

Record<string, unknown>

description

Описание API.

description?: string

Значение свойства

string

externalDocumentation

Набор внешней документации

externalDocumentation?: ExternalDocumentation[]

Значение свойства

ExternalDocumentation[]

kind

Вид API. Например, REST или GraphQL.

kind: string

Значение свойства

string

license

Сведения о лицензии для API.

license?: License

Значение свойства

License

lifecycleStage

Текущий этап жизненного цикла API. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

lifecycleStage?: string

Значение свойства

string

summary

Краткое описание API.

summary?: string

Значение свойства

string

termsOfService

Условия обслуживания ДЛЯ API.

termsOfService?: TermsOfService

Значение свойства

TermsOfService

title

Заголовок API.

title: string

Значение свойства

string