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

As a user, I want the /properties endpoint to include a link to explanatory documentation (i.e. DD or similar) #325

Open
alexdunnjpl opened this issue Apr 26, 2023 · 0 comments
Assignees
Labels
needs:triage requirement the current issue is a requirement

Comments

@alexdunnjpl
Copy link
Contributor

Checked for duplicates

No - I haven't checked

πŸ§‘β€πŸ”¬ User Persona(s)

Raised at API working meeting

πŸ’ͺ Motivation

...so that I can obtain descriptions for the various properties

πŸ“– Additional Details

There was talk of resolving each property to its description, but if it's simple to text-search a single document for the property a static link is probably sufficient and resolution doesn't add value. Unclear at this point

Acceptance Criteria

Given
When I perform
Then I expect

βš™οΈ Engineering Details

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs:triage requirement the current issue is a requirement
Projects
Status: ToDo
Development

No branches or pull requests

2 participants