Skip to content

Extra metadata with API feeds #524

Description

@dan-odsc

From Mike

I’d like to propose extra optional fields to be returned by the root/stub API endpoint.

Specifically to allow the Dashboard 1 (new version is under development) to be documented entirely from a feed under the publisher’s control, we could add:

Organization name
Organization URL
Developer name
Developer URL
Summary text
There may be extra data (like administrator email address) which should not be in an open feed and should stil be communicated manually.

From DaveIlesdTPX

Jumping in here for the first time to piggy back on this, I’d like to also propose that the version field returned from the same GET / endpoint should be a constant with a value of HSDS-UK-3.0 or something similar.
To me it becomes a much more useful field if it can be relied upon to describe the version in a constant format, particularly going forward if each new version of the standard used a constant field here as well.

As for Mike’s original proposal the extra fields would be useful for our current development and could be useful for others trying to consume this APIs as well.

Metadata

Metadata

Labels

Involvement requiredIssue requiring committee/community engagement in order to progressMINOR upgradeClear requests that would require a MINOR upgrade to the schemaapi

Type

No type
No fields configured for issues without a type.

Projects

Status
Backlog

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions