Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Companies SSO API

4 actions 4 updates phrasing extends openapi/remote-com-sso-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Remote's API. It is a proposal applied on top of the contract, not a document Remote publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/sso_configuration'].get
$.paths['/sso_configuration'].post
$.paths['/sso_configuration/details'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Remote Companies SSO API
  version: 1.0.0
extends: openapi/remote-com-sso-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/sso_configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: View the current SSO configuration
      effect: read
      questions:
      - Is single sign-on set up for our Remote account?
      - What SSO configuration is currently active?
      instructions:
      - text: Show our current SSO configuration.
      - text: Check whether single sign-on is configured.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sso_configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up single sign-on
      effect: write
      questions:
      - How do I configure SSO so employees log in with our identity provider?
      - Can I create an SSO configuration through the API?
      instructions:
      - text: Create the SSO configuration with settings {data}.
        slots:
          data: requestBody.data
      - text: Set up single sign-on for our company.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sso_configuration/details'].get
  update:
    x-apievangelist-phrasing:
      intent: View detailed SSO settings
      effect: read
      questions:
      - Where do I find the full details of our SSO setup, beyond whether it is on?
      - What are the detailed SSO settings Remote has on file?
      instructions:
      - text: Show the detailed SSO configuration.
      - text: Get the full SSO configuration details.
      method: generated
      generated: '2026-09-26'