Improve API Request Parameter Visibility

Created on 29 June 2023, 12 months ago
Updated 19 September 2023, 9 months ago

Problem/Motivation

It's hard to know what API parameters you can use in API queries.

Steps to reproduce

Attempt to filter your query and experience the uncertainty.

Proposed resolution

Add a drush command that show the available options.

Show the results from this API request in a table or some other format:

- https://example.orangelogic.com/API/search/v3.0/ListCriteria

Remaining tasks

Add a new endpoint to the PHP Library: https://github.com/ChromaticHQ/orange-dam-php
Add a new Drush command to this module.

User interface changes

N/A

API changes

New method.

Data model changes

N/A

✨ Feature request
Status

Fixed

Version

1.0

Component

Miscellaneous

Created by

πŸ‡ΊπŸ‡ΈUnited States adamzimmermann

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @adamzimmermann
  • πŸ‡ΊπŸ‡ΈUnited States adamzimmermann

    Example response data:

    {
    "APIRequestInfo": {
    "ProviderVersion": "EXAMPLE.123",
    "ProviderIdentity": "EXA-AWS-OHI-182",
    "ProviderID": "1234",
    "Module": "search",
    "APIVersion": "v3.0",
    "Resource": "ListCriteria",
    "IsLoggedIn": true,
    "Status": "LoggedIn",
    "UserLogin": "",
    "Session": "Example Session",
    "TimeoutPeriodMinutes": 120
    },
    "APIResponse": [
    {
    "Name": "Doctype",
    "Description": ""
    },
    {
    "Name": "Mediatype",
    "Description": "Media type such as Image, Audio, Video, Album, Story...",
    "Examples": "query=MediaType:Image\nquery=MediaType:Image OR Video"
    },
    {
    "Name": "Docsubtype",
    "Description": "Asset sub type such as Upload folder, Standard image, Video segment, etc.",
    "Examples": "query=DocSubType:Standard Image"
    },
    ...
    
  • @adamzimmermann opened merge request.
  • Status changed to Needs review 9 months ago
  • πŸ‡ΊπŸ‡ΈUnited States adamzimmermann
  • Status changed to Fixed 9 months ago
  • πŸ‡ΊπŸ‡ΈUnited States adamzimmermann
  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.69.0 2024