Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ dist/
!demo/apis.json
!demo/avro.json
!demo/avro2.json
!demo/grpc-test.json

.idea/
.codegenie/
.codegenie/
4,490 changes: 4,490 additions & 0 deletions demo/grpc-test.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions demo/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ class ApiDemo extends ApiDemoPage {

_apiListTemplate() {
return [
['grpc-test', 'GRPC test'],
['shopper-products', 'shopper-products'],
['demo-api', 'Demo API'],
['avro', 'avro'],
Expand Down
39 changes: 30 additions & 9 deletions package-lock.json

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

5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@api-components/api-type-document",
"description": "A documentation table for type (resource) properties. Works with AMF data model",
"version": "4.2.34",
"version": "4.2.35",
"license": "Apache-2.0",
"main": "index.js",
"module": "index.js",
Expand All @@ -26,9 +26,10 @@
},
"dependencies": {
"@advanced-rest-client/arc-marked": "^1.1.0",
"@advanced-rest-client/icons": "^4.0.2",
"@advanced-rest-client/markdown-styles": "^3.1.4",
"@anypoint-web-components/anypoint-button": "^1.2.3",
"@api-components/amf-helper-mixin": "^4.5.29",
"@api-components/amf-helper-mixin": "^4.5.34",
"@api-components/api-annotation-document": "^4.1.0",
"@api-components/api-resource-example-document": "^4.3.3",
"@open-wc/dedupe-mixin": "^1.3.0",
Expand Down
26 changes: 26 additions & 0 deletions src/ApiTypeDocument.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,23 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
selectedMediaType: number;
// The type after it has been resolved.
_resolvedType: Object;
/**
* Computed properties for object types.
* This is a reactive property that is recalculated when type, amf, or renderReadOnly changes.
*/
_computedProperties: any[] | undefined;
/**
* Resolved type for examples with all link-target references resolved
*/
_resolvedExampleType: Object | undefined;
/**
* Whether to show the examples section
*/
_showExamples: boolean | undefined;
/**
* Effective media type for examples
*/
_exampleMediaType: string | undefined;
/**
* Should be set if described properties has a parent type.
* This is used when recursively iterating over properties.
Expand Down Expand Up @@ -242,6 +259,15 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
*/
_computeProperties(item: any): any[]|undefined;

/**
* Deeply resolves link-target references in a type and its nested properties.
* This is essential for rendering complete examples with nested objects.
*
* @param type The type to resolve
* @returns The type with all link-target references resolved
*/
_deepResolveType(type: any): any|undefined;

/**
* Computes list values for `andTypes` property.
* @param items List of OAS' "and" properties
Expand Down
Loading
Loading