NatLabRockies / NatLabRockies/api-umbrella

Available APIs listing

Open
#53 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
2.2k
Forks
373
PR merge metrics
No merged PRs in 30d

Description

Story

As a Developer (API Consumer)
I would like a page to list details available APIs
So that I can determine which APIs I can use

Example usage

I want to view available APIs, so I

  1. Access the API Umbrella portal
  2. Click a link to view available APIs
  3. Determine how to access the desired APIs (i.e. whether an API key is necessary)

Dependencies

  • Pre-configured APIs (already set up by API Manager)
  • Authorization

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

Start at the API Umbrella portal entry point and review how pre-configured APIs and authorization are exposed. Done means a page lets API consumers view available API details and determine how to access each one, including whether an API key is required.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.