search

overture-stack / lectern

Data Schema / Dictionary management system
GNU Affero General Public License v3.0
0 stars 1 forks source link

Feature Request: Endpoints to query specific schema and fields within a dictionary #178

Closed joneubank closed 1 year ago

joneubank commented 1 year ago

Detailed Description

Add 2 new readonly endpoints to be able to get details of an individual schema or field from a schema:

Possible Implementation

  1. Query schema GET /dictionaries/{dictionary_id}/schemas/{schema_name} -> Return full schema only
  2. Query field GET /dictionary/{dictionary_id}/schema/{schema_name}/field/{field_name} -> Return full schema only

Refactor Suggestion

This suggests changing the endpoint name from /dictionaries to /dictionary for fetching an individual dictionary. We could easily support both with the /dictionaries being marked as deprecated. Fetching an individual resource is sensible named in singular.