RespuestaCodigos

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/boletinclaro-es/json-schema/boletinclaro-es-respuesta-codigos-schema.json",
  "title": "RespuestaCodigos",
  "description": "Envoltorio común de las respuestas de lista. No hay paginación: una búsqueda semántica ordena por parecido, y la fila 400 de un ranking así no significa nada.",
  "x-generated": "2026-11-02",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/boletinclaro-es-openapi.json#/components/schemas/RespuestaCodigos",
  "properties": {
    "busqueda": {
      "$ref": "#/$defs/SearchMetadata"
    },
    "consulta": {
      "description": "La consulta tal y como se aplicó, ya recortada si venía por encima del máximo.",
      "type": "string"
    },
    "resultados": {
      "description": "Códigos encontrados, agrupados por catálogo.",
      "items": {
        "$ref": "#/$defs/Codigo"
      },
      "type": "array"
    },
    "total": {
      "description": "Cuántas filas trae ESTA respuesta. No es cuántas hay en total.",
      "type": "integer"
    }
  },
  "required": [
    "total",
    "resultados"
  ],
  "type": "object",
  "$defs": {
    "Codigo": {
      "description": "Un código de clasificación que encaja con la descripción buscada.",
      "properties": {
        "codigo": {
          "type": "string"
        },
        "descripcion": {
          "type": "string"
        },
        "division": {
          "description": "Etiqueta de jerarquía del catálogo (CPV y CNAE).",
          "type": "string"
        },
        "grupo": {
          "description": "Etiqueta de jerarquía del catálogo (IAE).",
          "type": "string"
        },
        "seccion": {
          "description": "Etiqueta de jerarquía del catálogo (CNAE e IAE).",
          "type": "string"
        },
        "tipo": {
          "description": "Catálogo del que sale el código.",
          "enum": [
            "cpv",
            "cnae",
            "iae"
          ],
          "type": "string"
        }
      },
      "required": [
        "tipo",
        "codigo",
        "descripcion"
      ],
      "type": "object"
    },
    "SearchMetadata": {
      "properties": {
        "candidatos_leidos": {
          "type": "integer"
        },
        "grupos_consulta": {
          "type": "integer"
        },
        "limite_candidatos": {
          "type": "integer"
        },
        "truncada": {
          "description": "La selección de candidatos o el resultado se recortó; no es una exportación exhaustiva.",
          "type": "boolean"
        }
      },
      "required": [
        "limite_candidatos",
        "candidatos_leidos",
        "grupos_consulta",
        "truncada"
      ],
      "type": "object"
    }
  }
}