Skip to content

more detailed readme #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
colmdoyle merged 1 commit into from
Dec 15, 2022
Merged

more detailed readme #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,15 @@
# Intercom-OpenAPI
An OpenAPI description for Intercom's REST API
# Intercom's REST API OpenAPI Description

This repository contains [OpenAPI](https://www.openapis.org/) descriptions for [Intercom's REST API](https://developers.intercom.com/intercom-api-reference/reference/welcome).

## What is OpenAPI?

From the [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification):

> The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.

## Contributing

Because this description is automatically generated from our internal codebase, we don't currently accept pull requests that directly modify the description. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.

If you've identified a mismatch between the Intercom API's behavior and these descriptions, or found an issue with the format of a schema, [please open an issue.](https://github.com/intercom/Intercom-OpenAPI/issues/new?template=schema-inaccuracy.md)