Skip to content

fix: update gRPC stream type display labels in ApiEndpointDocumentati… #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexpmule merged 3 commits into from
Jan 12, 2026
Merged

fix: update gRPC stream type display labels in ApiEndpointDocumentati… #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
39d5bf9
fix: update gRPC stream type display labels in ApiEndpointDocumentati…
alexpmule Jan 10, 2026
cc43051
6.1.4
alexpmule Jan 10, 2026
bd6ef29
Merge branch 'master' into W-20359321/grpc-Adapt-api-endpoint-documen…
alexpmule Jan 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@api-components/api-endpoint-documentation",
"description": "A component to generate documentation for a resource from AMF model",
"version": "6.1.3",
"version": "6.1.4",
"license": "Apache-2.0",
"main": "index.js",
"module": "index.js",
Expand Down
12 changes: 9 additions & 3 deletions src/ApiEndpointDocumentationElement.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -555,9 +555,15 @@ export class ApiEndpointDocumentationElement extends AmfHelperMixin(LitElement)
// If it's gRPC, add stream type information
if (isGrpc && typeof this._getGrpcStreamType === 'function') {
operationData.grpcStreamType = this._getGrpcStreamType(op);
operationData.grpcStreamTypeDisplay = typeof this._getGrpcStreamTypeDisplayName === 'function'
? this._getGrpcStreamTypeDisplayName(operationData.grpcStreamType)
: operationData.grpcStreamType;

// Map stream type to simplified display labels (without "streaming")
const labelMap = {
'unary': 'UNARY',
'client_streaming': 'CLIENT',
'server_streaming': 'SERVER',
'bidi_streaming': 'BIDIRECTIONAL'
};
operationData.grpcStreamTypeDisplay = labelMap[operationData.grpcStreamType] || 'UNARY';

// Map stream type to HTTP method for consistent colors
const colorMethodMap = {
Expand Down
4 changes: 2 additions & 2 deletions test/api-endpoint-documentation.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,8 +532,8 @@ describe('ApiEndpointDocumentationElement', () => {

const firstLabel = methodLabels[0];
const labelText = firstLabel.textContent.trim();
// The display name from AmfHelperMixin returns capitalized format (e.g., "Unary", "Client Streaming")
const validGrpcTypes = ['Unary', 'Client Streaming', 'Server Streaming', 'Bidirectional'];
// Simplified labels without "streaming" keyword
const validGrpcTypes = ['UNARY', 'CLIENT', 'SERVER', 'BIDIRECTIONAL'];
const isValidGrpcType = validGrpcTypes.some(type => labelText.includes(type));
assert.isTrue(isValidGrpcType, `should display a valid gRPC stream type, got: ${labelText}`);
});
Expand Down