/Specification API

[Ben-Hodgkiss]

Overview

Following the Pipeline API workshop day, we have now identified and prioritised the different APIs that are required to remove the Providers team dependency on datasette.

This ticket is to create the /specification API. At the workshop, we identified the following criteria for this that can be found on this Google sheet.

Method	GET
Path	/specification

Inputs

Required	Optional
	dataset

Outputs

Existing
dataset
fields: field_name, field_description, guidance

Datasette Tables

specification

Tech Approach

To be completed during Refinement.

Acceptance Criteria

• API created to query on the Specification table
• Queries can filter on dataset
• Output includes dataset and information about the fields (field_name, field_description, guidance)

Resourcing & Dependencies

• Developer to attend the Providers Stand-Up on Tuesdays and Thursdays (they do not need to attend the Infra Stand-Up on these days).
• Providers to offer support including pair programming and PR reviewing.

[eveleighoj]

We might need to be careful with language, the specification contains a few datasets including one possibly callled specification. we should look at including realms in dataset endpoints i.e. speccification/specification and specification/provision and performance/pprovision_summary