Skip to content

Instantly share code, notes, and snippets.

@metlos
Forked from jkremser/Inventory REST proposal
Created April 19, 2016 12:26
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save metlos/b2f79b512ad4448b8ca690bbbe15e73d to your computer and use it in GitHub Desktop.
Save metlos/b2f79b512ad4448b8ca690bbbe15e73d to your computer and use it in GitHub Desktop.
cpath of entity - enCpath
cpath of element - elCpath
general element
---------------
RUD -> /path/{elCpath} (or /element/{elCpath}? because this isn't consistent with the rest of the REST are we asking for the path of a {elCpath} ?)
relationships
-------------
CRUD -> /relationships/{enCpath}
tenants
-------
R -> /tenant
resources
---------
/resources - R - ?
/resources/{enCpath}
{enCpath} of type Resource: CRUD - the resource
{enCpath} of type ResourceType: R, D? - makes sense as well (delete all the URLs)
{enCpath} of type Metric: R - retrieves all the resources that has metric X (D?)
{enCpath} of type MetricType: R - retrieves all the resources that has metric of type X, sounds bit complicated but makes sense to me
{enCpath} of type Feed, Environment, Tenant?: R, D? - retrieves all the resources of given feed/env/tenant? tenant is TBD
{enCpath} of type DataEntity - doesnt make sense -> fail
{enCpath} of type MetadataPack - R - give me all the resources whose res type is captured by the mp? Perhaps overcomplicated TBD
{enCpath} of type OperationType - R - all the resources of a res type for which the operation is defined - might be useful, not sure
resource type
-------------
/resourcesTypes - R ?
/resourcesTypes/{enCpath}
{enCpath} of type ResourceType: CRUD - the resource type
{enCpath} of type Resource: R - give me the res type of the resource on this path? well, why not. on the other hand the type is part of the resource entity, so this seems to be little strange
{enCpath} of type Metric: seems over-complicated -> fail
{enCpath} of type MetricType: TBD - do we want to keep this situation:
RT--?--MT
| |
R-------M
{enCpath} of type Feed, Tenant?: R, D? - retrieves all the res types of given feed/tenant
{enCpath} of type MetadataPack - R - give me all the res types of the MP, makes sense
{enCpath} of type OperationType - R - all the res types on which this operation is possible
todo: /metrics, /metricTypes, /feeds, /environments, /data, /operations, /metadataPack?, parent, children, ?recursive=bool, filtering,
bulk
----
/bulk - no change here
graph dump
----------
/graph - no change here
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment