0.1.8 • Published 10 months ago

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

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
10 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
grpc-docs
@everything-registry/sub-chunk-109
0.1.8

10 months ago

0.0.0-nightly-20241015023351

10 months ago

0.0.0-nightly-20241004023131

10 months ago

0.0.0-nightly-20241003023252

10 months ago

0.0.0-nightly-20241010023300

10 months ago

0.0.0-nightly-20241014023245

10 months ago

0.0.0-nightly-20241002023110

10 months ago

0.0.0-nightly-20241007023251

10 months ago

0.0.0-nightly-20241009023248

10 months ago

0.0.0-nightly-20241006023330

10 months ago

0.1.8-next.0

10 months ago

0.0.0-nightly-20241011023216

10 months ago

0.0.0-nightly-20241008023419

10 months ago

0.0.0-nightly-20241005023131

10 months ago

0.0.0-nightly-20241013023515

10 months ago

0.0.0-nightly-20241012023025

10 months ago

0.0.0-nightly-20240616021858

1 year ago

0.1.7-next.0

1 year ago

0.0.0-nightly-20240618021721

1 year ago

0.0.0-nightly-20240613021705

1 year ago

0.0.0-nightly-20240615021640

1 year ago

0.0.0-nightly-20240617021823

1 year ago

0.0.0-nightly-20240614021713

1 year ago

0.1.7

1 year ago

0.0.0-nightly-20240612021718

1 year ago

0.1.6

1 year ago

0.0.0-nightly-20240218021152

1 year ago

0.0.0-nightly-20240220020934

1 year ago

0.0.0-nightly-20240219021126

1 year ago

0.0.0-nightly-20240217020958

1 year ago

0.0.0-nightly-20240216021020

1 year ago

0.0.0-nightly-20240215021042

1 year ago

0.0.0-nightly-20240214021031

1 year ago

0.0.0-nightly-20240213021024

1 year ago

0.0.0-nightly-20240212021120

1 year ago

0.0.0-nightly-20240211021214

1 year ago

0.0.0-nightly-20240210020848

1 year ago

0.0.0-nightly-20240209021004

1 year ago

0.0.0-nightly-20240208020940

1 year ago

0.1.6-next.0

1 year ago

0.0.0-nightly-20240207020916

1 year ago

0.0.0-nightly-20240206021010

1 year ago

0.0.0-nightly-20240203020827

1 year ago

0.0.0-nightly-20240205021531

1 year ago

0.0.0-nightly-20240204021320

1 year ago

0.0.0-nightly-20231101021742

2 years ago

0.0.0-nightly-20230829023907

2 years ago

0.1.3-next.1

2 years ago

0.1.3-next.0

2 years ago

0.0.0-nightly-20231027021338

2 years ago

0.0.0-nightly-20231020021216

2 years ago

0.0.0-nightly-20231021021049

2 years ago

0.0.0-nightly-20231031021349

2 years ago

0.0.0-nightly-20230910021151

2 years ago

0.0.0-nightly-20230912021137

2 years ago

0.0.0-nightly-20231104021304

2 years ago

0.0.0-nightly-20231105021421

2 years ago

0.0.0-nightly-20231102021349

2 years ago

0.0.0-nightly-20230828021110

2 years ago

0.0.0-nightly-20230822021041

2 years ago

0.0.0-nightly-20230904021056

2 years ago

0.0.0-nightly-20230824021031

2 years ago

0.0.0-nightly-20231012021036

2 years ago

0.0.0-nightly-20230919021144

2 years ago

0.0.0-nightly-20230913021415

2 years ago

0.0.0-nightly-20230823021346

2 years ago

0.0.0-nightly-20230914021123

2 years ago

0.0.0-nightly-20231014021041

2 years ago

0.0.0-nightly-20231028021254

2 years ago

0.0.0-nightly-20230830021355

2 years ago

0.0.0-nightly-20230917021217

2 years ago

0.0.0-nightly-20230911021129

2 years ago

0.0.0-nightly-20230906021121

2 years ago

0.0.0-nightly-20231024021502

2 years ago

0.0.0-nightly-20230819020703

2 years ago

0.0.0-nightly-20230826020825

2 years ago

0.0.0-nightly-20231022021426

2 years ago

0.0.0-nightly-20231103021306

2 years ago

0.0.0-nightly-20230909020837

2 years ago

0.1.5-next.0

2 years ago

0.0.0-nightly-20230831021048

2 years ago

0.0.0-nightly-20231017021237

2 years ago

0.0.0-nightly-20231107021551

2 years ago

0.0.0-nightly-20231026021300

2 years ago

0.0.0-nightly-20230908021043

2 years ago

0.0.0-nightly-20231019021320

2 years ago

0.0.0-nightly-20230918021106

2 years ago

0.0.0-nightly-20230907021058

2 years ago

0.0.0-nightly-20230821021039

2 years ago

0.0.0-nightly-20231030021305

2 years ago

0.1.4

2 years ago

0.1.3

2 years ago

0.0.0-nightly-20230915021143

2 years ago

0.0.0-nightly-20230825021043

2 years ago

0.1.5

2 years ago

0.0.0-nightly-20230820020928

2 years ago

0.0.0-nightly-20231016021307

2 years ago

0.0.0-nightly-20230827021131

2 years ago

0.0.0-nightly-20230903021204

2 years ago

0.0.0-nightly-20230916020933

2 years ago

0.0.0-nightly-20231025021459

2 years ago

0.0.0-nightly-20230905021132

2 years ago

0.0.0-nightly-20231029021439

2 years ago

0.0.0-nightly-20231015021342

2 years ago

0.0.0-nightly-20230902020952

2 years ago

0.0.0-nightly-20230901021559

2 years ago

0.0.0-nightly-20231013021322

2 years ago

0.0.0-nightly-20231106021619

2 years ago

0.0.0-nightly-20231023021320

2 years ago

0.0.0-nightly-20230418021803

2 years ago

0.0.0-nightly-20230411021817

2 years ago

0.0.0-nightly-20230414021741

2 years ago

0.1.2

2 years ago

0.0.0-nightly-20230415021832

2 years ago

0.0.0-nightly-20230413021854

2 years ago

0.0.0-nightly-20230410021801

2 years ago

0.0.0-nightly-20230416022105

2 years ago

0.0.0-nightly-20230412021859

2 years ago

0.0.0-nightly-20230417021847

2 years ago

0.0.0-nightly-20230329022804

2 years ago

0.0.0-nightly-20230330022134

2 years ago

0.0.0-nightly-20230401021836

2 years ago

0.0.0-nightly-20230404022000

2 years ago

0.0.0-nightly-20230403021721

2 years ago

0.0.0-nightly-20230408021638

2 years ago

0.0.0-nightly-20230407021743

2 years ago

0.1.1

2 years ago

0.0.0-nightly-20230331022104

2 years ago

0.1.2-next.0

2 years ago

0.0.0-nightly-20230405021251

2 years ago

0.0.0-nightly-20230409021820

2 years ago

0.0.0-nightly-20230402021941

2 years ago

0.0.0-nightly-20230406021747

2 years ago

0.1.0

3 years ago

0.0.0-nightly-20220719025614

3 years ago

0.0.0-nightly-20220718024938

3 years ago

0.0.0-nightly-20220717025420

3 years ago

0.0.0-nightly-20220716024822

3 years ago

0.0.0-nightly-20220715025616

3 years ago

0.0.0-nightly-20220714025131

3 years ago

0.0.0-nightly-20220713025014

3 years ago

0.0.0-nightly-20220712025512

3 years ago

0.0.0-nightly-20220711024820

3 years ago

0.0.0-nightly-20220710025142

3 years ago

0.0.0-nightly-20220709024234

3 years ago

0.0.0-nightly-20220708025041

3 years ago

0.0.0-nightly-20220707025354

3 years ago

0.0.0-nightly-20220706025229

3 years ago

0.0.0-nightly-20220705025009

3 years ago

0.0.0-nightly-20220704025427

3 years ago

0.0.0-nightly-20220703024846

3 years ago

0.0.0-nightly-20220702024817

3 years ago

0.0.0-nightly-20220701025459

3 years ago

0.0.0-nightly-20220630025025

3 years ago

0.0.0-nightly-20220629024959

3 years ago

0.0.0-nightly-20220628024947

3 years ago

0.0.0-nightly-20220627024939

3 years ago

0.0.0-nightly-20220626024947

3 years ago

0.0.0-nightly-20220625024815

3 years ago

0.0.0-nightly-20220624024747

3 years ago

0.0.0-nightly-20220623024748

3 years ago

0.0.0-nightly-20220622024934

3 years ago

0.1.0-next.0

3 years ago

0.0.0-nightly-20220621024649

3 years ago

0.0.0-nightly-20220620024353

3 years ago

0.0.0-nightly-20220619024941

3 years ago

0.0.0-nightly-20220618024418

3 years ago

0.0.0-nightly-20220617024804

3 years ago

0.0.0-nightly-20220616024850

3 years ago