Create a Webapp API endpoint for LRM collection status tracking

[bishwaspraveen]

Description

Overview

This document outlines the requirements for a Webapp Status API designed to provide status updates and information regarding various collections within a specific endpoint. The API will allow users to query status information based on collection names, date ranges, and status conditions.

API Endpoint

URL: https://sde-indexing-helper.nasa-impact.net/api/collection/status

Request Parameters

1. Name (required)

• Description: Name of the collection (referred to as folder names to avoid confusion).
• Type: String or List
• Values:
  • List of specific collection names.
  • "all" - Represents a query for the status of all collections.

2. Date Range (optional)

• Description: Filter the status based on the modification date of the collection status.
• Type: Date or Date Range
• Format: YYYY-MM-DD for specific dates or YYYY-MM-DD to YYYY-MM-DD for a range.
• Values:
  • Status modified date range.
  • Specific date.

3. Status (optional)

• Description: Filter collections based on their current status.
• Type: List
• Values:
  • List of permissible status values.

Response Body

The response will be a JSON object that includes an array of collections with their respective status details.

Structure

Each item in the response array will have the following structure:

• Collection Name (Folder Name):
• Full Name: Full name of the collection.
• Current Status: Current status of the collection.
• Modified Date: The last modified date of the status.
• Owner: Owner of the collection.
• Curated URL Count: Number of curated URLs within the collection.
• Treeroot: Treeroot identifier.
• Folder Name: The name of the folder.
• Status Trail: An array of status changes, each containing:
• Status Name: The name of the status.
• Modified Date: Date when the status was changed.
• Owner: The user who changed the status.
• Webapp Link: A link to the collection on the web application.

[bishwaspraveen]

@shravan-lrm Can you please fill up this card with what you need from the API endpoint

[bishwaspraveen]

@shravan-lrm did you get some time to take a first hit at this? All we need from your end is are the detailed requirements of the API endpoint. Feel free to fill up this card with the requirements.

[shravan-lrm]

@bishwaspraveen This is the first version of the requirements to get started with, we can refine the API as required going forward.

[shravan-lrm]

@bishwaspraveen Thanks for working on this. Could you please provide the details of the API and how it works if this is done?

[bishwaspraveen]

@shravan-lrm I was working on this but now, Booz Allen has taken over since they're working on a similar usecase. Will keep you updated as soon as their work gets deployed.