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

Remove name from opspecs #907

Open
apexskier opened this issue Mar 30, 2021 · 1 comment
Open

Remove name from opspecs #907

apexskier opened this issue Mar 30, 2021 · 1 comment
Labels
proposal Proposed change to the project

Comments

@apexskier
Copy link
Contributor

💥 Proposal

The top level name property in an op.yml file isn't currently used for anything at runtime and causes confusion when compared to an op ref. It's also generally extra boilerplate the people (including me) forget to update, as most of the time it matches the name of the containing directory if the op is defined in an .opspec directory.

The use case of documentation for a human is provided by the description field.

I think the op ref is more useful in most cases, since it's what someone must know in order to use an op.

Removing the name field is easy (7e86c43) and can be backwards compatible by marking it optional and deprecated in the json schema.

Related: #634 (comment)

@apexskier
Copy link
Contributor Author

The opspec version field is also essentially useless and could be removed.

apexskier added a commit that referenced this issue Apr 1, 2021
For backwards compatibility, these have been marked deprecated in the
JSON schema.

Resolves #907
@psamaan psamaan added the proposal Proposed change to the project label May 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal Proposed change to the project
Projects
None yet
Development

No branches or pull requests

2 participants