Compartir a través de


Features - Get Api Definition

Use para obtener una descripción de las funcionalidades del servicio Características.

La Get API Definition API es una solicitud HTTP GET que devuelve detalles de las funcionalidades de cada API en el servicio Características, incluido el tipo de solicitud (GET o POST) un description, operationId, parametersy responses. Los desarrolladores pueden usarla para comprender la API o las herramientas de desarrollo para admitir la implementación de servidores y clientes.

La API de características forma parte de Creator, lo que permite desarrollar aplicaciones basadas en los datos privados del mapa interior mediante Azure Maps API y SDK. Características GET API siguen open Geospatial Consortium API - Features - Part 1: Core corrigendum standard to query Datasets. Los conjuntos de datos constan de varias colecciones de características, que son una agrupación de características definidas por un esquema común.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
datasetId
path True

string

Identificador del conjunto de datos desde el que se va a consultar.

geography
path True

string

Este parámetro especifica dónde se encuentra el recurso Azure Maps Creator. Los valores válidos son nosotros y eu.

api-version
query True

string

Número de versión de la API de Azure Maps.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-id

string

Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Microsoft Entra ID. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar Microsoft Entra ID seguridad en Azure Maps consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre Tipo Description
200 OK

ApiDefinitionResult

Aceptar

Other Status Codes

ErrorResponse

Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de OAuth2 de Azure Active Directory . Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. A cualquier usuario, grupo o entidad de servicio se le puede conceder acceso a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

  • Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.

Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Azure Active Directory. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST. * El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

  • Actualmente, Azure Active Directory v1.0 o v2.0 admite Cuentas profesionales, educativas e invitados, pero no admite cuentas personales.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Se trata de una clave compartida que se aprovisiona al crear un recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.

Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.

Para las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de Azure Maps API REST donde esta clave se puede almacenar de forma segura.

Type: apiKey
In: query

SAS Token

Se trata de un token de firma de acceso compartido que se crea a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.

Type: apiKey
In: header

Ejemplos

GetApiDefinition

Sample Request

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

Sample Response

{
  "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)."
    }
  ]
}

Definiciones

Nombre Description
ApiDefinitionResult

Respuesta después de una solicitud correcta para obtener la definición de la API.

Components

Objeto de componentes de OpenAPI.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

Info

Objeto de información de OpenAPI.

Tags

Objeto de etiquetas openAPI.

ApiDefinitionResult

Respuesta después de una solicitud correcta para obtener la definición de la API.

Nombre Tipo Description
components

Components

Objeto de componentes de OpenAPI.

info

Info

Objeto de información de OpenAPI.

openapi

string

La versión de OpenAPI.

paths

object

Objeto de rutas de acceso de OpenAPI.

tags

Tags[]

Objeto de etiquetas openAPI.

Components

Objeto de componentes de OpenAPI.

Nombre Tipo Description
parameters

object

Objeto de parámetros de OpenAPI.

schemas

object

Objeto de esquemas de OpenAPI.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.

type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Los detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

Info

Objeto de información de OpenAPI.

Nombre Tipo Description
description

string

Descripción de la API.

title

string

Título de la API.

version

string

La versión de la API.

Tags

Objeto de etiquetas openAPI.

Nombre Tipo Description
description

string

Descripción de la etiqueta.

name

string

Nombre de la etiqueta.