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

Enable @openapi:ResourceInfo annotation for service contract type #1800

Closed

Conversation

lnash94
Copy link
Member

@lnash94 lnash94 commented Dec 6, 2024

Purpose

Fix #ballerina-platform/ballerina-library#7447

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email [email protected] to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to [email protected] and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

@lnash94 lnash94 force-pushed the resource_config_fix branch from 7506069 to 8e16944 Compare December 6, 2024 12:06
@lnash94 lnash94 changed the title Enable @openapi:ResourceInfo annotation for service type resource objects Enable @openapi:ResourceInfo annotation for service contract type Dec 6, 2024
@lnash94 lnash94 force-pushed the resource_config_fix branch from 8e16944 to 18ded0c Compare December 6, 2024 13:08
Copy link

sonarqubecloud bot commented Dec 6, 2024

@@ -100,7 +100,7 @@ public type Examples readonly & record {|
|};

# Annotation for additional OpenAPI information of a Ballerina resource function.
public const annotation ResourceInformation ResourceInfo on object function;
public const annotation ResourceInformation ResourceInfo on object function, object field;
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we need to enable it in the object field?

@TharmiganK
Copy link
Contributor

@lnash94 I think we already have this support

@lnash94
Copy link
Member Author

lnash94 commented Dec 9, 2024

@lnash94 I think we already have this support

Yeah, support is there, this was my mistake due to checking with the caching issue in local, we can close this issue.

@lnash94 lnash94 closed this Dec 9, 2024
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.

2 participants