Skip to content
This repository has been archived by the owner on Feb 21, 2025. It is now read-only.

Define structure for data retrieval query JSON #1

Open
JasonWarrenUK opened this issue Jan 23, 2025 · 2 comments
Open

Define structure for data retrieval query JSON #1

JasonWarrenUK opened this issue Jan 23, 2025 · 2 comments
Assignees

Comments

@JasonWarrenUK
Copy link

No description provided.

@AlexVOiceover
Copy link
Collaborator

AlexVOiceover commented Jan 23, 2025

@JasonWarrenUK Let's start with the GETs. Will update soon POSTs, PATCHs and DELETEs

Proposed Endpoints and Query Structures

Endpoint Purpose Query Parameters Example Response
/dictionary Retrieve dictionary entries startsWith (optional), limit (optional) json {"dictionary": ["apple", "applicable", "applesauce"]}
/statements Retrieve all statements None json {"statements": [{"subject": "Alice","verb": "manages","object": "project deadlines","isPublic": true,"actions": [{"creationDate": "2025-01-20","byDate": "2025-01-20","action": "Reviewed statement"}]}]}
/statements/subject Retrieve statements by subject subject (required) json {"statements": [{"subject": "Alice","verb": "manages","object": "project deadlines","isPublic": true,"actions": [{"creationDate": "2025-01-20","byDate": "2025-01-20","action": "Reviewed statement"}]}]}
/tiles Retrieve data for populating grid tiles None json {"tiles": [{"name": "Achieve","popularity": 95,"color": "purple"},{"name": "Adapt","popularity": 90,"color": "purple"}]}

Request Examples

/dictionary

  • Retrieve all dictionary entries:
    GET /dictionary
  • Retrieve entries starting with app, limited to 10:
    GET /dictionary?startsWith=app&limit=10

/statements

  • Retrieve all statements:
    GET /statements

/statements/subject

  • Retrieve statements for a specific subject (Alice):
    GET /statements/subject?subject=Alice

/tiles

  • Retrieve all tile data:
    GET /tiles

@JasonWarrenUK
Copy link
Author

I've literally just seen this 🤦🏽

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants