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

Updates the Swagger API route #268

Merged
merged 1 commit into from
Jun 5, 2021
Merged

Updates the Swagger API route #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion config/06-swagger/00-config/00-swagger-configmap.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ metadata:
name: swagger
namespace: tekton-hub
data:
API_URL: 'https://api.hub.tekton.dev'
API_URL: 'https://raw.githubusercontent.com/tektoncd/hub/main/api/v1/gen/http/openapi3.yaml'
Copy link
Member

Choose a reason for hiding this comment

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

we should point to a specific commit instead of main branch .. there might be new APIs added and release not done, this will show them in the swagger

Copy link
Member

Choose a reason for hiding this comment

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

I guess we can keep this as it is over here and at the time of deploying we can make the API_URL to point to the particular tag by setting the env

hub/swagger/image/start.sh

Line 15 in 6c97d9e

API_URL: '$API_URL',

hub/config/06-swagger/00-config/00-swagger-configmap.yaml

Line 8 in 6c97d9e

API_URL: 'https://api.hub.tekton.dev'

Copy link
Member Author

Choose a reason for hiding this comment

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

I think we can use the raw url from the latest release ??
For example https://raw.githubusercontent.com/tektoncd/hub/v1.3.0/api/v1/gen/http/openapi3.yaml

Copy link
Member

Choose a reason for hiding this comment

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

https://api.hub.tekton.dev this isn't working at the moment so I would avoid keeping it :D

Copy link
Member

Choose a reason for hiding this comment

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

by default let it point to main branch .. we can update in configmap while deploying

Copy link
Member

Choose a reason for hiding this comment

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

good to merge?

Copy link
Member Author

Choose a reason for hiding this comment

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

by default let it point to main branch .. we can update in configmap while deploying

This can even help in development where user can directly see what's there in main

4 changes: 2 additions & 2 deletions swagger/public/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
window.config = {
API_URL: 'https://api.hub.tekton.dev'
};
API_URL: 'https://raw.githubusercontent.com/tektoncd/hub/main/api/v1/gen/http/openapi3.yaml'
};
2 changes: 1 addition & 1 deletion swagger/src/config/constants.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ window.config = window.config || {
API_URL: 'no API_URL set'
};

export const API_URL = window.config.API_URL + '/schema/swagger.json';
export const API_URL = window.config.API_URL;