Skip to content

PortalJS Cloud Portal-Specific API endpoints #1459

@demenech

Description

@demenech

As a portal administrator, I'd like to have portal-aware API endpoints, e.g, api.cloud.portaljs.com/my-portal/api/3/action/package_search, so that I can more easily interact programatically with my portal.

This improvement also helps with:

  • Simplifying the PortalJS Frontend Starter Template codebase by removing the need for a custom PortalJS Cloud connector (it will be possible to use just a plain CKAN connector)
  • Simplifying the code for custom data pipelines (e.g., with the PortalJS Harvesters Framework)

Acceptance Criteria

  • The API endpoints that are relevant to the PortalJS Frontend Starter Template have been identified (e.g, package_search, group_list, etc.)
    • ... and support portal-awareness
  • (Bonus) The API endpoints that are relevant to data pipelines have been identified (e.g., organization_create, package_create, etc.)
    • ... and support portal-awareness

Tasks

  • Investigate the most relevant API endpoints
  • Decide on an approach for making these endpoints portal-aware
    • Ideally, /my-portal/api/3/action/... for full compatibility with the CKAN core API
    • Redundancy is also good, e.g, also make the core endpoints portal-aware via headers
    • NOTE: core endpoints must still behave as they behave currently for retrocompatibility and smooth migration
  • Implement

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions