Skip to content

Feature: REST API Project #31

Open
@JeremyCaney

Description

@JeremyCaney

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Area: WebRelates to the `AspNetCore` or other web-related functionality.Priority: 2Status 0: DiscussionNeeds further evaluation of requirements and prioritization.Type: FeatureIntroduces a major area of functionality.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions