REST Metadata Plugins - IGN-CNIG/API-CNIG GitHub Wiki

Para la definición del REST y metadatos de un plugin es necesario especificar los atributos necesarios en el fichero /src/api.json. Ejemplo de definición:

{
  "url": {
    "name": "<miplugin>",
    "separator": "*" // Separador que se utilizará para definir los parámetros.
  },
  "constructor": "M.plugin.Miplugin", // Contructor del plugin
  "parameters": [
    {
      "type": "object",
      "properties": [ // definición de parámetros
        {
          "type": "simple",
          "name": "position",
          "position": 0,
          "possibleValues": [
            "TL",
            "TR",
            "BR",
            "BL"
          ]
        },
        {
          "type": "simple",
          "name": "tooltip",
          "position": 1
        },
      ...
      ]
    }
  ],
  "files": { // ficheros a importar para usar el plugin
    "ol": {
      "scripts": [
        "miplugin.ol.min.js"
      ],
      "styles": [
        "miplugin.ol.min.css"
      ]
    }
  },
  "metadata": {
    "name": "Miplugin",
    "description": "descripción",
    "version": "versión",
    "date": "fecha",
    "author": "autor",
    "org": "organización",
    "tags": "tags"
  }
}
⚠️ **GitHub.com Fallback** ⚠️