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

APIOps Cycles Canvas Products API

Placing and managing of products placed for products.

APIOps Cycles Canvas Products API is published by APIOps Cycles Canvas on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Products. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.example.com.

6 operations 3 paths 7 schemas 1 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Server
https://api.example.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIOps Cycles Canvas Products API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (apiKeys).

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Products 6

Placing and managing of products placed for products.

GET
/products
Retrieves Products
getProducts → 200400401403429500
POST
/products
Products Create Product
createProduct body → 201400401403404409429500
GET
/products/{productId}
Products Retrieve Product
getProduct 1 param → 200400401403404429500
PUT
/products/{productId}
Products Update Product
updateProduct 1 param body → 204400401403404429500
DELETE
/products/{productId}
Products Delete Product
deleteProduct 1 param → 204400401403404429500
PUT
/products/{productId}/cancle
Products Cancel Product
sendProduct 1 param body → 204400401403404429500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Problem (5 properties), Product (4 properties), WrapperResponseObject (3 properties), WrapperResponseCollection (3 properties). Each schema is shown below with its type and property counts.

LinksSelf
object
A link to reference each product.
1 property 1 required
Meta
object
The metadata for each response.
3 properties 2 required
WrapperResponseCollection
object
This is a generic request/response wrapper which contains both data and links which serve as hypermedia controls (HATEOAS).
3 properties 3 required
Product
object
A Schema.org compliant product object.
4 properties 3 required
Problem
object
This is a Problem Details for HTTP APIs object.
5 properties 2 required
WrapperResponseObject
object
This is a generic request/response wrapper which contains both data and links which serve as hypermedia controls (HATEOAS).
3 properties 3 required
LinksPagination
object
The handling of each page.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apiops-cycles-canvas-products-api-openapi.yml Raw ↑