Skip to content

docs: standardize graphql examples#3391

Merged
brad-dow merged 4 commits into
mainfrom
docs-graphql-examples
Apr 11, 2025
Merged

docs: standardize graphql examples#3391
brad-dow merged 4 commits into
mainfrom
docs-graphql-examples

Conversation

@brad-dow
Copy link
Copy Markdown
Contributor

@brad-dow brad-dow commented Apr 9, 2025

Each GraphQL example is in a 3-tabbed panel: one for operation, one for arguments, and one for response.

Fixes #3090

brad-dow added 2 commits April 9, 2025 16:49
Implemented the 3-tabbed panel for all GraphQL examples. This affected the following pages:
- Integration - Requirements - Assets
- Integration - Requirements - Peers
- Integration - Requirements - Wallet addresses
- Integration - Requirements - Sending fees
@github-actions github-actions Bot added the pkg: documentation Changes in the documentation package. label Apr 9, 2025
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 9, 2025

Deploy Preview for brilliant-pasca-3e80ec ready!

Name Link
🔨 Latest commit a238ec7
🔍 Latest deploy log https://app.netlify.com/sites/brilliant-pasca-3e80ec/deploys/67f83017f69781000888201a
😎 Deploy Preview https://deploy-preview-3391--brilliant-pasca-3e80ec.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 9, 2025

🚀 Performance Test Results

Test Configuration:

  • VUs: 4
  • Duration: 1m0s

Test Metrics:

  • Requests/s: 43.44
  • Iterations/s: 14.49
  • Failed Requests: 0.00% (0 of 2615)
📜 Logs

> performance@1.0.0 run-tests:testenv /home/runner/work/rafiki/rafiki/test/performance
> ./scripts/run-tests.sh -e test "-k" "-q" "--vus" "4" "--duration" "1m"

Cloud Nine GraphQL API is up: http://localhost:3101/graphql
Cloud Nine Wallet Address is up: http://localhost:3100/
Happy Life Bank Address is up: http://localhost:4100/
cloud-nine-wallet-test-backend already set
cloud-nine-wallet-test-auth already set
happy-life-bank-test-backend already set
happy-life-bank-test-auth already set
     data_received..................: 912 kB 15 kB/s
     data_sent......................: 1.9 MB 31 kB/s
     http_req_blocked...............: avg=6.17µs   min=2.28µs   med=5.12µs   max=328.55µs p(90)=6.13µs   p(95)=6.57µs  
     http_req_connecting............: avg=241ns    min=0s       med=0s       max=172.06µs p(90)=0s       p(95)=0s      
     http_req_duration..............: avg=91.47ms  min=9.5ms    med=77.23ms  max=535.49ms p(90)=159.62ms p(95)=179.54ms
       { expected_response:true }...: avg=91.47ms  min=9.5ms    med=77.23ms  max=535.49ms p(90)=159.62ms p(95)=179.54ms
     http_req_failed................: 0.00%  ✓ 0         ✗ 2615
     http_req_receiving.............: avg=82.15µs  min=25.28µs  med=72.13µs  max=2.8ms    p(90)=105.87µs p(95)=129.71µs
     http_req_sending...............: avg=35.44µs  min=10.41µs  med=26.83µs  max=2.02ms   p(90)=41.33µs  p(95)=52.91µs 
     http_req_tls_handshaking.......: avg=0s       min=0s       med=0s       max=0s       p(90)=0s       p(95)=0s      
     http_req_waiting...............: avg=91.35ms  min=9.34ms   med=77.15ms  max=535.37ms p(90)=159.5ms  p(95)=179.36ms
     http_reqs......................: 2615   43.439661/s
     iteration_duration.............: avg=275.85ms min=172.06ms med=262.91ms max=1.03s    p(90)=334.52ms p(95)=358.38ms
     iterations.....................: 872    14.485424/s
     vus............................: 4      min=4       max=4 
     vus_max........................: 4      min=4       max=4 

Changed hardcoded links to relative links
hajjimo
hajjimo previously approved these changes Apr 10, 2025
@melissahenderson
Copy link
Copy Markdown
Contributor

@brad-dow I know it wasn't on your list, but can you update the "viewing and revoking grants" page so that both of the arguments have the link to the mutation's input object?

@brad-dow
Copy link
Copy Markdown
Contributor Author

@brad-dow I know it wasn't on your list, but can you update the "viewing and revoking grants" page so that both of the arguments have the link to the mutation's input object?

I made this change but the first one was a query, which made it just a little bit different. There's not an input object to point to, so I just linked to the query itself. Also, noticing all of our specs say 'arguments' as well :/ I need to take a GraphQL course

@melissahenderson
Copy link
Copy Markdown
Contributor

@brad-dow Yeah, I see that too. I guess we shouldn't be surprised if we have to come back to this in a few months and change them all back to argument 😂

@brad-dow brad-dow merged commit d14a4c9 into main Apr 11, 2025
44 checks passed
@brad-dow brad-dow deleted the docs-graphql-examples branch April 11, 2025 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pkg: documentation Changes in the documentation package.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: standardize graphql api examples

3 participants