Skip to content

Commit 2e29d36

Browse files
committed
docs(readme): updated schema comments
1 parent d2e880a commit 2e29d36

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,31 @@ An example for the petstore endpoint can be found [here](./example/petstore.json
3434
This endpoint definition is transformed into a GraphQL schema, with all the paths from the endpoint translated into queries and mutations. This schema looks like this:
3535
```graphql
3636
type Query {
37-
""" GET /pet/findPetsByStatus """
37+
# GET /pet/findPetsByStatus
3838
findPetsByStatus(status: [String]): [findPetsByStatus_items]
39-
""" GET /pet/findPetsByTags """
39+
40+
# GET /pet/findPetsByTags
4041
findPetsByTags(tags: [String]): [findPetsByTags_items]
41-
""" GET /pet/{petId} """
42+
43+
# GET /pet/{petId}
4244
getPetById(petId: String): getPetById
45+
4346
# other queries
4447
}
4548

4649
type Mutation {
47-
""" POST /pet """
50+
# POST /pet
4851
addPet(body: param_addPet_body): addPet
49-
""" PUT /pet """
52+
53+
# PUT /pet
5054
updatePet(body: param_updatePet_body): updatePet
51-
""" PUT /pet/{petId} """
55+
56+
# PUT /pet/{petId}
5257
updatePetWithForm(petId: String, name: String, status: String): updatePetWithForm
53-
""" DELETE /pet/{petId} """
58+
59+
# DELETE /pet/{petId}
5460
deletePet(api_key: String, petId: String): deletePet
61+
5562
# other mutations
5663
}
5764
```

0 commit comments

Comments
 (0)