Skip to content
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.

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

docs: enhance API docs with information about results of code generation with generateFromString #967

Closed
wants to merge 12 commits into from

Conversation

chinma-yyy
Copy link

Description

  • Described a type of TemplateRenderMetadata
  • Described a type of TemplateRenderResult

Related issue(s)

Resolves #507

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@derberg derberg changed the title feat: enhance API docs with information about results of code generation with generateFromString docs: enhance API docs with information about results of code generation with generateFromString Jun 21, 2023
@derberg
Copy link
Member

derberg commented Jun 21, 2023

changed to docs as we do not have to trigger release

@derberg
Copy link
Member

derberg commented Jun 21, 2023

@Florence-Njeri @pratik2315 folks we need your approval to merge

@Florence-Njeri
Copy link
Collaborator

@derberg I'll review this before EOD

## Typedefs

<dl>
<dt><a href="#TemplateRenderMetadata">TemplateRenderMetadata</a> : <code>Object</code></dt>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@derberg @chinma-yyy what do the #TemplateRenderMetadata and #TemplateRenderResults link to. They don't navigate to any section of this page.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what it will look like in the website:

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually it should render the object properties 🤔. Will look into it

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chinma-yyy any updates regarding this?

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@Florence-Njeri
Copy link
Collaborator

@chinma-yyy Do you have any updates regarding this PR?

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@derberg
Copy link
Member

derberg commented Oct 4, 2023

@chinma-yyy please respons, otherwise we will have to close this PR as it is blocking others to work on it

@derberg derberg closed this Nov 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhance API docs with information about results of code generation with generateFromString using entrypoint
3 participants