lifecycle/lifecycle-example-1.yml at main · api-commons/lifecycle · GitHub

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
define:
  name: Define
  description: This stage is where you define the business requirements for the API.
  image: /images/define.png
  policies:
    - github-organization
    - github-repository
    - postman-workspace
    - teams
    - standards
    - use-cases
    - contract-metadata
    - api-metadata
    - road-map
    - change-log
    - questions
    - governance
  guidance: lifecycle/define
design:
  name: Design
  description: This stage is where you design the schema and OpenAPI for the API.
  image: /images/design.png
  policies:
    - openapi
    - openapi-components
    - openapi-path-names
    - openapi-operation-identifiers
    - openapi-operation-summary
    - openapi-operation-description
    - openapi-operation-request-bodies
    - openapi-operation-request-bodies-media-types
    - openapi-operation-request-bodies-schema
    - openapi-operation-parameters
    - openapi-operation-parameter-in
    - openapi-operation-parameter-names
    - openapi-operation-parameter-descriptions
    - openapi-operation-parameter-types
    - openapi-operation-parameter-schema
    - openapi-operation-parameter-enum
    - openapi-operation-tags
    - openapi-operation-security
    - openapi-operation-response-2xx
    - openapi-operation-response-2xx-media-types
    - openapi-operation-response-2xx-schema
    - openapi-operation-response-2xx-examples
    - openapi-operation-response-4xx
    - openapi-operation-response-4xx-media-types
    - openapi-operation-response-4xx-schema
    - openapi-operation-response-4xx-examples
    - openapi-operation-response-5xx
    - openapi-operation-response-5xx-media-types
    - openapi-operation-response-5xx-schema
    - openapi-operation-response-5xx-examples
    - openapi-schema-type
    - openapi-schema-names
    - openapi-schema-descriptions
    - openapi-schema-property-names
    - openapi-schema-property-descriptions
    - openapi-schema-property-types
    - openapi-schema-property-enums
    - openapi-schema-property-required
    - openapi-schema-property-shapes
    - postman-collection
    - documentation
  guidance: lifecycle/design
develop:
  name: Develop
  description: This stage is where you develop the code and database for the API.
  image: /images/develop.png
  policies:
    - openapi-security
    - source-of-truth-actions
    - base-url
    - sdks
  guidance: lifecycle/develop
staging:
  name: Staging
  description: This stage is where you deploy the code for the API to staging.
  image: /images/staging.png
  policies:
    - human-url
    - portals
    - getting-started
    - plans
    - status
    - performance
  guidance: lifecycle/staging
production:
  name: Production
  description: This stage is where you deploy the code for the API to production.
  image: /images/production.png
  policies:
    - support
    - feedback
    - blogs
    - blog-feeds
    - videos
    - terms-of-service
    - privacy-policy
    - licensing
  guidance: lifecycle/production