ApiProperties interface

Paket:

@azure/arm-apicenter

API-egenskaper.

Egenskaper

contacts	Uppsättningen kontakter
customProperties	Anpassade metadata som definierats för API-katalogentiteter.
description	Beskrivning av API:et.
externalDocumentation	Uppsättningen med extern dokumentation
kind	Typ av API. Till exempel REST eller GraphQL.
license	Licensinformationen för API:et.
lifecycleStage	Aktuell livscykelfas för API:et. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
summary	Kort beskrivning av API:et.
termsOfService	Användningsvillkor för API:et.
title	API-rubrik.

Egenskapsinformation

contacts

Uppsättningen kontakter

contacts?: Contact[]

Egenskapsvärde

Contact[]

customProperties

Anpassade metadata som definierats för API-katalogentiteter.

customProperties?: Record<string, unknown>

Egenskapsvärde

Record<string, unknown>

description

Beskrivning av API:et.

description?: string

Egenskapsvärde

string

externalDocumentation

Uppsättningen med extern dokumentation

externalDocumentation?: ExternalDocumentation[]

Egenskapsvärde

ExternalDocumentation[]

kind

Typ av API. Till exempel REST eller GraphQL.

kind: string

Egenskapsvärde

string

license

Licensinformationen för API:et.

license?: License

Egenskapsvärde

License

lifecycleStage

Aktuell livscykelfas för API:et. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

lifecycleStage?: string

Egenskapsvärde

string

summary

Kort beskrivning av API:et.

summary?: string

Egenskapsvärde

string

termsOfService

Användningsvillkor för API:et.

termsOfService?: TermsOfService

Egenskapsvärde

TermsOfService

title

API-rubrik.

title: string

Egenskapsvärde

string