liquid-labs / liquid-labs/orgs-model
Add 'meta' property to APIs
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Overview
Depends on updates to the federated-json package.
In order to better support downstream use cases, let's provide some self-awareness to the APIs.
Deliverables
- Move the
keyproperty tometa.key. - Add
meta.fieldswhich is something like{ field1: { required: true }whererequiredcan betrue,false, or'CONDITIONAL'. - Add
meta.schemawhich returns the schema for the fragment.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the API model definitions in orgs-model and the linked federated-json issue, since this work depends on that package update. Trace how the current key is exposed and how fragment schemas are represented. Done means key is under meta.key and the APIs expose meta.fields with the specified required values plus meta.schema.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100