union-fashion / home Goto Github PK

Writing summary content for outline.
Image for each entry in outline.
Write as a single narrative.
Break up into section screen cast walk throughs.

This is a potential website template for both the public website and the developer portal. - https://index.jekyllthemes.io/project/triangles

We are in need of a way to define the scope of each API, describing which pattern it uses and the overall scope of what it accomplishes.

How do developers signup? Twitter, GitHub, LinkedIn, Google, and Facebook. Others? Reddit?

Is it different for other users?

Update the APIs.json build script with all the latest changes. Include OpenAPI, Postman collections, Environments, documentation, workspaces, tests, monitors.

We need a plan for managing collections or they are going to get out of hand.

It seems like environments should be versioned.

Can we setup webhooks for each of the APIs, so that notifications get pushed when things change?

Create a clone workplace button that will replicate any of the API workspaces we have setup at Union Fashion, allowing others to setup exactly as we have them configured.

• https://github.com/union-fashion/home/blob/master/planning/deploy-and-monitor-planning.md#deployment

• https://github.com/union-fashion/home/blob/master/planning/deploy-and-monitor-planning.md#monitoring

🙏

We have come to that point in our journey where we need an API API. This API API will drive the API catalog via the developer portal, while also making our APIs more discoverable within other applications and integrations.

Propose design, setup workspace and repo -- kick it off.

Publish V1 APIs for all APIs, and make sure their features are reflected as a v1.0 label.

Finish producing the first prototype and document, then publish to get feedback on the components / design collection.

Create a collection for cleaning up an OpenAPI definition that is brought in from another resource. Port all of the functions currently used for API Evangelist to a portable collection for operations.

Establish an outline for the public website.

I'd like to see a prototype for a backwards compatibility collection that will audit each API moving between versions for backward compatibility check.

Is it possible to get access to the workspaces ('Require Access') and the collections (e.g https://union-fashion.postman.co/collections/10394726-5d172ec2-d989-4f99-beb1-8ad17294af21?

Add OracleCloud to the list of providers to create collections for, mapping out all the actions that can be taken, and delivering actual collections.

Need to create a screen capture walk through of the API life cycle and the collection, showing how it works with each API. Then link it off the readme for the API Life Cycle section.

What will it take to setup a simple products websockets implementation to show a multi-protocol approach?

Create a screen capture for the Union Fashion APIs, walking through the org, repositories, and workspaces for the five APIs being developed.

We need to implement this for training developers about Union Fashion API design.

I would love it so much if you could add some unique eCommerce APIs like Gamification or Loyalty or AI? Something fun to your demo e-commerce site to make it fun to play with.

Hi @kinlane,

Can Union Fashion demonstrate how to monitor and test an oauth2 endpoint defined in a openapi 3.0 spec? Something like this:

components:
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /oauth/authorize
          tokenUrl: /oauth/token
          scopes:
            read: read scope
            write: write scope

security: 
  - OAuth2: 
    - write
    - read

paths:
  /orders:
    patch:
      summary: Creates a new order
      security: 
        - OAuth2:
          - write
          - read

I'm supremely interested in the Governance and Life Cycle workspaces, collections, and examples. These seem like extremely meaty portions of the API-design process, but I'm having trouble finding links to collections (or something that could be imported as a collection), etc. I would love to be able to use/fork them.

You can view the details for the Union Fashion life cycle, and run the API life cycle collection within any workspace for managing an API--using the collection as guardrails and checklist for the entire API life cycle.

^ this link is broken in the Life Cycle and for Governance sections of the README.md

I'm also unable to get any of the "Run in Postman" links to actually open in Postman, but that may be unrelated

Consider adding an events API using Schema.org Event as a model - https://schema.org/Event

We need a way to handle collection scripts otherwise they are going to become unwieldy.

All users of Union Fashion should be able to use their existing accounts to login and get access to the website as well as the API - https://aws.amazon.com/blogs/security/use-aws-lambda-authorizers-with-a-third-party-identity-provider-to-secure-amazon-api-gateway-rest-apis/

Setup a newsletter for Union Fashion.

We need OAuth identity options for top providers, allowing anyone to sign in as a Union Fashion user.

Each API should have a way of attributing that it is using Schema.org, helping connect both semantically, but also for SEO.

What are the current events available across APis? How do we map them out?

Establish an outline of the essential building blocks of the developer portal.

We need a blog API for managing both the primary and engineering blog, allowing us to central content and then publish to each blog on a schedule, while also allowing us to syndicate content elsewhere.

Add the ability to white list the IP address of GitHub Pages servers so that we can accept API requests from our own single page applications.

Reference - https://aws.amazon.com/premiumsupport/knowledge-center/api-gateway-resource-policy-whitelist/

We need an FAQ page for both the main site and the developer area. Publish an OpenAPI and create supporting workspaces and repository.

We need a universal tagging API to manage the organization of all tags, but also the application and management of them across infrastructure -- including GitHub issue tags!

Finish defining how DNS is mapped to AWS gateway and finalize development as well as production DNS strategy for APIs.

The platform blog for Union Fashion should be about the technical details of both providing and consuming APIs. Helping show how the sausage is made, providing developers with blueprints for how they can accomplish what they are looking to do with APIs.

The primary blog should be for talking about the entire reference implementation, and the backstory on Union Fashion. Trying to speak to both the technical and non-technical, helping bridge the gap with the business groups.d

We need to reconcile Users as an object before we move forward. Is it what we want for the future?