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

Server cli #92

Open
wants to merge 18 commits into
base: development
Choose a base branch
from
Open

Server cli #92

wants to merge 18 commits into from

Conversation

TimGebert
Copy link
Collaborator

@TimGebert TimGebert commented Oct 23, 2018

Proposed changes

Adds a command line tool that allows the user to interact with the backend server using oap-cli
The command currently has four sub-commands, add, list, build and remove.

Add: yarn oap-cli add <options>
Allows the user to add specifications and sdkConfigs to the server.
Has ability to pipe items from a file, or to build one manually if none are provided.

List: yarn oap-cli list <options>
Allows the user to view all specifications, sdkConfigs and sdks that are currently being stored in the server.

Build: yarn oap-cli build <specificationId> <sdkConfigId>
Allows the user to build a new sdk.
If user specifies * for specificationId or sdkConfigId, the tool will build all items that can be found in the server for that option.

Remove: yarn oap-cli remove <type> <id>
Allows the user to remove and item from the server.
Type is one of specifications, sdkConfigs or sdks.

Todo:

  • add checks when adding a specification of sdkConfig
  • more options for each sub-command
  • --help options could do with some improvement

Types of changes

What types of changes does your code introduce to OpenAPI Platform?

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • I have signed and submitted the appropriate CLA
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant