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

Feature Request: Endpoint to download TSV File templates matching schema headers #182

Open
joneubank opened this issue Jun 24, 2023 · 0 comments
Labels
new-feature Request is a new feature

Comments

@joneubank
Copy link
Contributor

Lectern schemas are structured as they are to work with TSV data files. To facilitate the creation of compatible data files Lectern should have an endpoint that can generate a TSV template file for any schema (or for every schema in a dictionary).

A TSV template file for a schema includes a header row with the field names from a schema separated by tabs. The file should be named with the schema name, ie. schema_name.tsv.

All templates for a dictionary can be generated following this pattern and then provided in a single zip file for download. The zip file should be named with the dictionary name and version number.

Detailed Description

Two endpoints needed:

  1. GET /dictionaries/:dictId/templates - Download all schema templates for dictionary in zip file.
  2. GET /dictionaries/:dictId/schemas/:schemaId/template - Download template for an individual schema
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-feature Request is a new feature
Projects
None yet
Development

No branches or pull requests

1 participant