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.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(specs): add servers #98

Merged
merged 2 commits into from
Jan 20, 2022
Merged

feat(specs): add servers #98

merged 2 commits into from
Jan 20, 2022

Conversation

shortcuts
Copy link
Member

馃Л What and Why

馃師 JIRA Ticket: -

Changes included:

Follow up of #97

Even if we don't use servers in our templates, we can still define them in the specs so it's usable from the generated docs: (#92) or any external tools

馃И Test

CI :D

@shortcuts shortcuts requested a review from a team January 20, 2022 14:40
@shortcuts shortcuts self-assigned this Jan 20, 2022
@shortcuts shortcuts requested review from eunjae-lee and removed request for a team January 20, 2022 14:40
Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

Nice !

specs/search/spec.yml Show resolved Hide resolved
@@ -9,6 +9,14 @@ components:
$ref: '../common/securitySchemes.yml#/appId'
apiKey:
$ref: '../common/securitySchemes.yml#/apiKey'
servers:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we leverage this data to create the client ? I'm sure it can be accessed in mustache

Copy link
Member Author

Choose a reason for hiding this comment

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

Yep we can, but I can't remember why we decided not to do it.... 馃

Copy link
Collaborator

Choose a reason for hiding this comment

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

It was really early and maybe we didn't know it was possible

Copy link
Member Author

Choose a reason for hiding this comment

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

It was by default, but there was a parsing error, and we indeed did not had the retry strategy yet.

I'll take a small look, might be worth doing it in an other PR if there is many changes though

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh I remember, it only takes the first URL of the servers (OpenAPITools/openapi-generator#590, might be worth digging later)

What I get right now in the generator is only basePath=https://myAppId.algolianet.com

Copy link
Collaborator

Choose a reason for hiding this comment

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

Too bad, doesn't look like this will be resolved any time soon.

@shortcuts shortcuts merged commit 48ea9e1 into main Jan 20, 2022
@shortcuts shortcuts deleted the feat/specs-servers branch January 20, 2022 15:11
shortcuts added a commit that referenced this pull request Apr 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants