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

Update README.md with service level, resource level, and example annotations #1811

Merged
merged 4 commits into from
Jan 23, 2025

Conversation

SachinAkash01
Copy link
Member

@SachinAkash01 SachinAkash01 commented Jan 21, 2025

Purpose

Purpose of this PR is to update the README.md which was previously Module.md (The default package documentation), by including the service level, resource level, and example annotations.

Also the details regarding the Validator Compiler Plugin has also been removed since we no longer encourage users to use it.

Fixes: #7504

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.

module-ballerina-openapi/README.md Outdated Show resolved Hide resolved
module-ballerina-openapi/README.md Outdated Show resolved Hide resolved
module-ballerina-openapi/README.md Outdated Show resolved Hide resolved
@SachinAkash01 SachinAkash01 requested a review from lnash94 January 23, 2025 08:39
@TharmiganK TharmiganK merged commit e01cff3 into ballerina-platform:master Jan 23, 2025
4 checks passed
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.

[Ballerina OpenAPI] Update Module.md with resource level and example annotations
3 participants