Features - Get Api Definition
Utilize para obter uma descrição das capacidades do serviço Funcionalidades.
A Get API Definition API é um pedido HTTP GET que devolve detalhes das capacidades de cada API no serviço Funcionalidades, incluindo o tipo de pedido (GET ou POST) um description, operationId, parameterse responses. Pode ser utilizado pelos programadores para compreender a API ou através de ferramentas de desenvolvimento para suportar a implementação de servidores e clientes.
A API de Funcionalidades faz parte do Criador, o que possibilita o desenvolvimento de aplicações com base nos dados privados do mapa interior com Azure Maps API e O SDK. As APIs GET de funcionalidades seguem a API Open Geospatial Consortium – Funcionalidades – Parte 1: Core corrigendum standard para consultar Conjuntos de Dados. Os conjuntos de dados consistem em várias coleções de funcionalidades, que são um agrupamento de funcionalidades definidas por um esquema comum.
GET https://{geography}.atlas.microsoft.com/features/datasets/{datasetId}/api?api-version=2023-03-01-previewParâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
dataset
|
path | True |
string |
O identificador do conjunto de dados a partir do qual consultar. |
|
geography
|
path | True |
string |
Este parâmetro especifica onde está localizado o recurso Azure Maps Criador. Os valores válidos são nós e eu. |
|
api-version
|
query | True |
string |
Número da versão da API Azure Maps. |
Cabeçalho do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps consulte os seguintes artigos para obter orientações. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
Ok |
|
| Other Status Codes |
Ocorreu um erro inesperado. |
Segurança
AADToken
Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.
Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.
Notas
- Esta definição de segurança requer a utilização do
x-ms-client-idcabeçalho para indicar a que recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.
O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Azure Active Directory.
* O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
* A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.
- Atualmente, o Azure Active Directory v1.0 ou v2.0 suporta o Trabalho, a Escola e os Convidados, mas não suporta contas Pessoais.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Esta é uma chave partilhada que é aprovisionada ao criar um recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
Com esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras da conta para a qual são emitidas.
Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor a servidor das APIs REST Azure Maps onde esta chave pode ser armazenada de forma segura.
Type:
apiKey
In:
query
SAS Token
Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.
Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.
Type:
apiKey
In:
header
Exemplos
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)."
}
]
}Definições
| Name | Description |
|---|---|
|
Api |
Resposta após um pedido com êxito para obter a definição da API. |
| Components |
O objeto de componentes OpenAPI. |
|
Error |
Informações adicionais sobre o erro de gestão de recursos. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta a erros |
| Info |
O objeto de informações OpenAPI. |
| Tags |
O objeto de etiquetas OpenAPI. |
ApiDefinitionResult
Resposta após um pedido com êxito para obter a definição da API.
| Name | Tipo | Description |
|---|---|---|
| components |
O objeto de componentes OpenAPI. |
|
| info |
O objeto de informações OpenAPI. |
|
| openapi |
string |
A versão OpenAPI. |
| paths |
object |
O objeto Caminhos openAPI. |
| tags |
Tags[] |
O objeto de etiquetas OpenAPI. |
Components
O objeto de componentes OpenAPI.
| Name | Tipo | Description |
|---|---|---|
| parameters |
object |
O objeto de parâmetros OpenAPI. |
| schemas |
object |
O objeto de esquemas OpenAPI. |
ErrorAdditionalInfo
Informações adicionais sobre o erro de gestão de recursos.
| Name | Tipo | Description |
|---|---|---|
| info |
object |
As informações adicionais. |
| type |
string |
O tipo de informações adicionais. |
ErrorDetail
O detalhe do erro.
| Name | Tipo | Description |
|---|---|---|
| additionalInfo |
As informações adicionais do erro. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O destino do erro. |
ErrorResponse
Resposta a erros
| Name | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
Info
O objeto de informações OpenAPI.
| Name | Tipo | Description |
|---|---|---|
| description |
string |
A descrição da API. |
| title |
string |
O título da API. |
| version |
string |
A versão da API. |
Tags
O objeto de etiquetas OpenAPI.
| Name | Tipo | Description |
|---|---|---|
| description |
string |
A descrição da etiqueta. |
| name |
string |
O nome da etiqueta. |