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.

Sign up for GitHub

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

Jump to bottom

Descriptions in JSON Schema #1633

Merged
merged 2 commits into from
Mar 20, 2023
Merged

Descriptions in JSON Schema #1633

merged 2 commits into from
Mar 20, 2023

Conversation

matejvasek
Copy link
Contributor

@matejvasek matejvasek commented Mar 17, 2023 •
edited
Loading

Changes

  • 🎁 Add descriptions derived from doc comment in JSON Schema. The descriptions it then for instance displayed by IDEs when inspecting func.yaml.

/kind enhancement
/kind documentation

feat: include description in JSON Schema

@matejvasek
chore: update schema generation library
667ae32 
Signed-off-by: Matej Vasek <mvasek@redhat.com>
@matejvasek
feat: description in JSON schema from doc comments
0bd86f3 
Signed-off-by: Matej Vasek <mvasek@redhat.com>
@knative-prow
Copy link

knative-prow bot commented Mar 17, 2023

@matejvasek: The label(s) kind/enhancement,documentation cannot be applied, because the repository doesn't have them.

In response to this:

Changes

  • 🎁 Add descriptions derived from doc comment in JSON Schema.

/kind enhancement,documentation

feat: include description in JSON Schema

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@knative-prow knative-prow bot requested review from navidshaikh and rhuss March 17, 2023 16:40
@knative-prow knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 17, 2023
@matejvasek
Copy link
Contributor Author

/hold

@knative-prow knative-prow bot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Mar 17, 2023
@matejvasek
Copy link
Contributor Author

@evankanderson any idea what failure of Code Style / style / suggester / yaml means? Why it is happening?

@matejvasek matejvasek changed the title Comments in schema Descriptions in JSON Schema Mar 17, 2023
@codecov
Copy link

codecov bot commented Mar 17, 2023 •
edited
Loading

Codecov Report

Patch and project coverage have no change.

Comparison is base (5e87738) 62.62% compared to head (bc1cf19) 62.62%.

❗ Current head bc1cf19 differs from pull request most recent head 0bd86f3. Consider uploading reports for the commit 0bd86f3 to get more accurate results

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1633   +/-   ##
=======================================
  Coverage   62.62%   62.62%           
=======================================
  Files          93       93           
  Lines       11911    11911           
=======================================
  Hits         7459     7459           
  Misses       3764     3764           
  Partials      688      688
Flag Coverage Δ
e2e-test 38.82% <ø> (ø)
e2e-test-oncluster 34.62% <ø> (+0.02%) ⬆️
integration-tests 49.33% <ø> (+<0.01%) ⬆️
unit-tests-macos-latest 48.11% <ø> (ø)
unit-tests-ubuntu-latest 49.04% <ø> (ø)
unit-tests-windows-latest 47.99% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

lance
lance approved these changes Mar 18, 2023
View reviewed changes
Copy link
Member

@lance lance left a comment

Choose a reason for hiding this comment

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

A very nice improvement. Thanks
/lgtm

@knative-prow knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Mar 18, 2023
lkingland
lkingland approved these changes Mar 19, 2023
View reviewed changes
Copy link
Member

@lkingland lkingland left a comment

Choose a reason for hiding this comment

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

/lgtm
Very nice to have for IDEs 👍🏻

zroubalik
zroubalik approved these changes Mar 20, 2023
View reviewed changes
Copy link
Contributor

@zroubalik zroubalik left a comment

Choose a reason for hiding this comment

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

/lgtm

@knative-prow
Copy link

knative-prow bot commented Mar 20, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lance, lkingland, matejvasek, zroubalik

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [lance,lkingland,matejvasek,zroubalik]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@matejvasek
Copy link
Contributor Author

/unhold

@knative-prow knative-prow bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 20, 2023
@lance
Copy link
Member

lance commented Mar 20, 2023

/override "style / suggester / yaml"

@knative-prow
Copy link

knative-prow bot commented Mar 20, 2023

@lance: Overrode contexts on behalf of lance: style / suggester / yaml

In response to this:

/override "style / suggester / yaml"

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@knative-prow knative-prow bot merged commit 7c724bc into knative:main Mar 20, 2023
@matejvasek matejvasek mentioned this pull request Mar 20, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lance lance lance approved these changes

@zroubalik zroubalik zroubalik approved these changes

@lkingland lkingland lkingland approved these changes

Assignees

@lance lance

@zroubalik zroubalik

@lkingland lkingland

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@matejvasek @lance @zroubalik @lkingland