Skip to content

fix: description preset for any types#2188

Merged
jonaslagoni merged 2 commits intoasyncapi:masterfrom
rmaced0:bert0rm/fix-description-preset-any-types
Feb 21, 2025
Merged

fix: description preset for any types#2188
jonaslagoni merged 2 commits intoasyncapi:masterfrom
rmaced0:bert0rm/fix-description-preset-any-types

Conversation

@rmaced0
Copy link
Contributor

@rmaced0 rmaced0 commented Feb 19, 2025

Description

When a spec has a property that defines an open object like:

anyProp: {
      type: 'object',
      $id: 'AnyTest',
      properties: {},
      description: 'AnyTest description'
    }

it does not add the description to the generated models.

This PR fixes this issue.

Related Issue

Checklist

  • The code follows the project's coding standards and is properly linted (npm run lint).
  • Tests have been added or updated to cover the changes.
  • Documentation has been updated to reflect the changes.
  • All tests pass successfully locally.(npm run test).

Additional Notes

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.

@netlify
Copy link

netlify bot commented Feb 19, 2025

Deploy Preview for modelina canceled.

Name Link
🔨 Latest commit 6579ee1
🔍 Latest deploy log https://app.netlify.com/sites/modelina/deploys/67b66ae32d98770008c08214

@sonarqubecloud
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
32.1% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

@coveralls
Copy link

Pull Request Test Coverage Report for Build 13424486208

Details

  • 4 of 4 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.003%) to 92.397%

Totals Coverage Status
Change from base Build 13368384750: -0.003%
Covered Lines: 6478
Relevant Lines: 6873

💛 - Coveralls

@jonaslagoni jonaslagoni merged commit 9233548 into asyncapi:master Feb 21, 2025
14 of 15 checks passed
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 4.0.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants