Skip to content

API and Product details pages #2214

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.

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

Draft
wants to merge 248 commits into
base: master
Choose a base branch
from
Draft

Conversation

malincrist
Copy link
Member

@malincrist malincrist commented Jun 20, 2023

This PR introduces two new widgets: the "API details page" and the "Product details page," designed to enhance and enrich the user experience when interacting with our platform.

API Details Page Widget:

The "API details page" widget offers an improved layout for the existing APIs page. It features a left-side menu that grants users quick access to API details, such as products, changelog, and operations.
The customizations for the operations within this widget are consistent with those found in the "List of Operations" widget, while the customizations for the operation details match those of the "Operation details" widget.

Below, you can find a screenshot showcasing the "API details page" widget:
image

Product Details Page Widget:

Simultaneously, the "Product details page" widget shares a similar left-side menu layout, allowing users to effortlessly navigate through key details related to a specific product.

Below, you can find a screenshot showcasing the "Product details page" widget:
image

Custom documentation

Additionally, this update introduces a new section for both widgets called "Documentation" which showcases the markdown documentations associated with the selected API/Product.

malincrist and others added 30 commits February 22, 2022 12:44
#1584)

* Create mainCI.yml

Work in progress, don't merge

* Update mainCI.yml

* Update mainCI.yml

* Update mainCI.yml

* Update mainCI.yml

* Update mainCI.yml

* added script for build website

* Update mainCI.yml

* Update mainCI.yml

* Update mainCI.yml

* Update mainCI.yml

* Update mainCI.yml

* Update mainCI.yml

* Update mainCI.yml

* Fixed color contrast accessibility issues

* Fixed ari-roles issues

* added static storage wip

* Added missing static data

* Update mainCI.yml

* added static data for requests made at publishing time

* updated PublisherStaticDataProvider

* updated PublisherStaticDataProvider

* updated PublisherStaticDataProvider

* get data from default.json too

* added build-static-data script

* refactoring

* removed logs

* removed some headers from static data

* removed headers

* added smaller GraphQL api

* Update mainCI.yml

* Update mainCI.yml

* Update mainCI.yml

* Update mainCI.yml

* test accessibility on profile

* Update mainCI.yml

* Update mainCI.yml

* removed headers

* test with pre-populated e-mail and password

* compacted json files

* removed test e-mail and password

* code review changes

* test for signed in version

* added default.json and defaultMockData.json only for staticData

* fixed webpack configs

* fixed accessibility issues

* fixed accessibility issues

* added staticDataEnviroment constant

* Update mainCI.yml

* removed logs

* renamed defaultMockData.json
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.14.7 to 1.14.8.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](follow-redirects/follow-redirects@v1.14.7...v1.14.8)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…enerate.js (#1675)

> @azaslonov Thank you for accepting the PR. Not sure why the build failed. It appears not related to my changes. Any insights?

This is accessibility check, doesn't seem to be related to your PR.
@malincrist, do you mind taking a look?
* Added support for union types in the graphql console

* Removing hardcoding and using constant values from the graphql library
Implementation inspired by #1621

Co-authored-by: Jonas Anker Rasmussen <[email protected]>
* Add "API: Products (dropdown)" widget

Closes #1177

* Update src/components/apis/api-products/ko/runtime/api-products-dropdown.ts

Avoid assigning undefined to undefined

Co-authored-by: Rafał Mielowski <[email protected]>

* Remove unnecessary function called in the next line by other function

Co-authored-by: Rafał Mielowski <[email protected]>
* Supporting graphql subscriptions

* Adding improvements and style variables to the gql console.
@github-actions
Copy link

github-actions bot commented Jun 20, 2023

Accessibility Insights Accessibility Insights Action

  • URLs: 1 URL(s) failed, 11 URL(s) passed, and 0 were not scannable
  • Rules: 1 check(s) failed, 28 check(s) passed, and 23 were not applicable
  • Download the Accessibility Insights artifact to view the detailed results of these checks

Failed instances

  • 1 × aria-required-children: Ensures elements with an ARIA role that require child roles contain them

This scan used axe-core 4.3.2 with Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36.

@malincrist malincrist changed the title API details page API and Product details pages Jul 25, 2023
@ronaldbosma
Copy link

I'm interested in shownig documentations on the API details page and perhaps on other pages as well. Is there any information on when this change will be available in the developer portal?

@azaslonov azaslonov force-pushed the malincrist/feature/api-wiki branch from 8af12fd to f516fd0 Compare March 21, 2025 19:50
@azaslonov azaslonov force-pushed the master branch 2 times, most recently from f4cb86d to 7908fbe Compare March 21, 2025 20:49
@azaslonov azaslonov force-pushed the malincrist/feature/api-wiki branch from f516fd0 to 3084b1b Compare March 21, 2025 20:49
@azaslonov azaslonov force-pushed the master branch 2 times, most recently from 79dae19 to a74f7db Compare March 21, 2025 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.