2986_As_a_3rd-Party_integrator

lilitkarapetyan commented 3 weeks ago

🧰 Issue

🚀 Overview:

🔗 Link to preview

🤔 Reason:

🔨Work carried out:

[x] Tests pass

🖥️ Screenshot

Confirmations

[ ] I have chosen reviewers for my PR.
[ ] I have assigned myself to this PR.
[ ] I have chosen an appropriate label for the PR.
[ ] I have completed the mandatory sections of this document.
[ ] I have deleted any unused sections.
[ ] I confirm that I have checked for required README updates and acted accordingly.

📝 Developer Notes:

lilitkarapetyan commented 3 weeks ago

Fixes #2986

IanMayo commented 3 weeks ago

lilit, it isn't easy to review this. Are we hosting the pages in heroku deployment for this PR? Can I have a link?

lilitkarapetyan commented 3 weeks ago

lilit, it isn't easy to review this. Are we hosting the pages in heroku deployment for this PR? Can I have a link?

Yes I will send the heroku url now - https://serge-2986-as-a-3rd-par-nypcs9.herokuapp.com/api-docs/

IanMayo commented 2 weeks ago

This is great, thanks Lilit.

Do we have to run the server in a special mode to server the documents, or is there a way for the Swagger API to always be visible? (I don't think it really consumes much CPU)
Does `couchdb.js need to be documented?
Note: the storybook database should be deleted:

lilitkarapetyan commented 2 weeks ago

This is great, thanks Lilit.

1. Do we have to run the server in a special mode to server the documents, or is there a way for the Swagger API to always be visible?  (I don't think it really consumes much CPU)

2. Does `couchdb.js need to be documented?

3. Note: the `storybook` database should be deleted:
   ![image](https://private-user-images.githubusercontent.com/1108513/345398834-cc8b6569-fd9d-454f-83a1-7c288a17c80b.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjAwODQwOTIsIm5iZiI6MTcyMDA4Mzc5MiwicGF0aCI6Ii8xMTA4NTEzLzM0NTM5ODgzNC1jYzhiNjU2OS1mZDlkLTQ1NGYtODNhMS03YzI4OGExN2M4MGIucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDcwNCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA3MDRUMDkwMzEyWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9M2JmN2VlM2JiNWI1YTBkMzkyNjk2ZmY1Mzk5YTYxOWNkODhlZDZhNzgzYjBjNTA0ZDE3MDM3NmNmNWMyY2FhZiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.q-QCd97x80PIuz4ymOC-Cg4ZK9oamfI0acB0fVWPOnM)

Hi @IanMayo , Ir also works for couchDB

IanMayo commented 2 weeks ago

It also works for couchDB

Aah, is that because both backends use the same REST API structure, right?

IanMayo commented 2 weeks ago

Could we have a link in Serge to open the OpenAPI docs?

I suggest it's another link in the admin pages. I suggest it's a new button in the left-hand menu of the Admin page. It would go beneath WELCOME SCREEN, and be titled REST API.

lilitkarapetyan commented 2 weeks ago

Could we have a link in Serge to open the OpenAPI docs?

I suggest it's another link in the admin pages. I suggest it's a new button in the left-hand menu of the Admin page. It would go beneath WELCOME SCREEN, and be titled REST API.

@IanMayo , Okay I will add now. in this section ? Screenshot (302)

serge-web / serge