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

Feature: REST API Project #31

Open
JeremyCaney opened this issue Mar 5, 2021 · 0 comments
Open

Feature: REST API Project #31

JeremyCaney opened this issue Mar 5, 2021 · 0 comments
Labels
Area: Web Relates to the `AspNetCore` or other web-related functionality. Priority: 2 Status 0: Discussion Needs further evaluation of requirements and prioritization. Type: Feature Introduces a major area of functionality.

Comments

@JeremyCaney
Copy link
Member

Currently, the OnTopic Editor has a basic read-only JSON interface, as well as some built-in actions for handling updates, but it's highly specific to the Editor and doesn't support other clients.

Ideally, we'd establish a new e.g. TopicJsonController that exposes a full REST API that can be used by not only the OnTopic Editor, but also any other clients that need AJAX access to the OnTopic database.

Questions

  • Can this be registered as part of the OnTopic Editor so it doesn't need to be independently configured?
  • Should this support both read and write operations? Or just read operations? Or both, via separate services?
  • If it supports write operations, how should authorization be handled?
  • How would we handle sensitive data such as user records? Would these be hidden by an attribute that necessitates authentication?
  • Should this utilize the OnTopic Data Transfer library as a standard interchange format? If so, it makes sense as a separate repository.
@JeremyCaney JeremyCaney added Area: Web Relates to the `AspNetCore` or other web-related functionality. Priority: 2 Status 0: Discussion Needs further evaluation of requirements and prioritization. Type: Feature Introduces a major area of functionality. labels Mar 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Web Relates to the `AspNetCore` or other web-related functionality. Priority: 2 Status 0: Discussion Needs further evaluation of requirements and prioritization. Type: Feature Introduces a major area of functionality.
Projects
None yet
Development

No branches or pull requests

1 participant