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

Dev Console: API Key Functionality #598

Open
fainashalts opened this issue Dec 20, 2024 · 4 comments
Open

Dev Console: API Key Functionality #598

fainashalts opened this issue Dec 20, 2024 · 4 comments
Assignees
Labels
design required This issue requires design support ui-component Adding new custom component or changes needed in ui-components

Comments

@fainashalts
Copy link
Collaborator

This issue covers the creation and retrieval of API keys for dev console users. There is an initial service implemented in k8s that can form the basis for starting this work.

Starting from the above, some considerations:

  • Some architectural work is needed to ensure this works securely and in a scalable way, and we should ensure docker-compose works easily for maintenance.
  • This service should be fully tested.
  • A frontend flow is needed for the console:
  1. User logs in/signs up (there is some work needed here around how/if we can connect their profile to their Agora profile on the Foundation side)
  2. An API key is generated
  3. They can check their profile for that API key once generated
    ** Design is Required for the frontend portion**
@fainashalts fainashalts added design required This issue requires design support ui-component Adding new custom component or changes needed in ui-components labels Dec 20, 2024
@fainashalts
Copy link
Collaborator Author

@mayanksayshi design is needed for this issue when you have bandwidth. Happy to chat more about the flow if you'd like! 😄

@mayanksayshi
Copy link

@mayanksayshi design is needed for this issue when you have bandwidth. Happy to chat more about the flow if you'd like! 😄

Hey @fainashalts, I did some early Lofi designs; however, I did them without any detailed requirements, so I am unsure how correct they are. If you can, please review the Lofi designs and let me know what is missing or needs to be corrected. That would be helpful.

https://www.figma.com/design/WmHJErF0zjIgoR8IYWOVFT/Dev-Console---CLI-Features-lofi?node-id=6723-4846&t=4v8BYPFQ00xX2TcB-4

@jvmi7 jvmi7 assigned jvmi7 and unassigned jvmi7 Jan 6, 2025
@mayanksayshi
Copy link

Hey @fainashalts @jvmi7 @pharger @nitaliano

Please see the first version of the Hi-Fi design for the API key functionality. Looking forward to your feedback.

https://www.figma.com/design/YCjUV6asLLEna8yISmFLlw/API-Key?node-id=0-1

@fainashalts
Copy link
Collaborator Author

Thanks @mayanksayshi! The design looks great - I just had one question about whether we need to separate out read and write permissions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design required This issue requires design support ui-component Adding new custom component or changes needed in ui-components
Projects
None yet
Development

No branches or pull requests

4 participants