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.

Sign up for GitHub

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

Jump to bottom

[docs, API] control api + swagger ui for http api #3158

Merged
merged 16 commits into from
Nov 5, 2019
Merged

[docs, API] control api + swagger ui for http api #3158

merged 16 commits into from
Nov 5, 2019

Conversation

balopat
Copy link
Contributor

@balopat balopat commented Nov 4, 2019 •
edited
Loading

Description

This became pretty massive just from writing the Control API doc:

  • Control API docs
  • Swagger UI for HTTP
  • markdown template for the gRPC API
  • removes /v1/events as it is superfluous
  • removes /v1/handle as it was a remainder of our plugins experiment - we can reintroduce it if necessary later
  • removes stream LogEntry as a request parameter from EventLog because it is completely unnecessary

User facing changes

simpler API - no /v1/events, just /v1/event_log

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • [ ] Includes unit tests
  • Mentions any output changes.
  • Adds documentation as needed: user docs, YAML reference, CLI reference.
  • [ ] Adds integration tests if needed.

Reviewer Notes

  • The code flow looks good.
  • Unit test added.
  • User facing changes look good.

@balopat balopat added the docs-modifications runs the docs preview service on the given PR label Nov 4, 2019
@container-tools-bot
Copy link

Please visit http://35.235.117.222:1313 to view changes to the docs.

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Nov 4, 2019
@codecov
Copy link

codecov bot commented Nov 4, 2019 •
edited
Loading

Codecov Report

Merging #3158 into master will decrease coverage by 0.03%.
The diff coverage is 0%.

Impacted Files Coverage Δ
pkg/skaffold/server/endpoints.go 0% <0%> (ø) ⬆️
pkg/skaffold/util/tar.go 43.61% <0%> (-4.26%) ⬇️

@balopat balopat changed the title control api + swagger ui for http api [docs, API] control api + swagger ui for http api Nov 4, 2019
@balopat balopat added the docs-modifications runs the docs preview service on the given PR label Nov 4, 2019
@container-tools-bot
Copy link

Please visit http://34.94.115.173:1313 to view changes to the docs.

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Nov 4, 2019
@balopat balopat added the priority/p0 Highest priority. We are actively looking at delivering it. label Nov 4, 2019
@balopat
Copy link
Contributor Author

balopat commented Nov 4, 2019 •
edited
Loading

  • [ ] figure out filtering out methods
  • fix CLI menupoint weight
  • revert /v1/handle and hide it & mark it as experimental
  • revert /v1/events_log and hide it & mark it as deprecated
  • remove /v1/events stream arg
  • group the two API references together
  • rebase

@balopat balopat added the docs-modifications runs the docs preview service on the given PR label Nov 4, 2019
@container-tools-bot
Copy link

Please visit http://35.236.87.39:1313 to view changes to the docs.

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Nov 4, 2019
@balopat balopat added the docs-modifications runs the docs preview service on the given PR label Nov 5, 2019
@container-tools-bot
Copy link

Please visit http://34.94.185.45:1313 to view changes to the docs.

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Nov 5, 2019
@balopat balopat added the docs-modifications runs the docs preview service on the given PR label Nov 5, 2019
@container-tools-bot
Copy link

Please visit http://35.236.87.39:1313 to view changes to the docs.

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Nov 5, 2019
nkubala
nkubala reviewed Nov 5, 2019
View reviewed changes
docs/content/en/docs/design/api.md Outdated Show resolved Hide resolved
docs/content/en/docs/design/api.md

To control the individual phases of the Skaffold, the Skaffold API provides [fine grained control over]({{< relref "/docs/design/api#controlling-build-sync-deploy" >}})
To control the individual phases of the Skaffold, the Skaffold API provides [fine grained control over]({{< relref "#controlling-build-sync-deploy" >}})
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To control the individual phases of the Skaffold, the Skaffold API provides [fine grained control over]({{< relref "#controlling-build-sync-deploy" >}})
To control the individual phases of the Skaffold, the Skaffold API provides [fine grained control]({{< relref "#controlling-build-sync-deploy" >}}) over

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't get this change

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is very small nit. i am going to approve and merge

docs/content/en/docs/design/api.md Outdated Show resolved Hide resolved
docs/content/en/docs/design/api.md Outdated Show resolved Hide resolved
docs/content/en/docs/design/api.md Outdated Show resolved Hide resolved
docs/content/en/docs/design/api.md Outdated Show resolved Hide resolved
docs/content/en/docs/design/api.md Outdated Show resolved Hide resolved
balopat and others added 6 commits November 5, 2019 10:52
@balopat @nkubala
Update docs/content/en/docs/design/api.md
127b77a 
Co-Authored-By: Nick Kubala <nkubala@users.noreply.github.com>
@balopat @nkubala
Update docs/content/en/docs/design/api.md
e38910b 
Co-Authored-By: Nick Kubala <nkubala@users.noreply.github.com>
@balopat @nkubala
Update docs/content/en/docs/design/api.md
14aa91d 
Co-Authored-By: Nick Kubala <nkubala@users.noreply.github.com>
@balopat @nkubala
Update docs/content/en/docs/design/api.md
7d46a1d 
Co-Authored-By: Nick Kubala <nkubala@users.noreply.github.com>
@balopat @nkubala
Update docs/content/en/docs/design/api.md
fdd29a7 
Co-Authored-By: Nick Kubala <nkubala@users.noreply.github.com>
@balopat
Update docs/content/en/docs/design/api.md
277d468
@balopat balopat added the docs-modifications runs the docs preview service on the given PR label Nov 5, 2019
@container-tools-bot
Copy link

Please visit http://34.94.115.173:1313 to view changes to the docs.

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Nov 5, 2019
@tejal29 tejal29 merged commit 8aa47ff into GoogleContainerTools:master Nov 5, 2019
@tejal29 tejal29 mentioned this pull request Nov 6, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tejal29 tejal29 tejal29 approved these changes

@nkubala nkubala nkubala left review comments

@dgageot dgageot Awaiting requested review from dgageot

Assignees
No one assigned
Labels
cla: yes priority/p0 Highest priority. We are actively looking at delivering it.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@balopat @container-tools-bot @tejal29 @nkubala @googlebot