Manage API Metadata

associate additional information with api resources docid\ xwl5x ozzt8yuzhlnjbi2 published within the centralized directory docid\ kt2uiavikzfzklbevp1 g include api specific details like endpoints, status, and certification the api metadata is a property related to an api resource family type and can be enabled or disabled by raidiam through the configuration of api resources this provisory documentation will be updated once the api metadata feature is fully implemented on the directory ui it will allow the updates to be executed directly from the ui, avoiding interactions with the directory apis and postman as showcased here prerequisites users docid\ ijyftusvdonrn4rxsnsev or users docid\ ijyftusvdonrn4rxsnsev access to the platform add server docid\ tykucwbkh0mzly9tesuiw the desired family types must be registered for the api resources with the correct api version the api metadata property must be enabled for all desired family types in order to activate the feature on the directory to evaluate if the api metadata is enabled for a specific family type and what is the expected swagger, it's possible to call the config/apiresources public endpoint example for the raidiam sandbox https //web sandbox raidiam io/config/apiresources https //web sandbox raidiam io/config/apiresources the api resource family type must be created and configured within the authorisation server by the user get and edit api metadata using apis for illustrative purposes, postman is used to retrieve (using get) or edit (using put) api metadata via connect's apis in postman, go to settings > certificates > add certificate add the pem and key file in the crt file and key file fields respectively the pem file can be downloaded from the directory ( organisation certificates > actions next to the certificate you wish to download > download ) the key file was created during the creation of the certificate these must be kept safe and individual if you have no certificates available yet, manage certificates for organisation docid\ rfyhtnlocobktfbja2o1o add the host of the ecosystem a n example from raidiam sandbox https //matls auth sandbox raidiam io https //matls auth sandbox raidiam io/token save the certificate in postman in connect, navigate to the organisation of your choice (which certificate you used in postman) select data providers and a data provider (authorisation server) of your choice select api resources with your mouse, click the right button and select inspect and choose the network tab of the developer tools to load all the requests may require you to go back to data provider view and then click again on api resources tab click with the right button on the apiresources request and copy the request as curl import the curl to postman to generate a new request copy the api resource id from the details of the api resource in connect you can find the api resource identifier in data providers > chosen provider > api resources > actions > view example api resources identifier example add the copied api resource id to your curl request's url path along with /metadata example /your api resource id/metadata if you want to edit the api metadata through a put request, insert the raw json with the new metadata into the body of the request send the request