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

Add a setting for SDK generator #1433

Closed
5 tasks
bajiat opened this issue Aug 23, 2016 · 5 comments
Closed
5 tasks

Add a setting for SDK generator #1433

bajiat opened this issue Aug 23, 2016 · 5 comments
Assignees

Comments

@bajiat
Copy link
Contributor

bajiat commented Aug 23, 2016

Add a setting for SDK generator in platform settings (Settings view, settings collection).

User story

As an Apinf administrator I want to be able to add a Codegen instance location to Apinf
so that I can allow API consumers to download SDK's
whenever APIs added to Apinf have a Swagger file.

Definition of done

  • Settings collection contains a setting for SDK generator.
  • Settings view contains a setting for SDK generator.
  • An Apinf administrator can give the location of the SDK generator (= Codegen).
  • The SDK generator UI in Documentation tab passes the Swagger to the Codegen instance defined in Settings.
  • SDK generator is available in Documentation tab only if there is a setting for SDK generator
@bajiat
Copy link
Contributor Author

bajiat commented Aug 23, 2016

@marla-singer @shaliko Here is the next task for Dasha. I will still check the Definition of done and description with @brylie.

@shaliko
Copy link
Contributor

shaliko commented Aug 23, 2016

@bajiat Thanks!

@marla-singer
Copy link
Contributor

@bajiat

  1. How can give the location of the SDK generator: Apinf Administrator (global admin, who has auth token) or API owner (user, who add this API)?
  2. Which page have to contains a setting for SDK?
    API settings page
    joxi_screenshot_1472213462998

Edit API page
joxi_screenshot_1472213574731

@bajiat bajiat added ready and removed planning labels Aug 26, 2016
@bajiat
Copy link
Contributor Author

bajiat commented Aug 26, 2016

@marla-singer: SDK generator setting is not a setting for an individual API but for the entire platform/deployment.

So it should not be in API settings tab, but in the platform Settings. You can find the Settings UI by pressing the small triangle next to your user name. Implement it similarly to the other settings: it needs to be enabled and once enabled you can give the host.

Only admins should be able enable SDK generator and give the host.

@marla-singer
Copy link
Contributor

@bajiat I found the platform Settings. This feature should looks like "API Documentation Editor", right?
Click to checkbox "Enabled" -> Show input with label "Host"

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

No branches or pull requests

4 participants