Skip to content
This repository has been archived by the owner on May 6, 2020. It is now read-only.

feat(api): add swagger support at the root of the API #1068

Closed
wants to merge 1 commit into from

Conversation

helgi
Copy link
Contributor

@helgi helgi commented Sep 15, 2016

Content Type for it is application/openapi+json or ?format=openapi

Closes #811

Very much so work in progress still

A few off the cuff considerations:

  • Auth the endpoint? (use API key). Hooks get hidden from view when using normal tokens, which defeats the point
  • throttle access to that endpoint
  • save swagger on each release? add into the docs site somehow potentially

@deis-bot
Copy link

@kmala, @bacongobbler and @mboersma are potential reviewers of this pull request based on my analysis of git blame information. Thanks @helgi!

@codecov-io
Copy link

codecov-io commented Sep 15, 2016

Current coverage is 86.96% (diff: 80.00%)

Merging #1068 into master will decrease coverage by 0.80%

@@             master      #1068   diff @@
==========================================
  Files            42         42          
  Lines          3629       3605    -24   
  Methods           0          0          
  Messages          0          0          
  Branches        619        609    -10   
==========================================
- Hits           3185       3135    -50   
- Misses          292        310    +18   
- Partials        152        160     +8   

Powered by Codecov. Last update 9f6cb94...9bc9689

@helgi
Copy link
Contributor Author

helgi commented Oct 4, 2016

When encode/django-rest-framework#4525 (DRF 3.5) is out then I'll revisit most of this

Content Type for it is application/openapi+json or ?format=openapi

Closes deis#811
@mboersma
Copy link
Member

mboersma commented Nov 3, 2016

We are also considering using https://github.com/kubernetes-incubator/client-python since it seems to be swagger-generated and may come close to matching our hand-crafted, artisanal k8s client functionality.

@mboersma
Copy link
Member

mboersma commented Jul 5, 2017

I'm closing this PR since it's old and rusty, but @helgi please re-open if this code gets resurrected. Thanks again!

@mboersma mboersma closed this Jul 5, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants