Compartilhar via

Features - Get Api Definition

  • Referência
Serviço:
Maps Creator
Versão da API:
2023-03-01-preview

Use para obter uma descrição dos recursos do serviço Recursos.

Observação

Desativação do Criador do Azure Mapas

O serviço de mapa do interior do Criador do Azure Mapas foi preterido e será desativado em 30/09/25. Para obter mais informações, confira Comunicado de fim de vida útil do Criador do Azure Mapas.

A API de Get API Definition é uma solicitação HTTP GET que retorna detalhes dos recursos de cada API no serviço Recursos, incluindo o tipo de solicitação (GET ou POST) um description, operationId, parameterse responses. Ele pode ser usado pelos desenvolvedores para entender a API ou ferramentas de desenvolvimento para dar suporte à implementação de servidores e clientes.

A API de Recursos faz parte do Creator, o que possibilita desenvolver aplicativos com base em seus dados de mapa interno privados usando a API e o SDK do Azure Mapas. As APIs get de recursos seguem a API do Open Geospatial Consortium – Recursos – Parte 1: Padrão de de corrigêmio principal para consultar conjuntos de dados. Os conjuntos de dados consistem em várias coleções de recursos, que são um agrupamento de recursos definidos por um esquema comum.

GET https://{geography}.atlas.microsoft.com/features/datasets/{datasetId}/api?api-version=2023-03-01-preview

Parâmetros de URI

Nome Em Obrigatório Tipo Description
datasetId
 path True

string

O identificador do conjunto de dados do qual consultar.
geography
 path True

string

Esse parâmetro especifica onde o recurso criador do Azure Mapas está localizado. Valores válidos são nós e eu.
api-version
 query True

string

Número de versão da API do Azure Mapas.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-client-id

string

Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança da ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança da ID do Microsoft Entra no Azure Mapas, consulte os artigos de a seguir para obter diretrizes.

Respostas

Nome Tipo Description
200 OK

ApiDefinitionResult

Okey
Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estas são as fluxos de do Azure Active Directory OAuth2. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de controlar o acesso em APIs e escopos específicos.

Anotações

  • Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de Autorização exclusivas e configurações do Azure Active Directory. * O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

  • Atualmente, o Azure Active Directory v1.0 ou v2.0 dá suporte a Trabalho, Escola e Convidados, mas não dá suporte a contas pessoais.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Essa é uma chave compartilhada provisionada ao criar um recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como chaves mestras para a conta para a qual são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor a servidor de APIs REST do Azure Mapas, em que essa chave pode ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais protegida do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta de mapa de para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

GetApiDefinition

Solicitação de exemplo

GET https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/api?api-version=2023-03-01-preview

Resposta de exemplo

