NatLabRockies / NatLabRockies/developer.nlr.gov

Use of coded values in the API calls and responses

Open
#7 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ux-feedback
Dominant language
HTML
Stars
60
Forks
57
Avg merge
1d 21h
Merged PRs (30d)
3

Description

Feedback from our API Usability Testing: Using less code values or more descriptive code values would make the APIs easier to use. An example of coded values can be seen in the alt fuel stations api. There you would pass in status=E for only open stations, which is not descriptive or intuitive. Something like status=open would be easier to understand. Some of our other code values might be slightly more descriptive, but they could definitely use improving (for example, in fuel types, CNG is a common abbreviation for compressed natural gas, but BD isn't necessarily as obvious for biodiesel).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Begin with the linked API Usability Testing feedback and the alt fuel stations API example, then identify which APIs and coded values are in scope. No repository file or test is named, so confirm the affected entry points and expected mappings before changing anything. Done means the agreed values are more descriptive and consistent in API calls and responses.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.