Skip to content
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.

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

Design API (GET/LIST/POST/PUT/DELETE) for gateway records #3

Open
olivercodes opened this issue Jul 27, 2023 · 4 comments
Open

Design API (GET/LIST/POST/PUT/DELETE) for gateway records #3

olivercodes opened this issue Jul 27, 2023 · 4 comments
Assignees
Labels
help wanted Extra attention is needed PSK-TEAMS-API

Comments

@olivercodes
Copy link
Member

olivercodes commented Jul 27, 2023

Split off from #2

Design APIs for the Gateway entity and add to Mural. Follow the pattern in mural established for teams api and namespaces apis.

gateway-db entity definition

gw-id: subdomain of gateway, e.g., dev.api.twdps.io
gw-cert-managed: is this a supported gateway, cert-manager to manage?
gw-custom-cert: where the customer supplies the cert?
gw-ingress: ingress-gateway to attach

Mural: https://app.mural.co/t/twma7655/m/twma7655/1659125905811/89644c232bd59569a1103607f3b2fa263c1ed25e?sender=ue017dd0a0ba865be72d75848

Once complete or after making progress make sure to review it with @ncheneweth

@olivercodes olivercodes added the enhancement New feature or request label Jul 27, 2023
@olivercodes olivercodes added PSK-TEAMS-API and removed enhancement New feature or request labels Aug 4, 2023
@olivercodes olivercodes changed the title Ability to GET/LIST/POST/PUT/DELETE gateway records Design API (GET/LIST/POST/PUT/DELETE) for gateway records Aug 10, 2023
@olivercodes olivercodes added the help wanted Extra attention is needed label Aug 10, 2023
@olivercodes
Copy link
Member Author

olivercodes commented Aug 10, 2023

NOTE: EDITED THIS COMMENT AS THE "MOVE TO" MURAL IS ACTUAL in a client specific folder and not part of the PSK> See NEXT comment
Update: Note that we are moving away from this mural (lab-api-teams architecture)

https://app.mural.co/t/twma7655/m/twma7655/1659125905811/89644c232bd59569a1103607f3b2fa263c1ed25e?sender=ue017dd0a0ba865be72d75848

to this mural (DI Management APIs (and touchpoints - CLI)

https://app.mural.co/t/thoughtworksclientprojects1205/m/thoughtworksclientprojects1205/1687460544281/833975940ec11b5a3c7af94e4ec8cc4253a6187d?sender=ue017dd0a0ba865be72d75848

@rahibas rahibas self-assigned this Dec 5, 2023
@rahibas
Copy link

rahibas commented Dec 12, 2023

Design approach:

  • Develop OAS 3.0 spec to enable design first development
  • Provide mocking capabilities with design spec
  • Phase Spec design by method ie. GET, list, POST, DELETE, PUT
  • Test design first workflow with this effort

Activities:

  • Develop OAS 3.0 draft ( aligned with style-guide and OAS standards)

  • Collaborate/Review with API design stakeholders

  • Provide mocking/testing capabilities

  • Refine design based on consumption

  • Publish/deploy v1 for consumption

@rahibas
Copy link

rahibas commented Feb 20, 2024

here is the link for the design assumptions. these should all be validated or dismissed before spec is turned into usable prod endpoint
https://docs.google.com/spreadsheets/d/1dFBIsnDVFE_On24kR6JLDC_VNOrQXDEQxxCQNUIcn0U/edit?usp=sharing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed PSK-TEAMS-API
Projects
None yet
Development

No branches or pull requests

3 participants