Fleet · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Fleet Premium API

6 actions 6 updates documentation extends openapi/fleet-premium-openapi.json
Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.
View Overlay File View on GitHub Overlay Specification

What the actions change

operationIdtagsx-apievangelist-providerx-apievangelist-reviewx-api-base-pathx-authenticationx-authentication-docs

Targets 5

$.info
$.paths['/api/v1/fleet/teams'].get
$.paths['/api/v1/fleet/teams'].post
$.paths['/api/v1/fleet/teams/{id}'].get
$.paths['/api/v1/fleet/teams/{id}'].delete

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Fleet Premium API
  version: 1.0.0
extends: openapi/fleet-premium-openapi.json
actions:
  - target: $.info
    update:
      x-apievangelist-provider: fleet
      x-apievangelist-review: This spec is a small first-party subset (teams). The full REST API is documented at fleetdm.com/docs/rest-api/rest-api.
      x-api-base-path: /api/v1/fleet
  - target: $.info
    update:
      x-authentication: bearer-token
      x-authentication-docs: https://fleetdm.com/docs/rest-api/rest-api#authentication
  - target: $.paths['/api/v1/fleet/teams'].get
    update:
      operationId: listTeams
      tags: [Teams]
  - target: $.paths['/api/v1/fleet/teams'].post
    update:
      operationId: createTeam
      tags: [Teams]
  - target: $.paths['/api/v1/fleet/teams/{id}'].get
    update:
      operationId: getTeam
      tags: [Teams]
  - target: $.paths['/api/v1/fleet/teams/{id}'].delete
    update:
      operationId: deleteTeam
      tags: [Teams]