Microsoft Azure Wayfinding API

openapi: 3.2.0
info:
  version: 2023-03-01-preview
  title: Microsoft Azure Azure Maps Service Wayfinding API
  description: Azure Maps Wayfinding REST APIs
security:
- AADToken:
  - https://atlas.microsoft.com/.default
- SharedKey: []
- SasToken: []
tags:
- name: Wayfinding
paths:
  /wayfinding/path:
    get:
      summary: Microsoft Azure Use To Calculate The Best Path Between Two Locations Within A…
      description: The Wayfinding Service is part of Creator, and adheres to the Open Geospatial Consortium standard. Wayfinding uses indoor map data from the routeset to calculate the best path between two locations within the same facility. For more information, see Wayfinding in the _Creator for indoor maps_ concepts article.
      operationId: microsoftAzureWayfindingGetpath
      x-ms-examples:
        Get the shortest path between two points in the facility.:
          $ref: ./examples/wayfind/Wayfinding_GetPath.json
      parameters:
      - $ref: ../../../Common/preview/1.0/common.json#/parameters/ClientId
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/RoutesetId'
      - $ref: '#/components/parameters/FacilityId'
      - $ref: '#/components/parameters/FromPoint'
      - $ref: '#/components/parameters/FromLevel'
      - $ref: '#/components/parameters/ToPoint'
      - $ref: '#/components/parameters/ToLevel'
      - $ref: '#/components/parameters/AvoidFeatures'
      - $ref: '#/components/parameters/MinWidth'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WayfindResult'
        default:
          $ref: ../../../Common/preview/1.0/common.json#/responses/default
      tags:
      - Wayfinding
components:
  parameters:
    ToPoint:
      name: toPoint
      in: query
      description: 'The path destination in the following format: {latitude},{longitude}.'
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
    AvoidFeatures:
      name: avoidFeatures
      description: To avoid certain types of connectors in the resulting path. Multiple values can be specified.
      in: query
      x-ms-parameter-location: client
      schema:
        type: array
        items:
          type: string
          enum:
          - stairs
          - elevators
          x-ms-enum:
            name: avoidFeatures
            modelAsString: true
            values:
            - value: stairs
              description: Avoid stairs.
            - value: elevators
              description: Avoid elevators.
    ToLevel:
      name: toLevel
      in: query
      description: The path destination level.
      required: true
      x-ms-parameter-location: client
      schema:
        type: integer
        format: int32
    FromPoint:
      name: fromPoint
      in: query
      description: 'The path origin point in the following format: {latitude},{longitude}.'
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
    FromLevel:
      name: fromLevel
      in: query
      description: The path origin level.
      required: true
      x-ms-parameter-location: client
      schema:
        type: integer
        format: int32
    RoutesetId:
      name: routesetId
      description: The ID of the routeset to query from.
      in: query
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
    ApiVersion:
      name: api-version
      description: Version number of Azure Maps API.
      in: query
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
    FacilityId:
      name: facilityId
      in: query
      description: The identifier of the facility within the routeset where to find the path.
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
    MinWidth:
      name: minWidth
      description: 'The minimum width (in meters) of openings in the searched path. For example, if you specified a minimum width of 0.85, the searched path will avoid openings less than 85 centimeters wide. Note: by using this value, the resulting path points will be buffered from walls and other vertical obstacles by half of the width provided.'
      in: query
      x-ms-parameter-location: client
      schema:
        type: number
        default: '0.55'
  schemas:
    Point:
      description: A point within the facility.
      type: object
      properties:
        latitude:
          description: the point latitude
          type: number
        longitude:
          description: the point longitude
          type: number
      required:
      - latitude
      - longitude
    Leg:
      description: A section of the overall path.
      type: object
      properties:
        mode:
          type: string
          description: The leg mode of traversal for this leg. It can be default (all on the same level), elevators or stairs when moving vertically between levels.
        lengthInMeters:
          type: number
          description: The leg length, in meters, of this leg.
        timeInSeconds:
          type: integer
          format: int64
          description: The leg travel time, in seconds, to travel between the first and last point of this leg.
        startLevel:
          type: integer
          format: int32
          description: The floor where this leg starts.
        endLevel:
          type: integer
          format: int32
          description: The floor where this leg ends.
        points:
          description: 'The leg shape points. Their vertical position is determined as follows: all the points are at the same height when startLevel and endLevel are the same, otherwise the array will contain only two points: the first at startLevel and the second at endLevel.'
          type: array
          items:
            $ref: '#/components/schemas/Point'
          x-ms-identifiers: []
    Path:
      description: The details about a particular path between the origin and destination. It can be made up of one or more legs.
      type: object
      properties:
        lengthInMeters:
          type: number
          description: The path length, in meters, of the entire path.
        timeInSeconds:
          type: integer
          format: int64
          description: The path total time, in seconds, to travel between the origin and the destination when following this path.
        legs:
          description: The different travel sections of this path.
          type: array
          items:
            $ref: '#/components/schemas/Leg'
          x-ms-identifiers: []
    WayfindResult:
      description: The object returned by this Wayfinding Path request.
      type: object
      properties:
        noResultExplanation:
          type: string
          description: In the event that no paths are found, the `paths` array will be empty. If the reason no paths were found can be determined, this property will provide an explanation why.
          enum:
          - NoExplanation
          x-ms-enum:
            name: NoResultExplanation
            modelAsString: true
            values:
            - value: NoExplanation
              description: Default value provided when a result is returned or it wasn't possible to determine why a path wasn't found.
          readOnly: true
        paths:
          description: An array of wayfinding path results.  An empty array will be returned if no results were found.
          type: array
          items:
            $ref: '#/components/schemas/Path'
          x-ms-identifiers: []
  securitySchemes:
    AADToken:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://atlas.microsoft.com/.default: https://atlas.microsoft.com/.default
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a  built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts."
    SharedKey:
      type: apiKey
      description: "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored."
      name: subscription-key
      in: query
    SasToken:
      type: apiKey
      description: "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token."
      name: SAS Token
      in: header