CARVIEW |
Select Language
HTTP/2 200
date: Sat, 26 Jul 2025 02:09:15 GMT
content-type: text/html; charset=utf-8
cache-control: no-cache
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
referrer-policy: no-referrer-when-downgrade
server-timing: pull_request_layout-fragment;desc="pull_request_layout fragment";dur=340.516778,conversation_content-fragment;desc="conversation_content fragment";dur=763.75915,conversation_sidebar-fragment;desc="conversation_sidebar fragment";dur=287.019889,nginx;desc="NGINX";dur=1.132623,glb;desc="GLB";dur=101.095623
strict-transport-security: max-age=31536000; includeSubdomains; preload
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
x-content-type-options: nosniff
x-frame-options: deny
x-voltron-version: a2eb102
x-xss-protection: 0
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=HD9pH7D7JWJ8bvMo%2Flxq5Wo0UJCQKHb74%2Fber%2FeSNVisqMhHSJ73rf%2BNXoyollJRZX6QuZiZlAxsoIRNmFzkyqYV%2BdT85BvTSe3Sur%2FP7qbzyYURgROHHSB5KJgRWbZ7LI72TWp%2B58EfW1VDSZZnd4FUqjsHDy7EZNiVqIsJR3BA24dF9tssdPTCqGnHy9aGfIANiwOlvZbcEqooWg6gjprmigfFNSu5KVfTRL4visstlBmJ%2FdnbnHZb4phAObOiL0WyAVMTmrxXz3FqCYrQIg%3D%3D--X%2BBuCYfWaQuZ0Tr7--Qb8VW7o0Mp%2BlAwwUz5aFsA%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.650785493.1753495754; Path=/; Domain=github.com; Expires=Sun, 26 Jul 2026 02:09:14 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Sun, 26 Jul 2026 02:09:14 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: B318:3ABCFD:B4EEE:11CD23:688438CA
Documentation obromios by obromios · Pull Request #387 · zipmark/rspec_api_documentation · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 372
Documentation obromios #387
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’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
This file contains hidden or 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
The gemfile had gem 'raddocs', :github => "smartlogic/raddocs" which loads over http not https so is insecure.
At present, only option is :open_api, but this does not produce output that is easily readable by user. When the problem with the :json option is fixed see issue zipmark#382 I suggest that :json option is added as well, users can see output using raddocs.
This has been altered to take out any open_api code. Given there is only one example spec in the README document, my view is that it should not be specifically open_api, but just use the most general options. I have bumped the level of this section up by two levels, as it no longer fits under the open_api section of the format section. I have also taken out or re-factored instances of <response>, given I could not understand what the code did in this instance. I note that the example code in the repository is open_api, so there is already an example of open_api code.
to indicated that it uses the :open_api format
oestrich
reviewed
Jul 31, 2018
README.md
Outdated
@@ -307,21 +320,18 @@ paths: | |||
hide: true | |||
``` | |||
|
|||
#### Example of spec file | |||
## Example of acceptance spec file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line is specifically an example for the openapi stuff - so I'd leave it as is and then make a more generic section.
Put back open_api example spec in same place but labelled it clearly as being open_api specific. Moved generic example of spec up in document.
Thanks! |
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.
You can’t perform that action at this time.
This is a pull request that tries to resolve some of the documentation issues raised issue #386. The git log explains the changes.