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

There is an example of how to use a spec-generated Ruby client #12

Closed
9 tasks done
sgnn7 opened this issue Nov 6, 2020 · 2 comments · Fixed by #42
Closed
9 tasks done

There is an example of how to use a spec-generated Ruby client #12

sgnn7 opened this issue Nov 6, 2020 · 2 comments · Fixed by #42

Comments

@sgnn7
Copy link
Contributor

sgnn7 commented Nov 6, 2020

We need to have some sort of documentation about how to use the generated clients in a few languages. Something like TIOBE index would be a good start to see which ones. Most likely the relevant ones for us would be: Golang, Ruby, Python, Java, JS, and .NET

A resolution for this issue would include

  • An example use of the OpenAPI spec generated Ruby client, covering:
    • Authentication
    • Changing password
    • Rotating API key
    • Loading policy
    • Store/retrieve secrets
    • Basic authentication
    • Conjur Token authentication
  • Accompanying documentation
@sgnn7 sgnn7 added this to the OpenAPI Spec - Inclusion in OSS Suite milestone Nov 12, 2020
@john-odonnell john-odonnell self-assigned this Nov 20, 2020
@izgeri
Copy link
Contributor

izgeri commented Nov 30, 2020

@john-odonnell can you fill this in to be a bit more clear about the scope of the card you are working on? the card definition should make it clear how you know when you are "done" - right now, I'm not sure what exactly the outcome of this card will be.

I would suggest scoping it to something that's pretty limited - for example, limit it to Python in this one card and we can add separate cards for other language clients & examples

Also, what does this mean by "example usage"?

@john-odonnell
Copy link
Contributor

@izgeri I'm reading "example usage" as a workflow that shows exactly how a user would interface with Conjur in a certain language using a generated client. When a client is generated for a language, it includes some documentation on getting started, but it can be pretty barebones, and the quality varies language-to-language. I've been using these examples to exhibit using popular Conjur endpoints so users will have a good idea how to get started with some basics.

There is already a Python example in main, so I think I'll make this one Ruby specific.

@john-odonnell john-odonnell changed the title There are example usages of the generated clients for a few selected languages There is an example of how to use a spec-generated Ruby client Dec 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment