add str replace for external_laravel with theme "elements" #906
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shalvah
reviewed
Oct 27, 2024
| @@ -178,6 +178,7 @@ protected function performFinalTasksForLaravelType(): void | |||
| $contents = str_replace('href="../docs/collection.json"', 'href="{{ route("' . $this->paths->outputPath('postman', '.') . '") }}"', $contents); | |||
| $contents = str_replace('href="../docs/openapi.yaml"', 'href="{{ route("' . $this->paths->outputPath('openapi', '.') . '") }}"', $contents); | |||
| $contents = str_replace('url="../docs/openapi.yaml"', 'url="{{ route("' . $this->paths->outputPath('openapi', '.') . '") }}"', $contents); | |||
| $contents = str_replace('Url="../docs/openapi.yaml"', 'Url="{{ route("' . $this->paths->outputPath('openapi', '.') . '") }}"', $contents); | |||
There was a problem hiding this comment.
Suggested change
| $contents = str_replace('Url="../docs/openapi.yaml"', 'Url="{{ route("' . $this->paths->outputPath('openapi', '.') . '") }}"', $contents); | |
| // With Elements theme, we'd have <elements-api apiDescriptionUrl="../docs/openapi.yaml" | |
| $contents = str_replace('Url="../docs/openapi.yaml"', 'Url="{{ route("' . $this->paths->outputPath('openapi', '.') . '") }}"', $contents); |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added another str_replace so that the case for external_laravel with the theme "elements" is also matched.
Without the new str_replace the following is generated in the index.blade.php file:
<elements-api apiDescriptionUrl="../docs/openapi.yaml" ...With the new str_replace the relative url is replaced with a route:
<elements-api apiDescriptionUrl="{{ route("scribe.openapi") }}" ...The problem only occurs if laravel.docs_url is changed manually.
Then the openapi.yaml-file cannot be found.
This is not a problem with scalar and rapidoc, as the attribute (e.g. data-url) matches a lowercase ‘url’ correctly.