Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Codes-Of-Conduct API

Insight into codes of conduct for your communities.

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

2 operations 2 paths 2 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Codes-Of-Conduct API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Codes-Of-Conduct 2

Insight into codes of conduct for your communities.

GET
/codes_of_conduct
APIs.io Engineering Platform Get all codes of conduct
codes-of-conduct/get-all-codes-of-conduct → 200304
GET
/codes_of_conduct/{key}
APIs.io Engineering Platform Get a code of conduct
codes-of-conduct/get-conduct-code 1 param → 200404304

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are code-of-conduct (5 properties), basic-error (4 properties). Each schema is shown below with its type and property counts.

basic-error
object
Basic Error
4 properties
code-of-conduct
object
Code Of Conduct
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-codes-of-conduct-api-openapi.yml Raw ↑