Commit Graph

7 Commits

Author SHA1 Message Date
Steve McGee 74bf78a409 update graphql documentation
closes INTEROP-8110
flag=none

test plan:
n/a (see pre/post images on Jira)

Change-Id: I5419f3fdc93aa1f7f57abfa3d42439269a3a8f9b
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/320192
Reviewed-by: Tucker Mcknight <tmcknight@instructure.com>
QA-Review: Steve Mcgee <steve.mcgee@instructure.com>
Product-Review: Alexis Nast <alexis.nast@instructure.com>
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
2023-06-13 16:04:00 +00:00
Evan Battaglia a648af9f0a Revert "first pass at exposing API Gateway docs to canvas users"
This reverts commit 73cf5f3be8
(Except for two unrelated typo fixes also found in that commit.)

closes INTEROP-7888

Test plan:
- run `dcr web rake doc:api`
- go to `http://canvas.docker/doc/api/file.graphql.html`
  and make sure it looks good and doesn't mention the gateway

Change-Id: Iad8c745ae3257c45c562fcac65cf98f90816b5fb
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/308329
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
Reviewed-by: Xander Moffatt <xmoffatt@instructure.com>
QA-Review: Evan Battaglia <ebattaglia@instructure.com>
Product-Review: Evan Battaglia <ebattaglia@instructure.com>
2023-01-10 14:21:10 +00:00
Ethan Vizitei 73cf5f3be8 first pass at exposing API Gateway docs to canvas users
closes INTEROP-7042

TEST PLAN:
  1) published api docs should contain api gateway examples

Change-Id: I79e070d3d208ff1fcd591350a5c6617cd0cce0cf
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/273561
Reviewed-by: Michael Ziwisky <mziwisky@instructure.com>
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
QA-Review: Ethan Vizitei <evizitei@instructure.com>
Product-Review: Ethan Vizitei <evizitei@instructure.com>
2021-10-04 19:06:12 +00:00
Alexandre Trindade be9b6d862f Updates a broken link in the GraphQL API doc
fixes INTEROP-6822
flag=none

Test plan
- Access the URL /doc/api/file.graphql.html
- Reach the section "GraphQL in Canvas" > "Pagination"
- Check the "Relay Object Identification spec" link

Change-Id: I1c56cf30d017964537ff04b257d112286ec8a822
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/266987
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
Product-Review: Alexandre Trindade <alexandre.trindade@instructure.com>
Reviewed-by: Ryan Hawkins <ryan.hawkins@instructure.com>
Reviewed-by: Xander Moffatt <xmoffatt@instructure.com>
QA-Review: Xander Moffatt <xmoffatt@instructure.com>
2021-06-18 16:53:46 +00:00
Jacob Burroughs 5e05092ecc Remove more freenode references
Change-Id: I9308b42ecaadc5d20e69f88257a0c34aae2d9653
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/266181
Reviewed-by: Bryan Petty <bpetty@instructure.com>
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
QA-Review: Jacob Burroughs <jburroughs@instructure.com>
Product-Review: Jacob Burroughs <jburroughs@instructure.com>
2021-06-02 16:18:53 +00:00
Erin Hallmark ac8b021bad Modify API Change Log pages
This commit removes the Breaking Changes and API
Change Log Archive pages. I also updated the H1
formatting for the changelog and graphql pages.

Closes: DOC-1148

flag=none

Test plan:
- run bundle exec rake doc:api
- the sidebar should not include the breaking changes page
- the API change log page should have a link to the new
page in the canvas community

Change-Id: I00b7465d0ef05a64d97a50c21e24db90bf54a438
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/228796
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
QA-Review: Erin Hallmark <erin@instructure.com>
Product-Review: Erin Hallmark <erin@instructure.com>
Reviewed-by: Rob Orton <rob@instructure.com>
2020-03-04 17:10:22 +00:00
Cameron Matheson bb3b675889 add api documentation for graphql
closes GQL-51

Change-Id: Idd44990763c72642d6a59d8bbf50cae886a216d2
Reviewed-on: https://gerrit.instructure.com/197635
Tested-by: Jenkins
QA-Review: Erin Hallmark <erin@instructure.com>
Product-Review: Erin Hallmark <erin@instructure.com>
Reviewed-by: Landon Gilbert-Bland <lbland@instructure.com>
2019-06-24 18:44:50 +00:00