Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extra metadata with API feeds #524

Open
dan-odsc opened this issue Nov 1, 2024 · 0 comments
Open

Extra metadata with API feeds #524

dan-odsc opened this issue Nov 1, 2024 · 0 comments
Assignees
Labels
api MINOR upgrade Clear requests that would require a MINOR upgrade to the schema

Comments

@dan-odsc
Copy link
Contributor

dan-odsc commented Nov 1, 2024

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.

@dan-odsc dan-odsc added MINOR upgrade Clear requests that would require a MINOR upgrade to the schema api labels Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api MINOR upgrade Clear requests that would require a MINOR upgrade to the schema
Projects
Status: Proposed
Development

No branches or pull requests

2 participants