openapi: 3.1.0
info:
  title: Backstage Software Catalog Entities Locations API
  description: 'The Backstage Software Catalog API exposes the entities and locations

    managed by the catalog backend. Endpoints are served by the catalog

    backend plugin under {backend.baseUrl}/api/catalog. Authentication is

    optional or required depending on the install, and uses a Bearer token

    issued by the Backstage identity API. This file is an API Evangelist

    research artifact for the scalable-software-and-systems topic.

    '
  version: 1.0.0
  contact:
    name: API Evangelist
    url: https://apievangelist.com
servers:
- url: http://localhost:7007/api/catalog
  description: Local Backstage backend
- url: https://{backend}/api/catalog
  description: Hosted Backstage backend
  variables:
    backend:
      default: backstage.example.com
      description: Backstage backend hostname
security:
- BearerAuth: []
tags:
- name: Locations
paths:
  /locations:
    get:
      summary: List registered locations
      operationId: listLocations
      tags:
      - Locations
      responses:
        '200':
          description: Locations list.
    post:
      summary: Register a new location
      operationId: createLocation
      tags:
      - Locations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                target:
                  type: string
      responses:
        '201':
          description: Location created.
  /locations/{id}:
    delete:
      summary: Delete a location
      operationId: deleteLocation
      tags:
      - Locations
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Location deleted.
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: BackstageToken