api.md

Federated Gateway: API

TODO: add description

Table of Contents

• Types
  • Policy
  • inputs
  • enums
  • scalar
• Queries
  • healthcheck
• Mutations
• Further Reading

Types

Before we cover the API operations we need to talk about a few GQL types defined by this service. TODO: add types description

Back to Top

Policy

TODO: add policy summary

inputs

TODO: add inputs

Back to Top

enums

TODO: add enums if any

Back to Top

scalar

TODO: add scalars if any

Back to Top

Queries

healthcheck

Health check query verifies the Federated Gateway service is working.

TODO: update health check query as necessary

query {
  healthcheck
}

If successful this query will return the services health status.

{
  "data": {
    "healthcheck": {
      "status": "ok"
    }
  }
}

Back to Top

Mutations

TODO: add mutations

Back to Top

Further Reading

• Concepts
• Configuration
• Specifications

Back to Top