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

Support all Metadata Annotations for Json Schema Milestone #5525

Closed
antgamdia opened this issue Oct 20, 2022 Discussed in #5512 · 1 comment
Closed

Support all Metadata Annotations for Json Schema Milestone #5525

antgamdia opened this issue Oct 20, 2022 Discussed in #5512 · 1 comment
Assignees
@antgamdia
Labels
component/ui Issue related to kubeapps UI kind/feature An issue that reports a feature (approved) to be implemented
Milestone
Adapt Kubeapps Fo...

Comments

@antgamdia
Copy link
Contributor

Discussed in #5512

Originally posted by jl-beast October 19, 2022
Currently from what I see in the Milestone, the implementation of the following basic metadata annotations from the json-schema.org have not been mentioned:

  • "deprecated"
    • could be implemented by showing a [deprecated] annotation to the far-right side of the renderer.
  • "examples"
    • could be implemented for values by allowing for a drop-down underneath if examples are provided. When an Example is selected it would load it in. Would only be needed for string, number, and integer values.

the "readOnly" and "writeOnly" annotations would need to be specific to kubeApps, so I am not sure what purposes they would be used for.
@antgamdia antgamdia added kind/feature An issue that reports a feature (approved) to be implemented component/ui Issue related to kubeapps UI labels Oct 20, 2022
@antgamdia antgamdia self-assigned this Oct 20, 2022
@antgamdia antgamdia mentioned this issue Oct 20, 2022
Merged
antgamdia added a commit that referenced this issue Oct 21, 2022
@antgamdia
Use more json schema annotations in the basic form (#5532)
291a4f0 
### Description of the change

As pointed out by @jl-beast at
#5512, we could
leverage more JSON Schema built-in annotations to enrich the UX.

This PR (and the stacked ones) is adding support for `examples`,
`readOnly`, `deprecated`, `maxItems`, `multipleOf` amongst others
(following
http://json-schema.org/draft/2020-12/json-schema-validation.html#name-a-vocabulary-for-structural)

### Benefits

Richer UX in the basic form for complex schemas

### Possible drawbacks

N/A

### Applicable issues

- fixes #5525 

### Additional information

> **Note**
> This PR is part of a series of PRs aimed at closing [this
milestone](https://github.com/vmware-tanzu/kubeapps/milestone/27). I
have split the changes to ease the review process, but as there are many
interrelated changes, the tests will be performed in a separate PR (on
top of the branch containing all the changes).
>  PR 3 out of 6

Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
@antgamdia
Copy link
Contributor Author

Closed by #5532 (merged in main by #5530)

absoludity pushed a commit that referenced this issue Apr 28, 2023
@dependabot
Bump axios from 1.3.6 to 1.4.0 in /integration (#6235)
2e0ad79 
Bumps [axios](https://github.com/axios/axios) from 1.3.6 to 1.4.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/axios/axios/releases">axios's
releases</a>.</em></p>
<blockquote>
<h2>Release v1.4.0</h2>
<h2>Release notes:</h2>
<h3>Bug Fixes</h3>
<ul>
<li><strong>formdata:</strong> add <code>multipart/form-data</code>
content type for FormData payload on custom client environments; (<a
href="https://redirect.github.com/axios/axios/issues/5678">#5678</a>)
(<a
href="https://github.com/axios/axios/commit/bbb61e70cb1185adfb1cbbb86eaf6652c48d89d1">bbb61e7</a>)</li>
<li><strong>package:</strong> export package internals with unsafe path
prefix; (<a
href="https://redirect.github.com/axios/axios/issues/5677">#5677</a>)
(<a
href="https://github.com/axios/axios/commit/df38c949f26414d88ba29ec1e353c4d4f97eaf09">df38c94</a>)</li>
</ul>
<h3>Features</h3>
<ul>
<li><strong>dns:</strong> added support for a custom lookup function;
(<a
href="https://redirect.github.com/axios/axios/issues/5339">#5339</a>)
(<a
href="https://github.com/axios/axios/commit/2701911260a1faa5cc5e1afe437121b330a3b7bb">2701911</a>)</li>
<li><strong>types:</strong> export <code>AxiosHeaderValue</code> type.
(<a
href="https://redirect.github.com/axios/axios/issues/5525">#5525</a>)
(<a
href="https://github.com/axios/axios/commit/726f1c8e00cffa0461a8813a9bdcb8f8b9d762cf">726f1c8</a>)</li>
</ul>
<h3>Performance Improvements</h3>
<ul>
<li><strong>merge-config:</strong> optimize mergeConfig performance by
avoiding duplicate key visits; (<a
href="https://redirect.github.com/axios/axios/issues/5679">#5679</a>)
(<a
href="https://github.com/axios/axios/commit/e6f7053bf1a3e87cf1f9da8677e12e3fe829d68e">e6f7053</a>)</li>
</ul>
<h3>Contributors to this release</h3>
<ul>
<li><!-- raw HTML omitted --> <a
href="https://github.com/DigitalBrainJS" title="+151/-16
([#5684](axios/axios#5684)
[#5339](axios/axios#5339)
[#5679](axios/axios#5679)
[#5678](axios/axios#5678)
[#5677](axios/axios#5677) )">Dmitriy
Mozgovoy</a></li>
<li><!-- raw HTML omitted --> <a
href="https://github.com/arthurfiorette" title="+19/-19
([#5525](axios/axios#5525) )">Arthur
Fiorette</a></li>
<li><!-- raw HTML omitted --> <a href="https://github.com/npiyush97"
title="+2/-18 ([#5670](axios/axios#5670)
)">PIYUSH NEGI</a></li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/axios/axios/blob/v1.x/CHANGELOG.md">axios's
changelog</a>.</em></p>
<blockquote>
<h1><a
href="https://github.com/axios/axios/compare/v1.3.6...v1.4.0">1.4.0</a>
(2023-04-27)</h1>
<h3>Bug Fixes</h3>
<ul>
<li><strong>formdata:</strong> add <code>multipart/form-data</code>
content type for FormData payload on custom client environments; (<a
href="https://redirect.github.com/axios/axios/issues/5678">#5678</a>)
(<a
href="https://github.com/axios/axios/commit/bbb61e70cb1185adfb1cbbb86eaf6652c48d89d1">bbb61e7</a>)</li>
<li><strong>package:</strong> export package internals with unsafe path
prefix; (<a
href="https://redirect.github.com/axios/axios/issues/5677">#5677</a>)
(<a
href="https://github.com/axios/axios/commit/df38c949f26414d88ba29ec1e353c4d4f97eaf09">df38c94</a>)</li>
</ul>
<h3>Features</h3>
<ul>
<li><strong>dns:</strong> added support for a custom lookup function;
(<a
href="https://redirect.github.com/axios/axios/issues/5339">#5339</a>)
(<a
href="https://github.com/axios/axios/commit/2701911260a1faa5cc5e1afe437121b330a3b7bb">2701911</a>)</li>
<li><strong>types:</strong> export <code>AxiosHeaderValue</code> type.
(<a
href="https://redirect.github.com/axios/axios/issues/5525">#5525</a>)
(<a
href="https://github.com/axios/axios/commit/726f1c8e00cffa0461a8813a9bdcb8f8b9d762cf">726f1c8</a>)</li>
</ul>
<h3>Performance Improvements</h3>
<ul>
<li><strong>merge-config:</strong> optimize mergeConfig performance by
avoiding duplicate key visits; (<a
href="https://redirect.github.com/axios/axios/issues/5679">#5679</a>)
(<a
href="https://github.com/axios/axios/commit/e6f7053bf1a3e87cf1f9da8677e12e3fe829d68e">e6f7053</a>)</li>
</ul>
<h3>Contributors to this release</h3>
<ul>
<li><!-- raw HTML omitted --> <a
href="https://github.com/DigitalBrainJS" title="+151/-16
([#5684](axios/axios#5684)
[#5339](axios/axios#5339)
[#5679](axios/axios#5679)
[#5678](axios/axios#5678)
[#5677](axios/axios#5677) )">Dmitriy
Mozgovoy</a></li>
<li><!-- raw HTML omitted --> <a
href="https://github.com/arthurfiorette" title="+19/-19
([#5525](axios/axios#5525) )">Arthur
Fiorette</a></li>
<li><!-- raw HTML omitted --> <a href="https://github.com/npiyush97"
title="+2/-18 ([#5670](axios/axios#5670)
)">PIYUSH NEGI</a></li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/axios/axios/commit/21a5ad34c4a5956d81d338059ac0dd34a19ed094"><code>21a5ad3</code></a>
chore(release): v1.4.0 (<a
href="https://redirect.github.com/axios/axios/issues/5683">#5683</a>)</li>
<li><a
href="https://github.com/axios/axios/commit/d627610d0c427de57c10618b36fa97814e2a75f0"><code>d627610</code></a>
chore(utils): refactored isAsyncFn util to avoid inlining additional
Babel he...</li>
<li><a
href="https://github.com/axios/axios/commit/e18fdd893dfc67630c33fb6744d1b99d72857d92"><code>e18fdd8</code></a>
refactor: remove deprecated url-search-params polyfill for
URLSearchParams (#...</li>
<li><a
href="https://github.com/axios/axios/commit/726f1c8e00cffa0461a8813a9bdcb8f8b9d762cf"><code>726f1c8</code></a>
feat(types): export <code>AxiosHeaderValue</code> type. (<a
href="https://redirect.github.com/axios/axios/issues/5525">#5525</a>)</li>
<li><a
href="https://github.com/axios/axios/commit/2701911260a1faa5cc5e1afe437121b330a3b7bb"><code>2701911</code></a>
feat(dns): added support for a custom lookup function; (<a
href="https://redirect.github.com/axios/axios/issues/5339">#5339</a>)</li>
<li><a
href="https://github.com/axios/axios/commit/e6f7053bf1a3e87cf1f9da8677e12e3fe829d68e"><code>e6f7053</code></a>
perf(merge-config): optimize mergeConfig performance by avoiding
duplicate ke...</li>
<li><a
href="https://github.com/axios/axios/commit/bbb61e70cb1185adfb1cbbb86eaf6652c48d89d1"><code>bbb61e7</code></a>
fix(formdata): add <code>multipart/form-data</code> content type for
FormData payload on...</li>
<li><a
href="https://github.com/axios/axios/commit/df38c949f26414d88ba29ec1e353c4d4f97eaf09"><code>df38c94</code></a>
fix(package): export package internals with unsafe path prefix; (<a
href="https://redirect.github.com/axios/axios/issues/5677">#5677</a>)</li>
<li>See full diff in <a
href="https://github.com/axios/axios/compare/v1.3.6...v1.4.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=axios&package-manager=npm_and_yarn&previous-version=1.3.6&new-version=1.4.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@antgamdia antgamdia

Labels
component/ui Issue related to kubeapps UI kind/feature An issue that reports a feature (approved) to be implemented
Projects
Kubeapps
Archived in project
Milestone
Adapt Kubeapps Forms to support JSONS...
Development

No branches or pull requests
1 participant
@antgamdia