Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

FRW-5858 Added description how to API specification file download in data exchange API. #2147

Merged
merged 9 commits into from
Oct 11, 2023
Merged

FRW-5858 Added description how to API specification file download in data exchange API. #2147

merged 9 commits into from
Oct 11, 2023

Conversation

geega
Copy link
Contributor

@geega geega commented Sep 6, 2023 •
edited
Loading

geega
geega commented Sep 6, 2023
View reviewed changes
...ue-api-guides/202307.0/data-exchange-api/how-to-guides/how-to-configure-data-exchange-api.md Outdated

You can download the specification of the Data Exchange API endpoints in the OpenAPI format. To do so, click **Download Data Exchange API specification** on the **Data Exchange API Configuration** page.

[PASTE SCREENSHOT HERE]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

download-btn

geega
geega commented Sep 6, 2023
View reviewed changes
...ue-api-guides/202307.0/data-exchange-api/how-to-guides/how-to-configure-data-exchange-api.md Outdated

If you added new endpoints, documentation will be updated automatically with the new endpoints, but need wait 1 minute for it. You can see message about it in the top of the page:

[PASTE SCREENSHOT HERE]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2023-09-06 at 15 17 41

geega
geega commented Sep 6, 2023
View reviewed changes
...ue-api-guides/202307.0/data-exchange-api/how-to-guides/how-to-configure-data-exchange-api.md Outdated
So. please wait 1 minute and refresh the page. After that you will see new endpoints in the documentation.
Also if for some reason file not exists, you will see the message about it:

[PASTE SCREENSHOT HERE]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2023-09-06 at 15 10 51

@geega geega changed the title FRW-5858 Adjusted docs about download schema FRW-5858 Added description how to API specification file download in data exchange API. Sep 6, 2023
asmarovydlo
asmarovydlo requested changes Sep 6, 2023
View reviewed changes
Copy link
Contributor

@asmarovydlo asmarovydlo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Please mention somewhere that documentation generation might be in progress, and the button will appear whenever the documentation generation is finished.
  2. Why the screenshots added just as a comment? Will TW upload the images?

@geega
Copy link
Contributor Author

geega commented Sep 7, 2023

@asmarovydlo

  1. Added text about button.
  2. Yes. I don't know where to download the pictures. I see that this is an s3 bucket, but I don't have access to it. So I did like on PR for basic branch

@geega
Copy link
Contributor Author

geega commented Sep 12, 2023

@asmarovydlo
I added screenshots docs/scos/dev/drafts-dev
@lenadoc helped me with it.
https://spryker.atlassian.net/wiki/spaces/DOCS/pages/3554246794/Contributing+to+docs+for+Spryker+developers

Currently, only technical writers can add images to documentation. If you need to insert an image to your doc, add it here. The technical writer who will review your PR will move the image to the proper storage.

asmarovydlo
asmarovydlo previously approved these changes Sep 12, 2023
View reviewed changes
@dimitriyTsemma dimitriyTsemma added new PR contains a new document TW review needed PR needs Technical writer's review labels Sep 12, 2023
Base automatically changed from feature/frw-2211/master-ui-data-exchange-api to master September 28, 2023 12:13
@lenadoc lenadoc dismissed asmarovydlo’s stale review September 28, 2023 12:13

The base branch was changed.

asmarovydlo
asmarovydlo previously approved these changes Oct 6, 2023
View reviewed changes
@asmarovydlo
Copy link
Contributor

The base branch was changed.
It is OK, @lenadoc could you please make TW review, and if all is good - merge?

@lenadoc lenadoc added in TW review PR is in review by a technical writer and removed TW review needed PR needs Technical writer's review labels Oct 11, 2023
@lenadoc lenadoc merged commit d6c83f2 into master Oct 11, 2023
13 checks passed
@lenadoc lenadoc deleted the feature/frw-5858/master-download-api-spec-file branch October 11, 2023 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dimitriyTsemma dimitriyTsemma dimitriyTsemma left review comments

@asmarovydlo asmarovydlo asmarovydlo left review comments

Assignees
No one assigned
Labels
in TW review PR is in review by a technical writer new PR contains a new document
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@geega @asmarovydlo @dimitriyTsemma @lenadoc