-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathworkflow.yml
181 lines (144 loc) · 4.38 KB
/
workflow.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
---
# APIs JSON/YAML Specification Details
specificationVersion: '0.1'
specificationType: 'Workflow'
# Overview of this API
name: Example API
description: This is an example APIS JSON/YAML dedicated to a specific workflow using multiple APIs.
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
url: http://example.com/apis.json
# Tags for helping organize
tags:
- Application Programming Interface
- API
# Time frame for API evolution
created: '2023-07-19'
modified: '2023-07-19'
# Elements of APIs
apis:
# First Step in Workflow
- name: Example API
description: This provides details about a specific API, telling what is possible.
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
humanURL: http://example.com
baseURL: http://api.example.com
mapping:
- in: $.data.token
out: $header.Authorization
- in: $.data.region
out: $header.region
- in: $.data.version
out: $header.Version
sort: 1
tags:
- API
- Application Programming Interface
properties:
- type: x-signup
url: https://example.com/signup
- type: x-documentation
url: https://example.com/documentation
- type: x-openapi
url: http://example.com/openapi.json
- type: x-json-schema
url: http://example.com/json-schema.json
contact:
- FN: APIs.json
email: [email protected]
X-twitter: apisjson
# Second Step in Workflow
- name: Example API
description: This provides details about a specific API, telling what is possible.
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
humanURL: http://example.com
baseURL: http://api.example.com
mapping:
- in: $.contact.address
out: $.profile.address1
- in: $.contact.city
out: $.profile.city
- in: $.contact.state
out: $.profile.state
- in: $.contact.postal_code
out: $.profile.zip
sort: 2
tags:
- API
- Application Programming Interface
properties:
- type: x-signup
url: https://example.com/signup
- type: x-documentation
url: https://example.com/documentation
- type: x-openapi
url: http://example.com/openapi.json
- type: x-json-schema
url: http://example.com/json-schema.json
contact:
- FN: APIs.json
email: [email protected]
X-twitter: apisjson
# Third Step in Workflow
- name: Example API
description: This provides details about a specific API, telling what is possible.
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
humanURL: http://example.com
baseURL: http://api.example.com
mapping:
- in: $.order.amount
out: $.sale.price
- in: $.order.date
out: $.sale.date
sort: 3
tags:
- API
- Application Programming Interface
properties:
- type: x-signup
url: https://example.com/signup
- type: x-documentation
url: https://example.com/documentation
- type: x-openapi
url: http://example.com/openapi.json
- type: x-json-schema
url: http://example.com/json-schema.json
contact:
- FN: APIs.json
email: [email protected]
X-twitter: apisjson
# Governance
govern:
- type: lifecycle-rules
title: Lifecycle Rules
description: Spectral rules governing this APIs JSON/YAML definition.
url: 'https://example.com/design-rules'
- type: design-rules
title: Design Rules
description: Spectral rules governing the design of the API using OpenAPI.
url: 'https://example.com/design-rules'
# Data Storage to seed workflows
data:
store:
token: a334adfaf333234
region: us-east1
version: v1
addresses:
- address: 345 Broadway
city: New York
state: New York
postal: 10019
# Centralized Elements
elements:
- type: x-documentation
url: https://example.com/documentation
- type: x-video
url: https://example.com/video
# Other Related APIs to Include
include:
- name: Another Example API
url: http://example.com/apis.json
# Who is Maintaining this APIs JSON/YAML
maintainers:
- FN: Kin Lane
X-twitter: apievangelist
email: [email protected]