search

CircleCI-Archived / api-preview-docs

In-progress docs about the pre-release preview of CircleCI API v2
72 stars 39 forks source link

Add Contexts API docs for linkability and review #88

Closed mvxt closed 3 years ago

mvxt commented 4 years ago

Open PR for draft Contexts API specs (both YAML and JSON formats).

I have a Postman Workspace that this API exists in, and it also contains the generated Swagger docs from the spec as well. Let me know if you'd like to be added to the workspace to review stuff (it's not letting me privately share or export the generated Swagger docs)

In addition, Nathan D already gave feedback and said we should be less resource-dependent, so would love suggestions / ideas on how we could structure the URL for Contexts API in a way that makes sense.

The top-level route is currently: /:org-slug/context

Other ideas: /org/:org-slug/context/:context-id? /context/:context-id and ignore org-slug entirely?

TomTucka commented 3 years ago

@mvxt are we far away from getting the contexts API spec integrated into the main v2 open API spec? I'd like to re-generate the client I'm working on to include these endpoints 😄 https://github.com/TomTucka/go-circleci

mvxt commented 3 years ago

@TomTucka Ah, these context API specs were just a proposal I slapped together months ago. I believe the engineering team is doing official work on it now, with their own official spec.