Backstage
Docs
Github
Preparing search index...
@backstage/plugin-techdocs-react
index
TechDocsApi
Interface TechDocsApi
API to talk to techdocs-backend.
interface
TechDocsApi
{
getApiOrigin
()
:
Promise
<
string
>
;
getCookie
()
:
Promise
<
{
expiresAt
:
string
}
>
;
getEntityMetadata
(
entityId
:
CompoundEntityRef
,
)
:
Promise
<
TechDocsEntityMetadata
>
;
getTechDocsMetadata
(
entityId
:
CompoundEntityRef
)
:
Promise
<
TechDocsMetadata
>
;
}
Implemented by
TechDocsClient
Index
Methods
get
Api
Origin
get
Cookie
get
Entity
Metadata
get
Tech
Docs
Metadata
Methods
get
Api
Origin
getApiOrigin
()
:
Promise
<
string
>
Returns
Promise
<
string
>
get
Cookie
getCookie
()
:
Promise
<
{
expiresAt
:
string
}
>
Returns
Promise
<
{
expiresAt
:
string
}
>
get
Entity
Metadata
getEntityMetadata
(
entityId
:
CompoundEntityRef
)
:
Promise
<
TechDocsEntityMetadata
>
Parameters
entityId
:
CompoundEntityRef
Returns
Promise
<
TechDocsEntityMetadata
>
get
Tech
Docs
Metadata
getTechDocsMetadata
(
entityId
:
CompoundEntityRef
)
:
Promise
<
TechDocsMetadata
>
Parameters
entityId
:
CompoundEntityRef
Returns
Promise
<
TechDocsMetadata
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
get
Api
Origin
get
Cookie
get
Entity
Metadata
get
Tech
Docs
Metadata
Docs
Github
Backstage
Loading...
API to talk to techdocs-backend.