Mutation

report_found_api

Adds found API to the API finder. The API may be newly found or an update to an API that has already been onboarded.

Arguments

Input Fields

unique_api_id(): ID!

Unique identifier for this found API. This field will be used distinguish between newly found APIs and updates to onboarded APIs.

title(): String!

Human-readable title for this API.

api_definition(): ReportFoundApiDefinitionInput!

The API definition.

Return Fields

status(): ReportFoundApiStatus!

The status of the found API.

parse_error(): String

The error message if the API definition could not be parsed. Null if parsing succeeded.

Example

Query

mutation ReportFoundApi($input: ReportFoundApiInput!) {
  report_found_api(input: $input) {
    status
    parse_error
  }
}

Variables

{
  "input": {
    "unique_api_id": "my-service-openapi",
    "title": "My Service API",
    "api_definition": {
      "contents": "{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"My Service API\",\"version\":\"1.0.0\"},\"servers\":[{\"url\":\"https://api.example.com\"}],\"paths\":{\"/items/{id}\":{\"get\":{\"operationId\":\"getItemById\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\"}}}}}}"
    }
  }
}

Result

{
  "data": {
    "report_found_api": {
      "status": "new",
      "parse_error": null,
    }
  }
}