Should k8s services be documented here?

[gothub]

• Should the services that are available at https://api.dataone.org be documented in this repo? Currently there is:

  • https://api.dataone.org/quality
  • https://api.dataone.org/slinky

• GNIS is running on k8s prod, but is at the endpoint https://gnis-ld.org. Should that be includes as well?

• For metadig, should the SwaggerHub definition be exported and included here?

• For metadig, should the SwaggerHub definition be exported and copied to the metadig git repo?

  • should the API be published here, essentially making it public

• What other info besides the API definition should be documented here?

  • example URLS and resulting returned values?

[mbjones]

Some initial swaggerhub APIs that might be useful:

• DataONE: https://app.swaggerhub.com/apis-docs/mbjones/dataone/2.0.0#/
• Bookkeeper: https://app.swaggerhub.com/apis/dataoneorg/bookkeeper/v1
• Metrics: https://app.swaggerhub.com/apis-docs/nenuji/data-metrics/1.0.0.5?loggedInWithGitHub=true
• MetaDIG: https://app.swaggerhub.com/apis/mbjones/metadig/2.0.0-a1

[mbjones]

We discovered both dataoneorg and NCEAS swaggerhub accounts. Peter is working on getting credentials for these into our credentials system.

Some more APIs we have discovered:

• MetaDIG (newer): https://app.swaggerhub.com/apis/gothub/metadig/v2.3.0
• Metrics: https://app.swaggerhub.com/apis/NCEAS/data-metrics/1.0.0
• Bookkeeper: https://app.swaggerhub.com/apis/dataoneorg/bookkeeper/1.0.0
• Bookkeeper: https://app.swaggerhub.com/apis/csjx/dataone-bookkeeper/1.0.0