0.1.6 • Published 3 months ago

@backstage/plugin-api-docs-module-protoc-gen-doc v0.1.6

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
3 months ago

@backstage/plugin-api-docs-module-protoc-gen-doc

This package contains ApiDefinitionWidgets for the following projects:

Setup

yarn add @backstage/plugin-api-docs-module-protoc-gen-doc

Add the GrpcDocsApiWidget to your apis

Add the widget to your apiDocsConfigRef.

import { grpcDocsApiWidget } from '@backstage/plugin-api-docs-module-protoc-gen-doc';
// packages/app/apis.ts
export const apis: AnyApiFactory[] = [
  createApiFactory({
    api: apiDocsConfigRef,
    deps: {},
    factory: () => {
      // load the default widgets
      const definitionWidgets = defaultDefinitionWidgets();
      // add the grpc-docs api widget to the definition widgets
      definitionWidgets.push(grpcDocsApiWidget);
      return {
        getApiDefinitionWidget: (apiEntity: ApiEntity) => {
          // find the widget for the type of api entity
          return definitionWidgets.find(d => d.type === apiEntity.spec.type);
        },
      };
    },
  }),
];

Set the type in your api entities

This widget will render the generated protoc-gen-doc descriptors with the grpc-docs package. For this make sure you use the grpc-docs as the type in the API catalog file.

apiVersion: backstage.io/v1alpha1
kind: API
metadata:
  name: hello-world
  description: Hello World example for gRPC
spec:
  type: grpc-docs
  lifecycle: deprecated
  owner: foo
  definition:
    $text: https://fetch-my-json.com/awesome-resource.json
backstage
@types/reactgrpc-docs
@everything-registry/sub-chunk-109
0.1.6

3 months ago

0.0.0-nightly-20240218021152

3 months ago

0.0.0-nightly-20240220020934

3 months ago

0.0.0-nightly-20240219021126

3 months ago

0.0.0-nightly-20240217020958

3 months ago

0.0.0-nightly-20240216021020

3 months ago

0.0.0-nightly-20240215021042

3 months ago

0.0.0-nightly-20240214021031

3 months ago

0.0.0-nightly-20240213021024

3 months ago

0.0.0-nightly-20240212021120

3 months ago

0.0.0-nightly-20240211021214

3 months ago

0.0.0-nightly-20240210020848

3 months ago

0.0.0-nightly-20240209021004

3 months ago

0.0.0-nightly-20240208020940

3 months ago

0.1.6-next.0

3 months ago

0.0.0-nightly-20240207020916

3 months ago

0.0.0-nightly-20240206021010

3 months ago

0.0.0-nightly-20240203020827

3 months ago

0.0.0-nightly-20240205021531

3 months ago

0.0.0-nightly-20240204021320

3 months ago

0.0.0-nightly-20231101021742

6 months ago

0.0.0-nightly-20230829023907

8 months ago

0.1.3-next.1

8 months ago

0.1.3-next.0

9 months ago

0.0.0-nightly-20231027021338

6 months ago

0.0.0-nightly-20231020021216

7 months ago

0.0.0-nightly-20231021021049

7 months ago

0.0.0-nightly-20231031021349

6 months ago

0.0.0-nightly-20230910021151

8 months ago

0.0.0-nightly-20230912021137

8 months ago

0.0.0-nightly-20231104021304

6 months ago

0.0.0-nightly-20231105021421

6 months ago

0.0.0-nightly-20231102021349

6 months ago

0.0.0-nightly-20230828021110

8 months ago

0.0.0-nightly-20230822021041

9 months ago

0.0.0-nightly-20230904021056

8 months ago

0.0.0-nightly-20230824021031

9 months ago

0.0.0-nightly-20231012021036

7 months ago

0.0.0-nightly-20230919021144

8 months ago

0.0.0-nightly-20230913021415

8 months ago

0.0.0-nightly-20230823021346

9 months ago

0.0.0-nightly-20230914021123

8 months ago

0.0.0-nightly-20231014021041

7 months ago

0.0.0-nightly-20231028021254

6 months ago

0.0.0-nightly-20230830021355

8 months ago

0.0.0-nightly-20230917021217

8 months ago

0.0.0-nightly-20230911021129

8 months ago

0.0.0-nightly-20230906021121

8 months ago

0.0.0-nightly-20231024021502

7 months ago

0.0.0-nightly-20230819020703

9 months ago

0.0.0-nightly-20230826020825

9 months ago

0.0.0-nightly-20231022021426

7 months ago

0.0.0-nightly-20231103021306

6 months ago

0.0.0-nightly-20230909020837

8 months ago

0.1.5-next.0

7 months ago

0.0.0-nightly-20230831021048