Código de status:
200 
{
  "openapi": "3.0.1",
  "info": {
    "title": "Azure Maps Web Feature Service",
    "version": "2023-03-01-preview",
    "description": "Azure Maps Web Feature REST APIs"
  },
  "paths": {
    "/features/datasets/{datasetId}/": {
      "get": {
        "summary": "landing page of this API",
        "description": "The landing page provides links to the API definition, the Conformance statements and the information about the feature data in this dataset.",
        "operationId": "getLandingPage",
        "tags": [
          "Capabilities"
        ],
        "parameters": [
          {
            "$ref": "#/responses/200/body/components/parameters/datasetId"
          }
        ],
        "responses": {
          "200": {
            "description": "links to the API capabilities",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/root"
                }
              }
            }
          }
        }
      }
    },
    "/features/datasets/{datasetId}/api": {
      "get": {
        "summary": "the API definition for this service",
        "operationId": "getApiDefinition",
        "tags": [
          "Capabilities"
        ],
        "parameters": [
          {
            "$ref": "#/responses/200/body/components/parameters/datasetId"
          }
        ],
        "responses": {
          "200": {
            "description": "the API definition"
          },
          "default": {
            "description": "An error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/exception"
                }
              }
            }
          }
        }
      }
    },
    "/features/datasets/{datasetId}/conformance": {
      "get": {
        "summary": "information about standards that this API conforms to",
        "description": "list all requirements classes specified in a standard (e.g., Features Part 1: Core) that the server conforms to",
        "operationId": "getRequirementsClasses",
        "tags": [
          "Capabilities"
        ],
        "parameters": [
          {
            "$ref": "#/responses/200/body/components/parameters/datasetId"
          }
        ],
        "responses": {
          "200": {
            "description": "the URIs of all requirements classes supported by the server",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/req-classes"
                }
              }
            }
          },
          "default": {
            "description": "An error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/exception"
                }
              }
            }
          }
        }
      }
    },
    "/features/datasets/{datasetId}/collections": {
      "get": {
        "summary": "describe the feature collections in the dataset",
        "operationId": "describeCollections",
        "tags": [
          "Capabilities"
        ],
        "parameters": [
          {
            "$ref": "#/responses/200/body/components/parameters/datasetId"
          }
        ],
        "responses": {
          "200": {
            "description": "Information about the feature collections shared by this API.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/content"
                }
              }
            }
          },
          "default": {
            "description": "An error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/exception"
                }
              }
            }
          }
        }
      }
    },
    "/features/datasets/{datasetId}/collections/{collectionId}": {
      "get": {
        "summary": "describe the {collectionId} feature collection",
        "operationId": "describeCollection",
        "tags": [
          "Capabilities"
        ],
        "parameters": [
          {
            "$ref": "#/responses/200/body/components/parameters/datasetId"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/collectionId"
          }
        ],
        "responses": {
          "200": {
            "description": "Information about the {collectionId} collection shared by this API.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/collectionInfo"
                }
              }
            }
          },
          "default": {
            "description": "An error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/exception"
                }
              }
            }
          }
        }
      }
    },
    "/features/datasets/{datasetId}/collections/{collectionId}/definition": {
      "get": {
        "summary": "describe the {collectionId} feature collection",
        "operationId": "definitionCollection",
        "tags": [
          "Capabilities"
        ],
        "parameters": [
          {
            "$ref": "#/responses/200/body/components/parameters/datasetId"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/collectionId"
          }
        ],
        "responses": {
          "200": {
            "description": "Metadata about the {collectionId} collection shared by this API.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/collectionDefinition"
                }
              }
            }
          },
          "default": {
            "description": "An error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/exception"
                }
              }
            }
          }
        }
      }
    },
    "/features/datasets/{datasetId}/collections/{collectionId}/items": {
      "get": {
        "summary": "retrieve features of feature collection {collectionId}",
        "description": "Every feature in a dataset belongs to a collection. A dataset may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema.",
        "operationId": "getFeatures",
        "tags": [
          "Features"
        ],
        "parameters": [
          {
            "$ref": "#/responses/200/body/components/parameters/datasetId"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/collectionId"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/limit"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/bbox"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/time"
          }
        ],
        "responses": {
          "200": {
            "description": "Information about the feature collection plus the first features matching the selection parameters.",
            "content": {
              "application/geo+json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/featureCollectionGeoJSON"
                }
              }
            }
          },
          "default": {
            "description": "An error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/exception"
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "create feature for feature collection {collectionId}",
        "description": "Create a single feature of unique id in the given collection.",
        "operationId": "postFeatures",
        "tags": [
          "Features"
        ],
        "parameters": [
          {
            "$ref": "#/responses/200/body/components/parameters/datasetId"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/collectionId"
          }
        ],
        "responses": {
          "201": {
            "description": "Id of the created feature and its reference links.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "links": {
                      "type": "array",
                      "items": {
                        "$ref": "#/responses/200/body/components/schemas/link"
                      }
                    }
                  }
                }
              }
            }
          },
          "default": {
            "description": "An error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/exception"
                }
              }
            }
          }
        }
      }
    },
    "/features/datasets/{datasetId}/collections/{collectionId}/items/{featureId}": {
      "get": {
        "summary": "retrieve a feature",
        "operationId": "getFeature",
        "tags": [
          "Features"
        ],
        "parameters": [
          {
            "$ref": "#/responses/200/body/components/parameters/datasetId"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/collectionId"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/featureId"
          }
        ],
        "responses": {
          "200": {
            "description": "A feature.",
            "content": {
              "application/geo+json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/featureGeoJSON"
                }
              }
            }
          },
          "default": {
            "description": "An error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/exception"
                }
              }
            }
          }
        }
      },
      "delete": {
        "summary": "delete a feature",
        "operationId": "deleteFeature",
        "tags": [
          "Features"
        ],
        "parameters": [
          {
            "$ref": "#/responses/200/body/components/parameters/datasetId"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/collectionId"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/featureId"
          }
        ],
        "responses": {
          "204": {
            "description": "Feature deleted."
          }
        }
      },
      "put": {
        "summary": "replace feature metadata",
        "operationId": "putFeature",
        "tags": [
          "Features"
        ],
        "parameters": [
          {
            "$ref": "#/responses/200/body/components/parameters/datasetId"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/collectionId"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/featureId"
          }
        ],
        "responses": {
          "204": {
            "description": "Feature metadata replaced."
          },
          "default": {
            "description": "An error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/exception"
                }
              }
            }
          }
        }
      },
      "patch": {
        "summary": "update feature metadata",
        "operationId": "patchFeature",
        "tags": [
          "Features"
        ],
        "parameters": [
          {
            "$ref": "#/responses/200/body/components/parameters/datasetId"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/collectionId"
          },
          {
            "$ref": "#/responses/200/body/components/parameters/featureId"
          }
        ],
        "responses": {
          "200": {
            "description": "Feature metadata updated."
          },
          "default": {
            "description": "An error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/responses/200/body/components/schemas/exception"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "datasetId": {
        "name": "datasetId",
        "in": "path",
        "description": "The identifier for the database to query from",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "limit": {
        "name": "limit",
        "in": "query",
        "description": "The optional limit parameter limits the number of items that are\npresented in the response document.\n\nOnly items are counted that are on the first level of the collection in\nthe response document. Nested objects contained within the explicitly\nrequested items shall not be counted.\n\n* Minimum = 1\n* Maximum = 500\n* Default = 10\n",
        "required": false,
        "schema": {
          "type": "integer",
          "minimum": 1,
          "maximum": 500,
          "default": 10
        },
        "style": "form",
        "explode": false
      },
      "bbox": {
        "name": "bbox",
        "in": "query",
        "description": "Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (elevation or depth):\n* Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Lower left corner, coordinate axis 3 (optional) * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2 * Upper right corner, coordinate axis 3 (optional)\nThe coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter `bbox-crs`.\nFor WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).\n",
        "required": false,
        "schema": {
          "type": "array",
          "minItems": 4,
          "maxItems": 6,
          "items": {
            "type": "number"
          }
        },
        "style": "form",
        "explode": false
      },
      "time": {
        "name": "time",
        "in": "query",
        "description": "Either a date-time or a period string that adheres to RFC 3339. Examples:\n* A date-time: \"2018-02-12T23:20:50Z\" * A period: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\" or \"2018-02-12T00:00:00Z/P1M6DT12H31M12S\"\nOnly features that have a temporal property that intersects the value of `time` are selected.",
        "required": false,
        "schema": {
          "type": "string"
        },
        "style": "form",
        "explode": false
      },
      "collectionId": {
        "name": "collectionId",
        "in": "path",
        "required": true,
        "description": "Identifier (name) of a specific collection",
        "schema": {
          "type": "string"
        }
      },
      "featureId": {
        "name": "featureId",
        "in": "path",
        "description": "Identifier of a specific feature",
        "required": true,
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "exception": {
        "type": "object",
        "required": [
          "code"
        ],
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            }
          }
        }
      },
      "root": {
        "type": "object",
        "required": [
          "links"
        ],
        "properties": {
          "links": {
            "type": "array",
            "items": {
              "$ref": "#/responses/200/body/components/schemas/link"
            },
            "example": [
              {
                "href": "http://data.example.org/",
                "rel": "self",
                "type": "application/json",
                "title": "Azure Maps Features"
              },
              {
                "href": "http://data.example.org/api",
                "rel": "service-desc",
                "type": "application/openapi+json;version=3.0",
                "title": "The API definition"
              },
              {
                "href": "http://data.example.org/conformance",
                "rel": "conformance",
                "type": "application/json",
                "title": "Conformance classes implemented by Features"
              },
              {
                "href": "http://data.example.org/collections",
                "rel": "data",
                "type": "application/json",
                "title": "information about the feature collections"
              }
            ]
          }
        }
      },
      "req-classes": {
        "type": "object",
        "required": [
          "conformsTo"
        ],
        "properties": {
          "conformsTo": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core",
              "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas3",
              "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson"
            ]
          }
        }
      },
      "link": {
        "type": "object",
        "required": [
          "href"
        ],
        "properties": {
          "href": {
            "type": "string"
          },
          "rel": {
            "type": "string",
            "example": "prev"
          },
          "type": {
            "type": "string",
            "example": "application/geo+json"
          },
          "hreflang": {
            "type": "string",
            "example": "en"
          }
        }
      },
      "content": {
        "type": "object",
        "required": [
          "links",
          "collections"
        ],
        "properties": {
          "links": {
            "type": "array",
            "items": {
              "$ref": "#/responses/200/body/components/schemas/link"
            },
            "example": [
              {
                "href": "http://data.example.org/collections.json",
                "rel": "self",
                "type": "application/json",
                "title": "this document"
              },
              {
                "href": "http://schemas.example.org/1.0/foobar.xsd",
                "rel": "describedBy",
                "type": "application/xml",
                "title": "XML schema for Acme Corporation data"
              }
            ]
          },
          "collections": {
            "type": "array",
            "items": {
              "$ref": "#/responses/200/body/components/schemas/collectionInfo"
            }
          }
        }
      },
      "versionInfo": {
        "type": "object",
        "required": [
          "version",
          "revisionTimestamp"
        ],
        "properties": {
          "version": {
            "description": "version number of the dataset",
            "type": "string",
            "example": "1.0.0"
          },
          "revisionTimestamp": {
            "description": "timestamp of the revision",
            "type": "string",
            "example": "2020-01-02T03:04:05.6789012Z"
          }
        }
      },
      "collectionInfo": {
        "type": "object",
        "required": [
          "name",
          "links"
        ],
        "properties": {
          "id": {
            "description": "identifier of the collection used, for example, in URIs",
            "type": "string",
            "example": "buildings"
          },
          "title": {
            "description": "human readable title of the collection",
            "type": "string",
            "example": "Buildings"
          },
          "itemType": {
            "description": "indicator about the type of the items in the collection",
            "type": "string",
            "example": "feature"
          },
          "description": {
            "description": "a description of the features in the collection",
            "type": "string",
            "example": "Buildings in the city of Bonn."
          },
          "links": {
            "type": "array",
            "items": {
              "$ref": "#/responses/200/body/components/schemas/link"
            },
            "example": [
              {
                "href": "http://data.example.org/collections/buildings/items",
                "rel": "item",
                "type": "application/geo+json",
                "title": "Buildings"
              }
            ]
          }
        }
      },
      "collectionDefinition": {
        "type": "object",
        "required": [
          "id",
          "itemType",
          "geometryType"
        ],
        "properties": {
          "id": {
            "description": "identifier of the collection used, for example, in URIs",
            "type": "string",
            "example": "buildings"
          },
          "title": {
            "description": "title of the collection used",
            "type": "string",
            "example": "buildings"
          },
          "itemType": {
            "description": "indicator about the type of the items in the collection",
            "type": "string",
            "example": "feature"
          },
          "description": {
            "description": "title of collection",
            "type": "string",
            "example": "Feature Class buildings"
          },
          "geometryType": {
            "description": "type of geometry returned",
            "type": "string",
            "enum": [
              "Point",
              "MultiPoint",
              "LineString",
              "MultiLineString",
              "Polygon",
              "MultiPolygon",
              "GeometryCollection"
            ]
          },
          "properties": {
            "description": "attributes of the collection used",
            "type": "array",
            "items": {
              "$ref": "#/responses/200/body/components/schemas/definitionProperties"
            }
          }
        }
      },
      "definitionProperties": {
        "type": "object",
        "required": [
          "name",
          "required",
          "type"
        ],
        "properties": {
          "name": {
            "description": "name of attribute",
            "type": "string",
            "example": "external_id"
          },
          "required": {
            "description": "is attribute required",
            "type": "boolean"
          },
          "type": {
            "description": "type of attribute",
            "type": "object"
          }
        }
      },
      "featureCollectionGeoJSON": {
        "type": "object",
        "required": [
          "type",
          "features"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "FeatureCollection"
            ]
          },
          "features": {
            "type": "array",
            "items": {
              "$ref": "#/responses/200/body/components/schemas/featureGeoJSON"
            }
          },
          "links": {
            "type": "array",
            "items": {
              "$ref": "#/responses/200/body/components/schemas/link"
            }
          },
          "timeStamp": {
            "type": "string",
            "format": "dateTime"
          },
          "numberMatched": {
            "type": "integer",
            "minimum": 0
          },
          "numberReturned": {
            "type": "integer",
            "minimum": 0
          }
        }
      },
      "featureGeoJSON": {
        "type": "object",
        "required": [
          "type",
          "geometry",
          "properties"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "Feature"
            ]
          },
          "geometry": {
            "$ref": "#/responses/200/body/components/schemas/geometryGeoJSON"
          },
          "properties": {
            "type": "object",
            "nullable": true
          },
          "id": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "integer"
              }
            ]
          }
        }
      },
      "geometryGeoJSON": {
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "Point",
              "MultiPoint",
              "LineString",
              "MultiLineString",
              "Polygon",
              "MultiPolygon",
              "GeometryCollection"
            ]
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Capabilities",
      "description": "Essential characteristics of this API including information about the data."
    },
    {
      "name": "Features",
      "description": "Access to data (features)."
    }
  ]
}

Definições

Nome Description
ApiDefinitionResult

Resposta após uma solicitação bem-sucedida para obter a definição da API.
Components

O objeto de componentes OpenAPI.
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
Info

O objeto de informações OpenAPI.
Tags

O objeto de marcas OpenAPI.

ApiDefinitionResult

Objeto

Resposta após uma solicitação bem-sucedida para obter a definição da API.

Nome Tipo Description
components

Components

O objeto de componentes OpenAPI.
info

Info

O objeto de informações OpenAPI.
openapi

string

A versão do OpenAPI.
paths

object

O objeto de caminhos OpenAPI.
tags

Tags[]

O objeto de marcas OpenAPI.

Components

Objeto

O objeto de componentes OpenAPI.

Nome Tipo Description
parameters

object

O objeto de parâmetros OpenAPI.
schemas

object

O objeto de esquemas OpenAPI.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

Info

Objeto

O objeto de informações OpenAPI.

Nome Tipo Description
description

string

A descrição da API.
title

string

O título da API.
version

string

A versão da API.

Tags

Objeto

O objeto de marcas OpenAPI.

Nome Tipo Description
description

string

A descrição da marca.
name

string

O nome da marca.