Skip to content

Commit

Permalink
Merge pull request #771 from zalando/api-id-no-copy
Browse files Browse the repository at this point in the history
meta-information: do not copy the API-ID
  • Loading branch information
Tronje Krop authored Oct 17, 2023
2 parents 03c1eb0 + 46bac7c commit bee2a4c
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions chapters/meta-information.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,12 @@ API publishing date>> as order criteria you get the *version* or
*publication history* as a sequence of API specifications.

*Note*: While it is nice to use human readable API identifiers based on
self-managed URNs, it is recommend to stick to UUIDs to relief API designers
from any urge of changing the API identifier while evolving the API. Example:
self-managed URNs, it is recommend to stick to a UUID (freshly generated when
first creating the API) to relief API designers from any urge of changing
the API identifier while evolving the API. *Do not copy an API unless you
immediately change the API identifier in it!*

Example:

[source,yaml]
----
Expand Down

0 comments on commit bee2a4c

Please sign in to comment.