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 GET/POST/DELETE /configuration/apiKeys #128

Closed
mfriesen opened this issue May 19, 2023 · 1 comment
Closed

Add GET/POST/DELETE /configuration/apiKeys #128

mfriesen opened this issue May 19, 2023 · 1 comment
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@mfriesen
Copy link
Member

Allow the ability for the admin user to create API Keys to access the API.

@mfriesen mfriesen added the enhancement New feature or request label May 19, 2023
@mfriesen mfriesen added this to the v1.11.0 milestone May 19, 2023
@mfriesen mfriesen self-assigned this May 19, 2023
@reganwolfrom
Copy link
Member

Here are my recommendations for RESTful design:

  • GET /configuration/apiKeys
  • POST /configuration/apiKeys
  • DELETE /configuration/apiKeys/{apiKey}

For POST /configuration/apiKeys, the assumption I've made from the API docs is that the apiKey is auto-generated, so we don't need to worry about validation, and the result will always be compatible as a REST Resource, i.e., no spaces or other punctuation or symbols.

For now, there is no GET /configuration/apiKeys/{apiKey}, but can be added as a future enhancement based on demand.

@mfriesen mfriesen changed the title Add GET/POST/DELETE /configs/apiKey Add GET/POST/DELETE /configuration/apiKeys May 30, 2023
mfriesen added a commit that referenced this issue Jun 15, 2023
* #123 - Add AWS XRay Support to Lambda functions

* #124 - OCR Tessaract Support

* #126 - add GET/PATCH /configs API endpoints

* #125 - ChatGPT Tag "documentTagging" Support

* #127 - Add "apiKey" access support

* #126 add GET/PATCH /configuration API endpoints

* #128 - Add GET/POST/DELETE /configuration/apiKeys

* added contentLength to GET /documents/{documentId}/fulltext, POST /searchFulltext

* #10 - Version delete corrupts all other versions of file, including current

* moved awstests under integration src package
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants