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

Adding json description to manifest file fields. #698

Merged
merged 10 commits into from
Jun 21, 2022
Merged

Adding json description to manifest file fields. #698

merged 10 commits into from
Jun 21, 2022

Conversation

sarath-hotspot
Copy link

@sarath-hotspot sarath-hotspot commented Feb 28, 2022 •
edited
Loading

Change

  • Adding description fields to json manifest schema files.

Testing

  • yarn build & yarn test is happy.
  • yarn lint is happy.

Future changes

  • Update description for metadata manifest schema.

@dOrgJelli dOrgJelli changed the base branch from prealpha to prealpha-dev February 28, 2022 17:08
@dOrgJelli
Copy link
Contributor

Hi @sarath-hotspot, can you please add descriptions for all manifest types & versions?

@sarath-hotspot
Copy link
Author

Added description for allother versions of webapi and build schema files.
Need to study metadata and plugin schemas.

@sarath-hotspot sarath-hotspot marked this pull request as draft March 2, 2022 06:09
@sarath-hotspot sarath-hotspot marked this pull request as ready for review March 3, 2022 09:31
@sarath-hotspot
Copy link
Author

Hi @sarath-hotspot, can you please add descriptions for all manifest types & versions?

Updated.

@sarath-hotspot sarath-hotspot changed the title Adding description to one manifest file Adding json description to manifest file fields. Mar 15, 2022
Niraj-Kamdar
Niraj-Kamdar suggested changes Mar 15, 2022
View reviewed changes
Copy link
Contributor

@Niraj-Kamdar Niraj-Kamdar left a comment

Choose a reason for hiding this comment

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

Refactor description for all the files with format: manifestFile to manifest.
Note previously, it was just yamlFile but for consistency rename all of them to manifest.

packages/manifest-schemas/formats/web3api/0.0.1-prealpha.6.json Outdated Show resolved Hide resolved
Niraj-Kamdar
Niraj-Kamdar suggested changes Mar 18, 2022
View reviewed changes
packages/manifest-schemas/formats/web3api.build/0.0.1-prealpha.1.json Outdated
@@ -7,28 +7,34 @@
],
"properties": {
"format": {
"description": "Polywrap build YAML format version.",
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you also replace the YAML here with manifest?

Copy link
Author

Choose a reason for hiding this comment

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

Type here is string. Do we accept json as well as main manifest file?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes we do!

Copy link
Author

Choose a reason for hiding this comment

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

Do we accept json as main manifest file?
I am assuming, we can keep YAML web3api/0.0.1/prealpha.1.json?

Copy link
Author

Choose a reason for hiding this comment

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

updated web3api.build/0.0.1-prealpha.1.json and web3api.build/0.0.1-prealpha.2.json

Niraj-Kamdar
Niraj-Kamdar suggested changes Mar 20, 2022
View reviewed changes
packages/manifest-schemas/formats/web3api.meta/0.0.1-prealpha.1.json Outdated Show resolved Hide resolved
packages/manifest-schemas/formats/web3api.plugin/0.0.1-prealpha.1.json Outdated Show resolved Hide resolved
packages/manifest-schemas/formats/web3api/0.0.1-prealpha.1.json Outdated Show resolved Hide resolved
packages/manifest-schemas/formats/web3api/0.0.1-prealpha.1.json Outdated Show resolved Hide resolved
packages/manifest-schemas/formats/web3api/0.0.1-prealpha.2.json Outdated Show resolved Hide resolved
packages/manifest-schemas/formats/web3api.plugin/0.0.1-prealpha.1.json Outdated Show resolved Hide resolved
packages/manifest-schemas/formats/web3api.plugin/0.0.1-prealpha.1.json Outdated Show resolved Hide resolved
packages/manifest-schemas/formats/web3api.plugin/0.0.1-prealpha.1.json Outdated Show resolved Hide resolved
Niraj-Kamdar
Niraj-Kamdar approved these changes Mar 21, 2022
View reviewed changes
Copy link
Contributor

@Niraj-Kamdar Niraj-Kamdar left a comment

Choose a reason for hiding this comment

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

LGTM!

@fetsorn fetsorn mentioned this pull request Jun 17, 2022
Merged
@dOrgJelli dOrgJelli merged commit e8d00e3 into polywrap:prealpha-dev Jun 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Niraj-Kamdar Niraj-Kamdar Niraj-Kamdar approved these changes

@dOrgJelli dOrgJelli Awaiting requested review from dOrgJelli dOrgJelli is a code owner

@ramilexe ramilexe Awaiting requested review from ramilexe

@krisbitney krisbitney Awaiting requested review from krisbitney

@namesty namesty Awaiting requested review from namesty namesty is a code owner

@nerfZael nerfZael Awaiting requested review from nerfZael nerfZael is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sarath-hotspot @dOrgJelli @Niraj-Kamdar