@@ -1,5 +1,5 @@
|
||||
---
|
||||
'@backstage/plugin-api-docs-react': major
|
||||
'@backstage/plugin-api-docs-module-protoc-gen-doc': major
|
||||
---
|
||||
|
||||
Adds an api widget to render protoc-gen-doc generated descriptors by the grpc-docs package
|
||||
Added the new `grpcDocsApiWidget` to render `protoc-gen-doc` generated descriptors by the `grpc-docs` package.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# @backstage/plugin-api-docs-react
|
||||
# @backstage/plugin-api-docs-module-protoc-gen-doc
|
||||
|
||||
This package contains ApiDefinitionWidgets for the following projects:
|
||||
|
||||
@@ -7,7 +7,7 @@ This package contains ApiDefinitionWidgets for the following projects:
|
||||
## Setup
|
||||
|
||||
```
|
||||
yarn add @backstage/plugin-api-docs-react
|
||||
yarn add @backstage/plugin-api-docs-module-protoc-gen-doc
|
||||
```
|
||||
|
||||
## Add the GrpcDocsApiWidget to your apis
|
||||
@@ -15,7 +15,7 @@ yarn add @backstage/plugin-api-docs-react
|
||||
Add the widget to your `apiDocsConfigRef`.
|
||||
|
||||
```ts
|
||||
import { grpcDocsApiWidget } from '@backstage/plugin-api-docs-react';
|
||||
import { grpcDocsApiWidget } from '@backstage/plugin-api-docs-module-protoc-gen-doc';
|
||||
// packages/app/apis.ts
|
||||
export const apis: AnyApiFactory[] = [
|
||||
createApiFactory({
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
## API Report File for "@backstage/plugin-api-docs-react"
|
||||
## API Report File for "@backstage/plugin-api-docs-module-protoc-gen-doc"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
+4
-4
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@backstage/plugin-api-docs-react",
|
||||
"description": "Common functionalities for the api-docs-react plugin",
|
||||
"name": "@backstage/plugin-api-docs-module-protoc-gen-doc",
|
||||
"description": "Additional functionalities for the api-docs plugin that renders the output of the protoc-gen-doc",
|
||||
"version": "0.0.0",
|
||||
"main": "src/index.ts",
|
||||
"types": "src/index.ts",
|
||||
@@ -11,13 +11,13 @@
|
||||
"types": "dist/index.d.ts"
|
||||
},
|
||||
"backstage": {
|
||||
"role": "web-library"
|
||||
"role": "frontend-plugin-module"
|
||||
},
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "plugins/api-docs-react"
|
||||
"directory": "plugins/api-docs-module-protoc-gen-doc"
|
||||
},
|
||||
"keywords": [
|
||||
"backstage"
|
||||
Reference in New Issue
Block a user