jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Aleksei Akimov
2017-12-14 10:38:18 +01:00
committed by GitHub
parent e8c613a273
commit e0793dba33
1 changed files with 23 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -25,21 +25,35 @@ There are multiple ways you can use the OpenAPI specification to explore the Ady
## Vendor extensions
Adyen's specifications contain some custom extensions, as [allowed by the OpenAPI standard](https://swagger.io/docs/specification/openapi-extensions/). These are annotations that provide metadata, such as the grouping and sort order of API objects, when they are displayed in the [Adyen API Explorer](https://docs.adyen.com/api-explorer/).
Adyen's specifications contain some custom extensions, as [allowed by the OpenAPI standard](https://swagger.io/docs/specification/openapi-extensions/). These are extensions that provide metadata, such as the grouping and sort order of API objects, when they are displayed in the [Adyen API Explorer](https://docs.adyen.com/api-explorer/).
### x-groups
This extension provides a list of all endpoint groups for the selected API.
For example:
```
"x-groups" : [
"General",
"Modifications"
],
"post" : {
"x-groupName" : "Modifications",
"x-sortIndex" : 5,
x-groups:
- General
- Modifications
```
### x-groupName and x-sortIndex
These extensions specify how to group endpoints and sort them within a group.
For example:
```
paths:
...
post:
...
x-groupName: Modifications
x-sortIndex: 5
...
```
## Support