feature/swagger-cli-version

[gratcliff]

This is half of a 2 part PR. The other half can be referenced in https://github.com/readmeio/readme/pull/ under the same name. You will need to have both branches running for full functionality.

This creates CLI interactions for the new version CRUD API. Additionally, it allows version control with the rdme swagger command.

[erunion]

Can you toss a .then() on this to catch these new API call successes and display a message? The API responses from versions:create and versions:delete are getting dumped to the terminal.

[gratcliff]

Can you toss a .then() on this to catch these new API call successes and display a message? The API responses from versions:create and versions:delete are getting dumped to the terminal.

Happy to.

[dok]

When I try to run NODE_ENV=localhost ./rdme.js versions:update --key=... --version=1.0 on an existing version, I'm getting a Cannot find target version message. I'm seeing in the readme side that the .0 in the 1.0 version semantic string is being stripped out.

Same thing happens with version:versionId the .0 suffix is being stripped.

[gratcliff]

When I try to run NODE_ENV=localhost ./rdme.js versions:update --key=... --version=1.0 on an existing version, I'm getting a Cannot find target version message. I'm seeing in the readme side that the .0 in the 1.0 version semantic string is being stripped out.

Same thing happens with version:versionId the .0 suffix is being stripped.

This was an issue with the minimist package converting anything x.0 to a number with parseInt. Fixed via config.

[mjcuva]

Few things I noticed!

• We can probably break up the help a little bit better, maybe have separate sections for versions, docs, and swagger stuff? Also fixing the space so it's easier to read (it's nice having the second column lined up)

• When I tried syncing a swagger file with version 1.0.0, it said there was no matching version since the version in readme was 1.0. I think if we convert the semver version in the swagger file to valid semver (semver.clean) and compare it with version_clean in the db that will fix it!

[erunion]

We can probably break up the help a little bit better, maybe have separate sections for versions, docs, and swagger stuff? Also fixing the space so it's easier to read (it's nice having the second column lined up)

I'll factor this into #45

[gratcliff]

Few things I noticed!

• We can probably break up the help a little bit better, maybe have separate sections for versions, docs, and swagger stuff? Also fixing the space so it's easier to read (it's nice having the second column lined up)

• When I tried syncing a swagger file with version 1.0.0, it said there was no matching version since the version in readme was 1.0. I think if we convert the semver version in the swagger file to valid semver (semver.clean) and compare it with version_clean in the db that will fix it!

Good call, checked the functionality in the frontend and that maps. I'll make the change (although it'll be in the other repo).

[mjcuva]

We should always do the prompt for which version to upload the swagger file to (unless they pass --version in the command, or have the --id already in there). Currently if the version already exists in readme, it will just upload it to that version. This can be kinda confusing, so I think it's better to be explicit!

[gratcliff]

We should always do the prompt for which version to upload the swagger file to (unless they pass --version) in the command. Currently if the version already exists in readme, it will just upload it to that version

This seems to be working as intended. Why put them through the process if it works behind the scenes for the user?

[dok]

I can't seem to update the version if it is a main version. Am I doing something weird here?

It would be helpful to know why it's breaking in this stage

[gratcliff]

I can't seem to update the version if it is a main version. Am I doing something weird here?

It would be helpful to know why it's breaking in this stage

This has been rectified :)

[mjcuva]

When I run it locally nothing happens and it doesn't output anyting. Seems like api/v1/version is returning a 404?

[mjcuva]

JK I forgot to checkout the branch in readme!

Looks good for importing a new swagger file, but when I pass in --id it still asks me for the version, which shouldn't happen since we already know what version the swagger file was synced with. In this case we can just update the existing one!

[mjcuva]

Looks good to me!