opengeospatial / opengeospatial/bblocks

Organizing building blocks by type first?

Open
#2 16 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
4
Forks
4
PR merge metrics
No merged PRs in 30d

Description

I feel it would make things a lot easier to maintain if we used as top-level subdirectories the following list:

  • apiSpec (inside could be sub-directory for each part, and inside could be each conformance class)
  • paths
  • responses
  • schemas
  • queryParameters
  • requestHeaders
  • responseHeaders

This should make it easier to import and synchronize the different building blocks from existing specs which already use several of these directories, e.g.:

Entries in the registry should probably be in a machine-readable form like JSON rather than ASCIIDoc (to implement organization / filtering by type etc.), including all the properties needed to efficiently support the building blocks registry.
e.g., following properties could be included:

  • title
  • description
  • maturity
  • isGeoSpatial
  • originatingSpec
  • schema / definition
  • ...

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

Compare the linked OGC API OpenAPI directories to understand the proposed building-block organization, then inspect how the current registry is represented in ASCIIDoc. The scope is complete only once the project agrees on the directory structure and the machine-readable registry properties and format.

Written by the indexing model from the issue text.

Assessment

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