OpenAPI/AsyncAPI detection matches `"openapi":`/`asyncapi:` keys inside JSON Schemas that describe OpenAPI documents, and redocly.yaml's theme section

Aperta
  • Qualcosa non va?
#272 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
Mezza giornata
Idoneità per principianti
65/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
openapi, python
Ambito
devtools

Direzione di ricerca

The detection regex is at project_validator/ecosystems/openapi.py line 50, and REDOCLY_SETTINGS is near line 170 of the same file. Start by reading how the OpenAPI profile chooses which files to scan, then run the repro from the issue (a JSON Schema with a nested openapi property, and a redocly.yaml with a top-level openapi: key). Done means both files are no longer treated as API descriptions, and real openapi.yaml files still pass.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

^\s{0,4}"(?:openapi|swagger)": matches a property key in SchemaStore's openapi-3.X.json, asyncapi's definitions/*/asyncapi.json and OAI's _archive_/schemas/v2.0/schema.json (JSON Schemas about OpenAPI), so schema repositories are judged as API-description projects and FAIL schema-declared ("5 OpenAPI files do not declare their version"); Redocly's redocly.yaml has a top-level openapi: theme section and FAILs "no info.version". An OpenAPI document has openapi: "3.x" as a string value (or swagger: "2.0") and info:; a schema has $schema/type/properties.

Evidence from the corpus audit

SchemaStore/schemastore, asyncapi/spec-json-schemas, OAI/OpenAPI-Specification / schema-declared (and detection)
  • kind: FALSE_POSITIVE
  • actual: FAIL: OpenAPI/AsyncAPI: 5 OpenAPI files do not declare their version (openapi) and info.version
    (SchemaStore); OpenAPI/AsyncAPI: 14 AsyncAPI files do not declare their version (asyncapi) and info.version
    (spec-json-schemas); OpenAPI/AsyncAPI: 1 OpenAPI file does not declare its version … _archive_/schemas/v2.0/schema.json: no openapi (OAI)
  • expected: the files are JSON Schemas that describe OpenAPI/AsyncAPI documents (or a Kustomization), not
    descriptions; they should not be found by the OpenAPI/AsyncAPI profile at all, and SchemaStore and
    spec-json-schemas should not be "OpenAPI/AsyncAPI" projects (which also yields their static-analysis,
    schema-validation, schema-compatibility and schema-examples OpenAPI FAIL/WARN lines).
  • evidence: project_validator/ecosystems/openapi.py:50:
    OPENAPI: re.compile(r"^(?:openapi|swagger)\s*:|^\s{0,4}\"(?:openapi|swagger)\"\s*:", re.MULTILINE) matches a
    property key indented by 4 spaces inside "properties" or "required".
    SchemaStore src/schemas/json/openapi-3.X.json:2: "$schema": "https://json-schema.org/draft/2020-12/schema",
    and :8: "openapi": {; src/schemas/json/grpc-api-gateway.json:9: "openapi": {;
    src/test/kustomization/openapi.json:4: "openapi": { (a Kustomization).
    spec-json-schemas definitions/1.0.0/asyncapi.json:3: "$schema": "http://json-schema.org/draft-04/schema#",
    and :18: "asyncapi": {.
    OAI _archive_/schemas/v2.0/schema.json:3: "$schema": "http://json-schema.org/draft-04/schema#", and :18:
    "swagger": {.
  • repro: a file openapi-schema.json with {"$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {\n "openapi": {"type": "string"}}}; the project is detected as OpenAPI and the file fails
    schema-declared with "no openapi" and "no info.version". A fix is to require the key at the top level (parse the
    head, or at most 2 spaces of indentation and not inside properties), or to exclude files that are JSON Schemas.
  • confidence: high
Redocly/openapi-starter / schema-declared
  • kind: FALSE_POSITIVE
  • actual: FAIL: 1 OpenAPI file does not declare its version (openapi) and info.version / redocly.yaml: no info.version
  • expected: PASS: redocly.yaml is the Redocly CLI configuration; its top-level openapi: key is Redocly's
    documentation-theme section, not a specification version. The one real description, openapi/openapi.yaml,
    declares both.
  • evidence: redocly.yaml:1: # See https://redocly.com/docs/cli/configuration/ for more information.;
    redocly.yaml:2-4: apis: / sample@v1: / root: openapi/openapi.yaml; redocly.yaml:11: openapi:;
    openapi/openapi.yaml:1: openapi: 3.1.0, :7: version: 1.0.0. The same regex as above
    (project_validator/ecosystems/openapi.py:50) matches openapi: at column 0 regardless of its value.
  • repro: redocly.yaml with apis: {a: {root: openapi.yaml}}\nopenapi:\n codeSamples: {} next to a valid
    openapi.yaml. A fix is to exclude the known Redocly config names (REDOCLY_SETTINGS already lists them,
    openapi.py:170) and/or require the key's value to look like a version (openapi: 3.x, swagger: "2.0").
  • confidence: high

Found by the regression-corpus audit (235 real repositories, one or more per ecosystem profile; corpus and expected results in corpus/). Evidence is quoted from the audited checkouts at the commits pinned in corpus/projects.toml; <checkouts>/<owner>__<repo> is such a checkout.

🤖 Generated with Claude Code

https://claude.ai/code/session_01ByTXNqDWdM7HzezrFtEvQt

Lingua principale
Python
Stelle
4
Fork
1
Merge medio
10h 41m
PR unite (30g)
79

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di cpp-best-practices/project_validator

Tutte le issue di cpp-best-practices/project_validator

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.