Skip to content

Improve Endpoint Definitions #1

Description

@nicholasprussen

API Endpoints should follow a nice easily reproducible format to identify that it is an API and correspond to the data it will be manipulating. We should also define a system for adding new endpoints and how to name them when added.

For example, we could follow the naming scheme of something like this:

"/getHostnames" (current endpoint definition) could be changed to:

"/api/adapt/hostnames"

  • /api (shows that we're accessing an api)
  • /adapt (shows that the endpoint is used for the adapt frontend)
  • /hostnames (shows that we're accessing data by hostname)

Metadata

Metadata

Assignees

No one assigned

    Labels

    EpicdocumentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions