microsoft / microsoft/adme-samples

Validation error on the adme-samples

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

Nobody has claimed this yet.

Dominant language
Shell
Stars
17
Forks
23
PR merge metrics
No merged PRs in 30d

Description

We noticed the validation error on the adme-samples APIs (Azure Data Manager for Energy – Samples) listed below, which are APIs in this documents Azure Data Manager for Energy - Samples | adme-samples (microsoft.github.io)

CRS Catalog Service - https://microsoft.github.io/adme-samples/rest-apis/crs-catalog-openapi-v2.yaml
CRS Conversion Service - https://microsoft.github.io/adme-samples/rest-apis/crs_converter_openapi.yaml
Indexer Service - https://microsoft.github.io/adme-samples/rest-apis/indexer_openapi.yaml
Notification Service - https://microsoft.github.io/adme-samples/rest-apis/notification_openapi.yaml
Register Service - https://microsoft.github.io/adme-samples/rest-apis/register_openapi.yaml
Search Service - https://microsoft.github.io/adme-samples/rest-apis/search_openapi.yaml
Seismic DDMS Service - https://microsoft.github.io/adme-samples/rest-apis/seismic_ddms_openapi.yaml
Unit Service - https://microsoft.github.io/adme-samples/rest-apis/index.html?page=/adme-samples/rest-apis/unit_service_openapi_v3.yaml

The issue we observed is that some reference in the samples are missing. For example, if I validate the API https://microsoft.github.io/adme-samples/rest-apis/search_openapi.yaml with the Swagger & OpenAPI Online Validator | Swagger Parser (apitools.dev). We can see many errors about missing reference.

image

for the one highlighted above, I checked in the https://microsoft.github.io/adme-samples/rest-apis/search_openapi.yaml and no reference refer to definition/versionInfo.
image

For those APIs, we observed similar issues in validation. Any suggestions?

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 by validating rest-apis/search_openapi.yaml with the Swagger Parser validator and inspect the unresolved references reported there. Compare the referenced definitions with the other listed OpenAPI files, including crs-catalog-openapi-v2.yaml, crs_converter_openapi.yaml, indexer_openapi.yaml, notification_openapi.yaml, register_openapi.yaml, seismic_ddms_openapi.yaml, and unit_service_openapi_v3.yaml. Done means the affected samples validate without missing-reference errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.