squidmaps

Read this first when someone wants a map: of places, a route or an area, or of data like a CSV or GeoJSON, to look at or to share with a link. It's how squidmaps maps are written: GeoJSON features, how they're styled, and their popups, title panel and legend. Then make the map with create_map.

{
  "type": "object",
  "properties": {}
}

Make a web map of places, routes or areas, and get a link anyone can open to see it, with no code and no account. Write it as the map document get_map_spec describes. The link works for an hour after the map last changed; opening it, the person can add the map to their squidmaps account to keep it, publish it and share it for good. Returns an id and editToken: keep them, to change this map with update_map rather than making another.

{
  "type": "object",
  "properties": {
    "map": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {},
      "description": "A squidmaps map document (see get_map_spec): \"features\" (GeoJSON features, styled with \"@\" properties), and optionally \"name\", \"description\", \"basemap\", \"extent\", \"view\" and \"legend\"."
    }
  },
  "required": [
    "map"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Change a map made with create_map when the person asks for changes, keeping its link: anyone who has the link sees the change, and it keeps working another hour. Send the whole changed map document, not just what changed: it replaces the map. Fails once someone has added the map to their account.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The map's id, from create_map"
    },
    "editToken": {
      "type": "string",
      "description": "The editToken from create_map"
    },
    "map": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {},
      "description": "A squidmaps map document (see get_map_spec): \"features\" (GeoJSON features, styled with \"@\" properties), and optionally \"name\", \"description\", \"basemap\", \"extent\", \"view\" and \"legend\"."
    }
  },
  "required": [
    "id",
    "editToken",
    "map"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

A picture of a map made with create_map, as people who open its link see it, to check it before you share the link: where things are, their styles, its title panel and legend. 1200×630 by default, the shape most people see it in. Ask for another size to fit the map's shape: taller (like 800×1000) for a map that runs north to south, wider (like 1000×600) for one that runs east to west. The picture shows what fits on a screen that size, so a larger one shows more of a large map. At most 1,000,000 pixels (width × height).

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The map's id, from create_map"
    },
    "width": {
      "description": "The picture's width, in pixels",
      "type": "integer",
      "minimum": 320,
      "maximum": 1600
    },
    "height": {
      "description": "The picture's height, in pixels",
      "type": "integer",
      "minimum": 240,
      "maximum": 1600
    }
  },
  "required": [
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}