Greenstand/treetracker-query-api

Fix title of *.yaml file

Open

#59 opened on Jan 26, 2022

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)TypeScript (65 forks)auto 404
good first issue

Repository metrics

Stars
 (17 stars)
PR merge metrics
 (PR metrics pending)

Description

In the repo for the treetracker-query-api, in /docs/api/spec/ The file query-api.yaml says: "title: web map api" That's confusing. It seems the title should be: "Treetracker query API" As we work to use *.yaml specifications to generate documentation it will become important that *.yaml files accurately describe their APIs

Contributor guide

Research direction
Open the file /docs/api/spec/query api.yaml and change the title from 'web map api' to 'Treetracker query API'.
Tech stack
typescript
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95