8 months ago

0.0.0-nightly-20231017021237

7 months ago

0.0.0-nightly-20231107021551

6 months ago

0.0.0-nightly-20231026021300

7 months ago

0.0.0-nightly-20230908021043

8 months ago

0.0.0-nightly-20231019021320

7 months ago

0.0.0-nightly-20230918021106

8 months ago

0.0.0-nightly-20230907021058

8 months ago

0.0.0-nightly-20230821021039

9 months ago

0.0.0-nightly-20231030021305

6 months ago

0.1.4

7 months ago

0.1.3

8 months ago

0.0.0-nightly-20230915021143

8 months ago

0.0.0-nightly-20230825021043

9 months ago

0.1.5

6 months ago

0.0.0-nightly-20230820020928

9 months ago

0.0.0-nightly-20231016021307

7 months ago

0.0.0-nightly-20230827021131

9 months ago

0.0.0-nightly-20230903021204

8 months ago

0.0.0-nightly-20230916020933

8 months ago

0.0.0-nightly-20231025021459

7 months ago

0.0.0-nightly-20230905021132

8 months ago

0.0.0-nightly-20231029021439

6 months ago

0.0.0-nightly-20231015021342

7 months ago

0.0.0-nightly-20230902020952

8 months ago

0.0.0-nightly-20230901021559

8 months ago

0.0.0-nightly-20231013021322

7 months ago

0.0.0-nightly-20231106021619

6 months ago

0.0.0-nightly-20231023021320

7 months ago

0.0.0-nightly-20230418021803

1 year ago

0.0.0-nightly-20230411021817

1 year ago

0.0.0-nightly-20230414021741

1 year ago

0.1.2

1 year ago

0.0.0-nightly-20230415021832

1 year ago

0.0.0-nightly-20230413021854

1 year ago

0.0.0-nightly-20230410021801

1 year ago

0.0.0-nightly-20230416022105

1 year ago

0.0.0-nightly-20230412021859

1 year ago

0.0.0-nightly-20230417021847

1 year ago

0.0.0-nightly-20230329022804

1 year ago

0.0.0-nightly-20230330022134

1 year ago

0.0.0-nightly-20230401021836

1 year ago

0.0.0-nightly-20230404022000

1 year ago

0.0.0-nightly-20230403021721

1 year ago

0.0.0-nightly-20230408021638

1 year ago

0.0.0-nightly-20230407021743

1 year ago

0.1.1

1 year ago

0.0.0-nightly-20230331022104

1 year ago

0.1.2-next.0

1 year ago

0.0.0-nightly-20230405021251

1 year ago

0.0.0-nightly-20230409021820

1 year ago

0.0.0-nightly-20230402021941

1 year ago

0.0.0-nightly-20230406021747

1 year ago

0.1.0

2 years ago

0.0.0-nightly-20220719025614

2 years ago

0.0.0-nightly-20220718024938

2 years ago

0.0.0-nightly-20220717025420

2 years ago

0.0.0-nightly-20220716024822

2 years ago

0.0.0-nightly-20220715025616

2 years ago

0.0.0-nightly-20220714025131

2 years ago

0.0.0-nightly-20220713025014

2 years ago

0.0.0-nightly-20220712025512

2 years ago

0.0.0-nightly-20220711024820

2 years ago

0.0.0-nightly-20220710025142

2 years ago

0.0.0-nightly-20220709024234

2 years ago

0.0.0-nightly-20220708025041

2 years ago

0.0.0-nightly-20220707025354

2 years ago

0.0.0-nightly-20220706025229

2 years ago

0.0.0-nightly-20220705025009

2 years ago

0.0.0-nightly-20220704025427

2 years ago

0.0.0-nightly-20220703024846

2 years ago

0.0.0-nightly-20220702024817

2 years ago

0.0.0-nightly-20220701025459

2 years ago

0.0.0-nightly-20220630025025

2 years ago

0.0.0-nightly-20220629024959

2 years ago

0.0.0-nightly-20220628024947

2 years ago

0.0.0-nightly-20220627024939

2 years ago

0.0.0-nightly-20220626024947

2 years ago

0.0.0-nightly-20220625024815

2 years ago

0.0.0-nightly-20220624024747

2 years ago

0.0.0-nightly-20220623024748

2 years ago

0.0.0-nightly-20220622024934

2 years ago

0.1.0-next.0

2 years ago

0.0.0-nightly-20220621024649

2 years ago

0.0.0-nightly-20220620024353

2 years ago

0.0.0-nightly-20220619024941

2 years ago

0.0.0-nightly-20220618024418

2 years ago

0.0.0-nightly-20220617024804

2 years ago

0.0.0-nightly-20220616024850

2 years ago