nasa / nasa/api-docs

Feature Request: Comprehensive OpenAPI (Swagger) Documentation

Open
#234 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
SCSS
Stars
555
Forks
140
Avg merge
2h 30m
Merged PRs (30d)
3

Description

Description

This issue proposes the creation of a comprehensive OpenAPI 3.x (formerly Swagger) specification for all the APIs managed within this repository.

While the repository currently provides individual documentation and a central apis.json file, a unified OpenAPI document would offer a machine-readable standard for all NASA APIs. This would serve as a single source of truth, detailing all available endpoints, request/response schemas, authentication methods, and other essential metadata.

Motivation

Adopting a comprehensive OpenAPI specification would significantly enhance the developer experience and usability of NASA's APIs for several key reasons:

  • Improved Discoverability & Usability: A single, standardized document makes it far easier for developers to explore and understand the full capabilities of all available NASA APIs without having to navigate multiple pages or formats.
  • Automated Tooling: OpenAPI is the industry standard for REST APIs and is supported by a vast ecosystem of tools. Developers can use it to automatically generate interactive API documentation (like Swagger UI or Redoc), client SDKs in various programming languages, and server stubs.
  • Easier Integration: A machine-readable specification simplifies the process of integrating NASA's data into applications. It reduces the manual effort required to write and test API calls, leading to faster development cycles and fewer errors.

Contributor guide

Open the contributing guide

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 by reviewing the repository's individual API documentation and central apis.json file to determine the current coverage and metadata. Define the scope and structure of a unified OpenAPI 3.x document, including endpoints, request and response schemas, authentication, and metadata. Done means all APIs managed in the repository are represented in one machine-readable specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
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.