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

Provide an OpenAPI specification for the Kuma HTTP API #318

Open
subnetmarco opened this issue Oct 8, 2019 · 19 comments
Open

Provide an OpenAPI specification for the Kuma HTTP API #318

subnetmarco opened this issue Oct 8, 2019 · 19 comments
Assignees
@lahabana
Labels
area/api breaking-change kind/docs About docs kind/feature New feature triage/accepted The issue was reviewed and is complete enough to start working on it

Comments

@subnetmarco
Copy link
Contributor

In order to be consumable by third-party clients.
@rohgoyal
Copy link

@subnetmarco @yskopets I can create Open API Spec for Kuma HTTP APIs. To start contributing, let me know if I need to follow a process?

@yskopets
Copy link
Contributor

@rohgoyal Hey!

Thanks a lot for offering your help! We'll take it! 😃

We need to manually prepare an OpenAPI spec for our HTTP APIs:

  • we only have a small number of REST endpoints, so manual approach seems to be a good fit
  • and we don't need to document request/response payloads (we will use automated approach for this part later on)

If it still sounds interesting to you, we'll be super grateful for your contribution!

@rohgoyal
Copy link

@yskopets, Great.. I will start working on it. Will raise a review/pull request when it's in shape.

@rohgoyal
Copy link

rohgoyal commented Dec 27, 2019 •
edited
Loading

#518 Raised for Review.

@yskopets yskopets mentioned this issue Dec 30, 2019
Closed
@jpeach
Copy link
Contributor

jpeach commented May 31, 2021

If the source of truth for the API is protobuf, can protoc-gen-openapi be used to generate a useful OpenAPI spec?

@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Jan 1, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jan 1, 2022

This issue was inactive for 30 days it will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant please comment on it promptly or attend the next triage meeting.

@lahabana lahabana changed the title Provide an OAPI specification for the Kuma HTTP API Provide an OpenAPI specification for the Kuma HTTP API Feb 16, 2022
@lahabana lahabana added triage/accepted The issue was reviewed and is complete enough to start working on it and removed triage/stale Inactive for some time. It will be triaged again labels Apr 14, 2022
@lahabana
Copy link
Contributor

lahabana commented Apr 14, 2022 •
edited
Loading

This is something we're looking into as a part of the policy versioning effort: #3330

@github-actions
Copy link
Contributor

This issue was inactive for 30 days it will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant please comment on it promptly or attend the next triage meeting.

@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label May 15, 2022
@github-actions
Copy link
Contributor

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Oct 17, 2022
@lahabana lahabana removed the triage/stale Inactive for some time. It will be triaged again label Oct 17, 2022
@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Jan 17, 2023
@github-actions
Copy link
Contributor

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@lahabana lahabana removed the triage/stale Inactive for some time. It will be triaged again label Jan 17, 2023
@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Apr 18, 2023
@github-actions
Copy link
Contributor

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@lahabana lahabana removed the triage/stale Inactive for some time. It will be triaged again label Apr 18, 2023
@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Jul 18, 2023
@github-actions
Copy link
Contributor

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@lahabana lahabana removed the triage/stale Inactive for some time. It will be triaged again label Jul 18, 2023
lahabana added a commit to lahabana/kuma that referenced this issue Oct 6, 2023
@lahabana
feat(docs): generate openapi spec
d5a967a 
Use all openapis in the repo to generate a complete
1 file version in `docs/generated/openapi.yaml`

Part of kumahq#318

Signed-off-by: Charly Molter <[email protected]>
@lahabana lahabana self-assigned this Oct 9, 2023
lahabana added a commit to lahabana/kuma that referenced this issue Oct 10, 2023
@lahabana
feat(docs): generate openapi spec
bb9fd56 
Use all openapis in the repo to generate a complete
1 file version in `docs/generated/openapi.yaml`

Part of kumahq#318

Signed-off-by: Charly Molter <[email protected]>
lahabana added a commit that referenced this issue Oct 10, 2023
@lahabana
feat(docs): add generated openapi docs (#7975)
65a5e0c 
Use all openapis in the repo to generate a complete
1 file version in `docs/generated/openapi.yaml`

Part of #318
Signed-off-by: Charly Molter <[email protected]>
@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Jan 8, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 8, 2024

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@lukidzi lukidzi removed the triage/stale Inactive for some time. It will be triaged again label Jan 9, 2024
@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Apr 10, 2024
@github-actions GitHub Actions
Copy link
Contributor

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@lukidzi lukidzi removed the triage/stale Inactive for some time. It will be triaged again label Apr 10, 2024
@lukidzi
Copy link
Contributor

lukidzi commented Apr 10, 2024

I think it has been done https://github.com/kumahq/kuma/blob/master/docs/generated/openapi.yaml @lahabana

@github-actions GitHub Actions
Copy link
Contributor

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Jul 11, 2024
@lukidzi lukidzi removed the triage/stale Inactive for some time. It will be triaged again label Jul 15, 2024
@lahabana lahabana mentioned this issue Jul 30, 2024
Open
@github-actions GitHub Actions
Copy link
Contributor

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed.
If you think this issue is still relevant, please comment on it or attend the next triage meeting.

@github-actions github-actions bot added the triage/stale Inactive for some time. It will be triaged again label Oct 14, 2024
@lukidzi lukidzi removed the triage/stale Inactive for some time. It will be triaged again label Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lahabana lahabana

Labels
area/api breaking-change kind/docs About docs kind/feature New feature triage/accepted The issue was reviewed and is complete enough to start working on it
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

kuma-cp: add OpenAPI description of the Kuma REST API kumahq/kuma
6 participants
@jpeach @rohgoyal @lahabana @subnetmarco @lukidzi @yskopets