Skip to content

Commit d2e880a

Browse files
committed
docs(readme): updated schema descriptions
1 parent 0fb7d4f commit d2e880a

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,23 @@ 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 """
3738
findPetsByStatus(status: [String]): [findPetsByStatus_items]
39+
""" GET /pet/findPetsByTags """
3840
findPetsByTags(tags: [String]): [findPetsByTags_items]
41+
""" GET /pet/{petId} """
3942
getPetById(petId: String): getPetById
4043
# other queries
4144
}
4245

4346
type Mutation {
47+
""" POST /pet """
4448
addPet(body: param_addPet_body): addPet
49+
""" PUT /pet """
4550
updatePet(body: param_updatePet_body): updatePet
51+
""" PUT /pet/{petId} """
4652
updatePetWithForm(petId: String, name: String, status: String): updatePetWithForm
53+
""" DELETE /pet/{petId} """
4754
deletePet(api_key: String, petId: String): deletePet
4855
# other mutations
4956
}

0 commit comments

Comments
 (0)