Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

inverseOperationIds removes schema properties named after HTTP methods (e.g. head)

Aperta Adatta ai principianti
  • Qualcosa non va?
#238 1 commento 0 reazioni 1 assegnatario Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
76/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript
Ambito
api, tooling

Direzione di ricerca

Inizia dalla logica di openapiFilter per il passaggio «Inverse operationIds without operationIds» e riproduci il problema con il documento OpenAPI fornito. Controlla la profondità di attraversamento utilizzata per le chiavi sotto paths, quindi verifica che il filtraggio di createPull conservi le proprietà dello schema head, base e get rimuovendo comunque l’operazione interessata. Dettaglio

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

Descrizione

bug

inverseOperationIds removes schema properties whose names are HTTP methods (head, get, post, …) when those properties are in inline schemas under paths, such as request bodies. The operation itself is kept, but it loses the properties.

This hit a real API: GitHub's "create a pull request" request body has a required head property, and inverseOperationIds: ['pulls/create'] strips it.

Reproduction (openapi-format 1.33.7, Node 24):

import { openapiFilter } from 'openapi-format';

const doc = {
  openapi: '3.0.3',
  info: { title: 't', version: '1' },
  paths: {
    '/pulls': {
      post: {
        operationId: 'createPull',
        requestBody: {
          content: {
            'application/json': {
              schema: {
                type: 'object',
                properties: {
                  head: { type: 'string' },
                  base: { type: 'string' },
                  get: { type: 'string' },
                },
              },
            },
          },
        },
        responses: { 201: { description: 'Created' } },
      },
    },
  },
};

const { data } = await openapiFilter(doc, {
  filterSet: { inverseOperationIds: ['createPull'] },
});
console.log(
  Object.keys(data.paths['/pulls'].post.requestBody.content['application/json'].schema.properties),
);

Expected: [ 'head', 'base', 'get' ]
Actual: [ 'base' ]

With filterSet: {} or { unusedComponents: ['schemas'] }, all three properties are kept.

Likely cause: in openapiFilter, the "Inverse operationIds without operationIds" step removes any node under paths whose key is in httpVerbs and that has no operationId:

inverseFilterProps.length > 0 &&
  this.path[0] === 'paths' &&
  node.operationId === undefined &&
  httpVerbs.includes(this.key)

It doesn't check depth, so it also matches schema properties inside operations. Restricting it to operation objects (for example this.path.length === 3, which is paths → path → method) should fix it.

Lingua principale
JavaScript
Stelle
177
Fork
30
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

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 thim81/openapi-format

Tutte le issue di thim81/openapi-format

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.