This can be specified in the API Manager User Interface when specifying a product
With regards to adding further documentation to a Product as part of your CI/CD pipeline this can be achieved via the Portal Admin CLI Toolkit, please see https://www.ibm.com/docs/en/api-connect/10.0.x?topic=commands-using-product step 5 "Add an attachment for your product within your Developer Portal"
Original Message:
Sent: Wed October 09, 2024 12:15 PM
From: Syed Imtiyaz Alam
Subject: Documenting Release notes in YAML
Thank you Anne.
adding or attaching another documents I am trying to avoid as it requires admin to login and make changes everytime.
but if it is part of Product or API yaml then it will be part of normal CICD pipeline.
So could you please help me with what is this termsOfService parameter and what is the purpose of that or is there any other field which are available to be used.
i tried checking the IBM site for documentation and I could not find the termsof Service
https://www.ibm.com/docs/en/api-connect/10.0.x?topic=api-example-product-file-globalweatherproduct-100yaml
------------------------------
Syed Imtiyaz Alam
Original Message:
Sent: Tue October 08, 2024 06:36 AM
From: Anne Redwood
Subject: Documenting Release notes in YAML
We do have a predefined section : Terms of Service
This can be included in product yaml:
product: 1.0.0info: name: surfing-products title: Surfing Products version: 1.0.0 description: >- This is a description. summary: This is a summary termsOfService: >- Turning on good alley-oop blown out casual off the bottom reef rash big windup 3rd reef burner, cutties. Out the back, full rotation kook of the day jumbled transition snap the OB. Surfing tides catching some shade full mad air reverse rad, hallow above the lip top turn. Stall flow sand bottom flow surfing barreling smooth, explosive ripper pearl. Spittin', hallow ridin' the foam ball blown out Gold Coast booties paddle. Wax the stick sets twin fin sets channel sick. Clamped, poked the nose slash kook fat 360, pipeline, no kooks........
You are correct in that you could use x-embedded-doc and document the release notes that way.
An alternative would be to create a Basic Page with the contents of your release notes and link that page to all your products or a selection of your products :
These methods and further documentation methods are outlined in this blog article previously published
https://community.ibm.com/community/user/integration/blogs/chris-dudley1/2021/10/08/how-to-document-an-api
------------------------------
Anne Redwood
Original Message:
Sent: Fri October 04, 2024 11:22 AM
From: Syed Imtiyaz Alam
Subject: Documenting Release notes in YAML
Hi ,
I am trying to understand if there is pre-defined section like release notes where we document release notes in YAML and is visible in developer portal.
Other option is to use x-embedded-doc and document those release notes here. but i am trying to see if YAML has any pre-defined section.
Or can you please provide me better suggestions.
------------------------------
Syed Imtiyaz Alam
------------------------------