Products

featured-image
This is the API for the Union Fashion product catalog, providing read and write access to all of the products we are making available via our website, mobile, and partner applications. This page should give developers everything they need to get started using this API, while also look behind how this API is being developed.

Organizational

Team Page - The team behind this API, access is required to view team page.
Workspace Page - The dedicated workspaces behind the development of this API, access is required to view team page.
GitHub Repo - This is the dedicated repo behind this API, providing a single location where you can find information and artifacts.

Artifacts

OpenAPI - This is the OpenAPI for this API, providing a single source of truth regarding what this API does. All collections are derived from this OpenAPI contract, and kept in sync with it using validation.
Collection - This is the Postman collection for this API, allowing consumers to quickly put to work in their clients, pipelines, and other tooling, helping drive multiple stops along the lifecycle.
Environment - This is the environment for this API, providing the base url, api key, an dother essential secrets and variables that can be used when making requests to this API via the collection provided.

Consume

Documentation - This is the documenation available for this API, which is generated fro the OpenAPI for this API, but maintained separately to publish documentation and provide mock servers for this API.
Run in Postman - This is a Run in Postman button which allows you to instantly load this API into your local Postman client. You will need to signup or login and obtain an API key before you can make a call, but this should help you get up and running.

Artifacts

Activity - The activity around each API, providing details of what structural and operational changes have been made to an API, its workspace, and other important elements about what is happening.
History - The history of requests made across collections that are generated from APIs, and are published for mocks, documentation, and used to define contract, integration, and other testing.
Issues - All of the issues that are tracked for this API, leveraging GitHub issues as the central feedback loop for features, bugs, enhancements, and other relevant aspects of the feedback loop.

Latest Contract Testing

May 14 2020
  • Add Product
    • Is 201 Status? ✅
    • Have body? ✅
    • Is valid JSON? ✅
  • Get Products
    • Is 200 Status? ✅
    • Have body? ✅
    • Is valid JSON? ✅
    • Is valid JSON Schema? ✅
  • Get Product
    • Is 200 Status? ✅
    • Have body? ✅
    • Is valid JSON? ❌
    • Is valid JSON Schema? ❌
  • Update Product
    • Is 204 Status? ❌
    • No Body? ✅
  • Delete Product
    • Is 204 Status? ❌
    • No Body? ✅

Latest Performance Testing

May 14 2020
  • response_time
  • meet_expectations

Latest Security Testing

May 14 2020
  • Add Product (Security Injection)
    • Is 201 Status? ✅
    • Have body? ✅
    • Is valid JSON? ✅
  • Get Products (Security Injection)
    • Is 200 Status? ✅
    • Have body? ✅
    • Is valid JSON? ✅
    • Is valid JSON Schema? ✅
  • Get Product (Security Injection)
    • Is 200 Status? ❌
    • Have body? ✅
    • Is valid JSON? ✅
    • Is valid JSON Schema? ✅
  • Update Product (Security Injection)
    • Is 204 Status? ❌
    • No Body? ✅
  • Delete Product (Security Injection)
    • Is 204 Status? ❌
    • No Body? ✅

Latest Governance

May 14 2020
  • Definition
    • Workspace
      • Is there a Postman workspace? ✅
      • Is workspace named properly? ✅
    • Organization
      • Is there a GitHub organization? ✅
    • Repository
      • Is there a GitHub repository? ✅
    • APIs
      • Is there a Postman API? ✅
      • Is there an OpenAPI? ✅
      • Is there a valid OpenAPI? ❌
    • Collections
      • Is there a life cycle collection? ✅
      • Is there a governance collection? ✅
      • Is there a documentation collection? ❌
      • Is there a contract collection? ✅
      • Is there a performance collection? ✅
      • Is there a security collection? ✅
    • Environment
      • Is there a development environment? ✅
      • Is there a mock development environment? ✅
      • Is there a production environment? ✅
      • Is there a mock production environment? ✅
    • Owner
      • Is there a contact for the API? ❌
      • Is there a contact name for this API? ❌
      • Is there a contact email for the API? ❌
  • Design
    • Info
      • Does the name of the API meet requirements? ✅
      • Does the description of the API meet requirements? ✅
    • Paths
      • Are paths using words? ✅
    • Methods
      • Parameters
        • Are all parameters using camelCase? ✅
        • Do all parameters have descriptions? ✅
      • Request Bodies
        • Do only POST, PUT, and PATCH have bodies? ❌
        • Do request bodies have a description? ❌
        • Do request bodies have a JSON media type? ❌
        • Do request boeis have schema? ❌
        • Do request bodies have examples? ❌
      • Responses
        • Do all methods have an HTTP Status Success (2xx)? ✅
        • Do all methods have an HTTP Status Failure (5xx)? ❌
      • Does GET, POST, PUT, and DELEETE exist for all resources? ✅
      • Do all methods have summaries? ✅
      • Do all methods have descriptions? ❌
      • Do all methods have operation ids? ✅
      • Do all methods have tags? ❌
    • Schema
      • Do all schema have properties? ✅
      • Do all schema properties have descriptions? ❌
  • Mocks
    • Is there a mock development server? ✅
    • Is there a mock production server? ✅
  • Development
    • Is there a development server? ✅
    • Is there a development stage defined with the API gateway? (COMING SOON) ❌
  • Production
    • Is there a production server? ✅
    • Is there a production stage defined with the API gateway? (COMING SOON) Copy ❌
  • Management
    • Is there an API plan? ❌
    • Is there an API key? ❌
  • Testing
    • Contract Testing
      • Is there output from contract tests? ✅
      • Did the API pass the contract tests? ❌
    • Security Testing
      • Is there output from security tests? ✅
      • Did the API pass the security tests? ❌
    • Performance Testing
      • Is there output from performance tests? ✅
      • Did the API pass the performance tests? ❌
  • Monitoring
    • Is there a contract testing collection monitor? ❌
    • Is there a performance testing collection monitor? ❌
    • Is there a security testing collection monitor? ❌
  • Support
    • Road Map
      • Is GitHub issues setup for tracking roadmap? ❌
      • How many road map entries are there? ❌
    • Issues
      • Is GitHub issues setup for tracking issues? ❌
      • How many open issue entries are there? (COMING SOON) ❌
      • How many close issue entries are there? (COMING SOON) ❌
    • Change Log
      • How many change log entries are there? (COMING SOON) ❌
      • Is GitHub issues setup for tracking change log? ❌
  • LIcense
    • Is there a license for the API?? ❌
    • How many road map entries are there? (COMING SOON) ❌