| CARVIEW |
Select Language
HTTP/2 200
date: Sun, 27 Jul 2025 05:36:07 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=330.097309,conversation_content-fragment;desc="conversation_content fragment";dur=735.114253,conversation_sidebar-fragment;desc="conversation_sidebar fragment";dur=191.737289,nginx;desc="NGINX";dur=1.060728,glb;desc="GLB";dur=101.529758
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=HjJSvuratftFcjnjnf1JuEYAO5mPbY449vaIB8wT1Wt84EVQnja8N%2FpsUKDwrsG6Q7P872Yn%2FeNVtFA4%2BchIUoxojub3QDgp33XeEDwMJCtLPU85VykK%2BUKoYqRQn3r5C6I%2B89QLXQm347jl72KiyB%2BhFsf5U%2Fvh48OzkKZSOtuZBW5YVb6jqnmm3usJ2yBbiQ2LfH2UnEXvjK5J3hI3ZwCrkFwlvnSX5UST18LPhgWU8XceHPVyigOj5M4LOdsBLcvCR90Aki320fbUc56aCQ%3D%3D--xuWaUzCDs7LS5eSb--BBjBckk7XlZwDMBWHSaIQw%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.1285522406.1753594567; Path=/; Domain=github.com; Expires=Mon, 27 Jul 2026 05:36:07 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Mon, 27 Jul 2026 05:36:07 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: 9304:1369AB:B11F76:EBEBCA:6885BAC7
Another attempt at adding explanations to resources by Mask · Pull Request #269 · zipmark/rspec_api_documentation · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 372
Another attempt at adding explanations to resources #269
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
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
| @@ -369,6 +369,22 @@ resource "Orders" do | |||
| end | |||
| ``` | |||
|
|
|||
| A resource can also have an example. | |||
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.
A resource can also have an explanation
|
this looks in good shape and is something I was looking to add as well! Thanks! |
|
This looks good. Thanks! |
yachuntsai
pushed a commit
to iKala/apitome
that referenced
this pull request
Jul 9, 2016
Support resource explanation rendering of rspec api documentation. See more details in zipmark/rspec_api_documentation#269 .
yachuntsai
pushed a commit
to iKala/apitome
that referenced
this pull request
Jul 10, 2016
Support resource explanation rendering of rspec api documentation. See more details in zipmark/rspec_api_documentation#269 .
griley
pushed a commit
to tedconf/apitome
that referenced
this pull request
Sep 7, 2016
DmitriyBaklikov
pushed a commit
to DmitriyBaklikov/apitome
that referenced
this pull request
May 12, 2017
Support resource explanation rendering of rspec api documentation. See more details in zipmark/rspec_api_documentation#269 .
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
None yet
3 participants
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.
I just merged the fork of @jramos #196 with the current master. The tests seem to all be fine.
This should cover #186.