Skip to content

Simplify command in OpenAPI spec #28

@tadasant

Description

@tadasant

Commentary on this so far:

At minimum, I think we need to make sure we can model all the official reference servers and their corresponding registries (pypi, npm, docker). We should also make sure we support the most obvious package registries for any official SDK's language (e.g. Rubygems, etc.).

Options we seem to have:

  1. Keep a pretty complex command structure as is in the OpenAPI spec at the time of this writing, plus extend it somehow with registry package version so it we can are not hardcoding package@latest into the command. This field unwieldly.
  2. Remove command.name and simplify to just arguments, eliminating the differentiation between named_arguments, positional_arguments, and subcommand. It's probably that docker / mounts need some sort of carve-out for this. Are there other cases where this will be a problem?
  3. Some sort of templating solution

@connor4312 @sandy081 it seems like you have done a fair bit of exploration here, so I'm inclined to let you drive this to a conclusion. Sounds like you feel pretty strongly on (2)?

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions