From 13681f12045274756b1a1e12cc448e176669c9a0 Mon Sep 17 00:00:00 2001 From: Cameron Koegel <53310569+ckoegel@users.noreply.github.com> Date: Tue, 3 Dec 2024 16:55:02 -0500 Subject: [PATCH] SWI-4287 Sync Fork (#36) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * sync: Synced local 'docs/' with remote 'docs/redoc/' * chore: remove broken link from demo (#2338) * fix: renames 'FieldContstraints' to 'FieldConstraints' (#2352) Co-authored-by: Ricagraca * fix: schema oneOf title with const (#2350) * docs: adds vale rules and workflow for running in CI (#2348) * docs: adds vale rules and workflow for running in CI * docs: updates product name from ReDoc to Redoc * chore: update packages dependecy (#2360) * chore: update packages dependecy * fix: remove redundant options * fix: webpack config demo folder * fix: replace cypress ts-loader * chore: remove redundant dependency * chore(deps-dev): bump word-wrap from 1.2.3 to 1.2.4 (#2359) Bumps [word-wrap](https://github.com/jonschlinkert/word-wrap) from 1.2.3 to 1.2.4. - [Release notes](https://github.com/jonschlinkert/word-wrap/releases) - [Commits](https://github.com/jonschlinkert/word-wrap/compare/1.2.3...1.2.4) --- updated-dependencies: - dependency-name: word-wrap dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat: enable keyboard navigation (#2361) * docs: fix and update links in redoc-vendor-extensions (#2368) Co-authored-by: Lorna Jane Mitchell * feat: add x-tags (#2355) * feat: add x-tags * chore: fix e2e tests and add new for x-tag * chore: add x-tags to demo definition * chore: update snapshots * feat: add support of react 18 (#2369) * feat: add support of react 18 * chore: add newest version of styled-components to peerDependencies * chore: add supoort of styled components * chore: downgrade types * chore: update snapshots * chore: update cypress to 12.17.1 * chore: upgrade openapi-core to 1.0.0-rc.2 * chore: upgrade packages for fixing vulnerabilities * docs: Remove Redoc CLI and a non-existent config option * chore: v2.1.0 (#2382) * fix: hotfix, crash after 2.1 release * chore: v2.1.1 * chore: add tests for cover field default crash (#2389) * fix: react18 cli integration (#2404) * fix: react18 cli integration * fix: update unit tests snapshots * chore(deps): bump @cypress/request and cypress (#2410) Bumps [@cypress/request](https://github.com/cypress-io/request) to 3.0.1 and updates ancestor dependency [cypress](https://github.com/cypress-io/cypress). These dependencies need to be updated together. Updates `@cypress/request` from 2.88.11 to 3.0.1 - [Release notes](https://github.com/cypress-io/request/releases) - [Changelog](https://github.com/cypress-io/request/blob/master/CHANGELOG.md) - [Commits](https://github.com/cypress-io/request/compare/v2.88.11...v3.0.1) Updates `cypress` from 12.17.1 to 13.1.0 - [Release notes](https://github.com/cypress-io/cypress/releases) - [Changelog](https://github.com/cypress-io/cypress/blob/develop/CHANGELOG.md) - [Commits](https://github.com/cypress-io/cypress/compare/v12.17.1...v13.1.0) --- updated-dependencies: - dependency-name: "@cypress/request" dependency-type: indirect - dependency-name: cypress dependency-type: direct:development ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix: style RefreshToken URL as in the authorization section Co-authored-by: szaszeke * chore: v2.1.2 (#2413) * fix: more cases for react18 and cli integration (#2416) * Config docs and README refresh (#2393) * docs: Give Redoc a landing page with overview and tldr instructions * docs: move config to dedicated page * docs: modernise README, link to resources * docs: more detailed format for theme configurations * fix: README formatting * fix: Fix future tense errors and add exceptions for config fields as headings * Apply suggestions from code review Co-authored-by: Heather Cloward * docs: minor updates from excellent pull request feedback * docs: Remove the old quickstart, update HTML as the preferred onboarding method and improve docs/examples on that page * Apply suggestions from code review Co-authored-by: Heather Cloward --------- Co-authored-by: Heather Cloward * sync: Synced local 'docs/' with remote 'docs/redoc/' * sync: Synced local 'docs/' with remote 'docs/redoc/' * sync: Synced local 'docs/' with remote 'docs/redoc/' * sync: Synced local 'docs/' with remote 'docs/redoc/' * sync: Synced local 'docs/' with remote 'docs/redoc/' * chore(deps-dev): bump postcss from 8.4.27 to 8.4.31 (#2427) Bumps [postcss](https://github.com/postcss/postcss) from 8.4.27 to 8.4.31. - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](https://github.com/postcss/postcss/compare/8.4.27...8.4.31) --- updated-dependencies: - dependency-name: postcss dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * sync: Synced local 'docs/' with remote 'docs/redoc/' * fix: default value as object in request body (#2437) * fix: hideRequestPayloadSample (#2436) * fix: display string pattern in array items (#2438) * chore: v2.1.3 (#2439) * sync: Synced local 'docs/' with remote 'docs/redoc/' * docs: fix admonition on config page (#2452) * Update README.md (#2422) Fix link to deployment options * docs: Remove references to interactive docs in the open source project (#2460) * docs: Remove references to interactive docs in the open source project * Update README.md Co-authored-by: Adam Altman --------- Co-authored-by: Adam Altman * Add Quaderno API to README's Showcase section (#2468) * chore: Update directory structure for Vale v3 (#2477) * chore: Update directory structure for Vale v3 * chore: update Vale folder name * docs: Add docs tooling to align with publishing to main site (#2484) * docs: add markdownlint and some link checks alongside vale * docs: add link checker config and fix/update some links reported broken * docs: update markdownlint action * docs: fix markdown table formatting * docs: Unpin Vale version and pick up the latest * docs: Fix a link that couldn't be checked as it reaches outside the Redoc project (#2490) * docs: Update API examples list to include Museum API (#2506) * feat: Update API examples list to include Museum API * updates museum.yaml with logo and replaces petstore with museum api in playground for local dev and some minor edits to redoc name * docs: update definition --------- Co-authored-by: Heather Cloward Co-authored-by: Alex Varchuk * chore: fix vulnerabilities and upgrade deps (#2445) * chore: fix vulnerabilities and upgrade deps * chore: use old version of cypress * fix: additional vulnerabilities * chore: add check-version to publish script (#2446) * fix: publish script (#2524) * chore: upgrade openapi-sampler (#2525) * chore: upgrade cypress to fix e2e tests and update-browserslist-db (#2529) * fix: use h2/h3 for headings instead of h1/h2 for better seo (#2514) * fix: use h2/h3 for headings instead of h1/h2 for better seo * fix: fixed e2e tests for changed headings --------- Co-authored-by: Max Krumpe * fix: add deprecated css to clickable property name (#2526) Co-authored-by: Kerem Nalbant * chore: v2.1.4 (#2530) * chore: fix docker publish action (#2531) * docs: Remove outdated sync job for docs folder (#2465) * chore: move jest-environment-jsdom to dev dependencies (#2543) * fix: update react to 18 and react-tabs to 6 (#2547) * chore: v2.1.5 (#2550) * chore: upgrade vulnerable dev dependencies * chore: remove heavy bundlesize dev dependency * docs: update broken link of Openapi Object (#2577) * fix: show siblings schema with oneOf (#2576) * docs: fix http-server example from in-page feedback (#2580) * chore: upgrade node version for docker (#2589) * docs: Remove the old zero-dependency claim for Redoc docs (#2590) * chore: Remove the sync job, we don't use it any more (#2591) * chore(deps): bump body-parser and express (#2603) Bumps [body-parser](https://github.com/expressjs/body-parser) and [express](https://github.com/expressjs/express). These dependencies needed to be updated together. Updates `body-parser` from 1.20.2 to 1.20.3 - [Release notes](https://github.com/expressjs/body-parser/releases) - [Changelog](https://github.com/expressjs/body-parser/blob/master/HISTORY.md) - [Commits](https://github.com/expressjs/body-parser/compare/1.20.2...1.20.3) Updates `express` from 4.19.2 to 4.21.1 - [Release notes](https://github.com/expressjs/express/releases) - [Changelog](https://github.com/expressjs/express/blob/4.21.1/History.md) - [Commits](https://github.com/expressjs/express/compare/4.19.2...4.21.1) --- updated-dependencies: - dependency-name: body-parser dependency-type: indirect - dependency-name: express dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump dompurify from 3.0.6 to 3.1.3 (#2602) Bumps [dompurify](https://github.com/cure53/DOMPurify) from 3.0.6 to 3.1.3. - [Release notes](https://github.com/cure53/DOMPurify/releases) - [Commits](https://github.com/cure53/DOMPurify/compare/3.0.6...3.1.3) --- updated-dependencies: - dependency-name: dompurify dependency-type: direct:production ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat: add support x-badges (#2605) * feat: add support x-badges Co-authored-by: Max Mueller * chore: try to fix e2e tests * chore: try to fix e2e tests part 2 * Update docs/redoc-vendor-extensions.md --------- Co-authored-by: Max Mueller Co-authored-by: Jacek Łękawa <164185257+JLekawa@users.noreply.github.com> * chore: v2.2.0 (#2606) * fix: docker build (#2607) * docs(all): change admonition type to 'info' (#2608) * chore: updated webpack version to 5.94.0 (#2583) * feat: update pattern styling (#2196) (#2600) Closes #2196 * chore: npm audit for previnting feature vulnerabilities (#2612) * formatting * readme formatting * operations * types * utils * badges in spec * update package lock * snapshots * wf updates * spec * snapshot * search tests * fix e2e tests * update styled-components * dont update --------- Signed-off-by: dependabot[bot] Co-authored-by: redocly-bot Co-authored-by: Alex Varchuk Co-authored-by: Ricardo Graça <33238205+Ricagraca@users.noreply.github.com> Co-authored-by: Ricagraca Co-authored-by: Heather Cloward Co-authored-by: Oprysk Viacheslav Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Roman Pidkostelnyi <63608794+RomanPidkostelnyi@users.noreply.github.com> Co-authored-by: Adam Altman Co-authored-by: Lorna Jane Mitchell Co-authored-by: Lorna Mitchell Co-authored-by: Roman Hotsiy Co-authored-by: ckszabi Co-authored-by: szaszeke Co-authored-by: Andrew Tatomyr Co-authored-by: Alexei Maridashvili Co-authored-by: Javi Rubio Co-authored-by: Max Krumpe <42165374+maxkrumpe@users.noreply.github.com> Co-authored-by: Max Krumpe Co-authored-by: Kerem Nalbant <43813768+keremnalbant@users.noreply.github.com> Co-authored-by: Kerem Nalbant Co-authored-by: Max Mueller Co-authored-by: Jacek Łękawa <164185257+JLekawa@users.noreply.github.com> Co-authored-by: Taylor Krusen Co-authored-by: Dxuian <92696836+Dxuian@users.noreply.github.com> Co-authored-by: Michael Huynh <43751307+miqh@users.noreply.github.com> --- .github/workflows/e2e-tests.yml | 2 +- .github/workflows/publish.yml | 16 +- .github/workflows/unit-tests.yml | 2 +- README.md | 2 +- demo/openapi.yaml | 601 +------------------------ docs/css.md | 64 +-- e2e/integration/menu.e2e.ts | 2 +- e2e/integration/search.e2e.ts | 11 +- package-lock.json | 68 +-- src/components/SearchBox/SearchBox.tsx | 4 +- src/services/models/Operation.ts | 2 - src/types/open-api.ts | 15 - src/utils/openapi.ts | 1 - 13 files changed, 85 insertions(+), 705 deletions(-) diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml index 50a6f24ba6..0bab1ca640 100644 --- a/.github/workflows/e2e-tests.yml +++ b/.github/workflows/e2e-tests.yml @@ -10,7 +10,7 @@ jobs: build-and-e2e: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - run: npm ci - run: npm run bundle - run: npm run e2e diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 0de4a3a185..ac93ae372f 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -10,13 +10,13 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Setup Node - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 - name: Cache node modules - uses: actions/cache@v3 + uses: actions/cache@v4 with: path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS key: npm-${{ hashFiles('package-lock.json') }} @@ -26,7 +26,7 @@ jobs: - run: npm ci - run: npm run bundle - name: Store bundle artifact - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: bundles path: bundles @@ -47,7 +47,7 @@ jobs: - uses: actions/checkout@v3 - run: npm ci - name: Download bundled artifact - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: bundles path: bundles @@ -85,16 +85,16 @@ jobs: registry-url: 'https://registry.npmjs.org' - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Download bundled artifacts - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: bundles path: bundles - name: Cache node modules - uses: actions/cache@v3 + uses: actions/cache@v4 with: path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS key: npm-${{ hashFiles('package-lock.json') }} diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml index 40a8978c41..6172d70ece 100644 --- a/.github/workflows/unit-tests.yml +++ b/.github/workflows/unit-tests.yml @@ -10,7 +10,7 @@ jobs: build-and-unit: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - run: npm ci - run: npm run bundle - run: npm test diff --git a/README.md b/README.md index cf50122d54..cf1612aba1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# This is a fork of the [Redocly/redoc](https://github.com/Redocly/redoc) project. It will be supported for the Bandwidth Organization only! If you would like to contribute or have any issues with the project, please contribute to the parent project and NOT this repository. +# This is a fork of the [Redocly/redoc](https://github.com/Redocly/redoc) project. It will be supported for the Bandwidth Organization only! If you would like to contribute or have any issues with the project, please contribute to the parent project and NOT this repository diff --git a/demo/openapi.yaml b/demo/openapi.yaml index 90a71831a2..d715155e63 100644 --- a/demo/openapi.yaml +++ b/demo/openapi.yaml @@ -40,7 +40,7 @@ info: - version: 1.1.0 + version: 1.0.0 title: Swagger Petstore termsOfService: 'http://swagger.io/terms/' contact: @@ -59,8 +59,6 @@ externalDocs: tags: - name: pet description: Everything about your Pets - - name: Tn Option - description: Everything about your TN Options - name: store description: Access to Petstore orders - name: user @@ -78,7 +76,6 @@ x-tagGroups: tags: - pet - store - - Tn Option - name: User Management tags: - user @@ -116,9 +113,6 @@ paths: summary: Add a new pet to the store description: Add new pet to the store inventory. operationId: addPet - x-badges: - - name: Global - type: global responses: '405': description: Invalid input @@ -166,9 +160,6 @@ paths: summary: Update an existing pet description: '' operationId: updatePet - x-badges: - - name: US Only - type: usonly responses: '400': description: Invalid ID supplied @@ -195,596 +186,6 @@ paths: } requestBody: $ref: '#/components/requestBodies/Pet' - '/accounts/{accountId}/tnoptions/{orderid}/history': - get: - description: Retrieve the history information associated with an order. - operationId: GetOrderHistory - x-badges: - - name: Success - type: success - parameters: - - description: '' - in: path - name: orderid - required: true - schema: - type: string - responses: - '200': - content: - application/xml: - examples: - application/xml: - value: |- - - - - 2020-09-17T08:56:39.607Z - Order has been received by the system. - admin - received - - - 2020-09-17T08:56:39.743Z - Order processing has started. - admin - processing - - - 2020-09-17T08:56:39.820Z - Order is complete. - admin - complete - - - description: >- - The history payload is a set of history records, each of which - contains: - - - -
OrderDateThe date that the order history event happened
StatusThe new state of the TN Option order - RECEIVED, PROCESSING, COMPLETE, PARTIAL, FAILED
NoteA Note or additional information included with the state change
AuthorThe user id that implemented the state change

- '404': - content: - application/xml: {} - description: Not found. The order id does not exist in the system. - summary: Retrieve TN Option order history - tags: - - Tn Option - '/accounts/{accountId}/tnoptions': - get: - description: >- - Retrieve a list of the TN Option orders that are associated with the - account. A maximum of 1,000 orders can be retrieved per request. If no - date range or specific query parameter (marked by * below) is - provided, the order results will be limited to the last two years. - operationId: GetTnOptionOrders - x-badges: - - name: 1st Badge - type: warning - - name: 2nd Badge - type: experimental - parameters: - - description: The status of the TN Option order being searched for. - example: PROCESSING - in: query - name: status - required: false - schema: - items: - type: string - type: array - - description: * A Telephone Number (TN) that is referenced in the order. - example: '9199918388' - in: query - name: tn - required: false - schema: - type: string - - description: >- - * The Customer Order ID is an ID assigned by the account - owner to provide a reference number for the TN Option order. - example: ABCCorp12345 - in: query - name: customerOrderId - required: false - schema: - type: string - - description: >- - For Date-based searches, the starting date of a date range - (inclusive) that will be used to find TN Option Orders that were - modified within the date range. It is in the form yyyy-MM-dd. - example: '2013-10-22' - in: query - name: modifiedDateFrom - required: false - schema: - type: string - - description: >- - For Date-based searches, the ending date of a date range (inclusive) - that will be used to find TN Option Orders that were modified within - the date range. It is in the form yyyy-MM-dd. - example: '2013-10-25' - in: query - name: modifiedDateTo - required: false - schema: - type: string - - description: >- - Checks the order's creation date against this value. Orders that - have a creation date after this date will be included. Format is - yyyy-MM-dd. - example: '2013-10-22' - in: query - name: createdDateFrom - required: false - schema: - type: string - - description: >- - Checks the order's creation date against this value. Orders that - have a creation date before this date will be included. Format is - yyyy-MM-dd. - example: '2013-10-25' - in: query - name: createdDateTo - required: false - schema: - type: string - - description: >- - Checks the order's last modified date against this value. Orders - that have a modification date after this date will be included. - Format is yyyy-MM-dd. - example: '2013-10-25' - in: query - name: lastModifiedAfter - required: false - schema: - type: string - - description: >- - This is the user-name of the user that last modified the TN Option - Order. - example: smckinnon - in: query - name: lastModifiedBy - required: false - schema: - type: string - - description: >- - * This search parameter represents the internal Bandwidth - Dashboard API ID that has been assigned to the TN Option Order. This - parameter is the first few characters of the internal ID - the - entire ID does not need to be specified. - example: ed1c0bed-e2 - in: query - name: orderIdFragment - required: false - schema: - type: string - - description: >- - If set to true, a list of order details will be displayed instead - the summary information. - in: query - name: orderDetails - required: false - schema: - type: boolean - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - - - - 2 - - 14 - 2 - jbm - 2016-01-15T12:01:14.363Z - 2016-01-15T12:01:14.324Z - tn_option - FAILED - ddbdc72e-dc27-490c-904e-d0c11291b095 - - - 14 - 3 - jbm - 2016-01-15T11:22:58.969Z - 2016-01-15T11:22:58.789Z - tn_option - COMPLETE - 409033ee-88ec-43e3-85f3-538f30733963 - - - - - 2 - - 2016-01-15T12:01:14.324Z - 14 - jbm - ddbdc72e-dc27-490c-904e-d0c11291b095 - 2016-01-15T12:01:14.363Z - FAILED - - - 10digit - 10digit - testUser1 - 6042661720 - on - true - on - sip:+12345678901@1.2.3.4:5060 - - 2018551020 - - - - off - false - off - - 2018551025 - - - - - - 5076 - Telephone number is not available. - 2018551025 - - - 5076 - Telephone number is not available. - 2018551020 - - - - - 2016-01-15T11:22:58.789Z - 14 - jbm - 409033ee-88ec-43e3-85f3-538f30733963 - 2016-01-15T11:22:58.969Z - COMPLETE - - - on - - 2174101601 - - - - off - - 2174101602 - - - - systemdefault - - 2174101603 - - - - - - - - description: >- - The descriptive payload for the TN Option Orders query provides a - broad range of information about the TN Option Orders found by the - query, including the data associated with the order, the state of - the order, and details about the order if it was successful. - '404': - content: - application/xml: {} - description: > - Not Found. If any errors are found in the processing of the query - string a 404 will be returned. Note that parameters that are not - recognized are not considered errors, and are just ignored. - summary: Retrieve list TN Option orders - tags: - - Tn Option - post: - description: >- - Create TN Option order to assign line features to the telephone - number.

Attribute description:
  • for A2pSettings - attribute
    • Number - attributeAction valueDescription of - action
    LongCodesystemDefaultRemoves - the per-TN A2P attributes, and it reverts to the Location/SIP Peer - characteristics. Any values for Class or Campaign ID are not - valid
    LongCodeasSpecifiedSets - the message class and campaign ID - this is the default if - unspecified
    LongCodeoffWill - set the TN as a 'P' TN. Any values for Class or Campaign ID are not - valid
    LongCodedeleteWill - delete the campaign ID from TN. Any values for Class or Campaign ID are - not valid
    LongCodeunchangedDo - nothing with respect to - A2P
    TollFreesystemDefaultRemoves - the per-TN A2P attributes, and it reverts to the Location/SIP Peer - characteristics. Any values for Class or Campaign ID are not - valid
    TollFreeasSpecifiedSets - the message class and campaign ID - this is the default if - unspecified
    TollFreeoffIf the - Togglz value is set to 'on' this is invalid for Toll Free telephone - numbers. Any values for Class or Campaign ID in the payload are invalid. - If the Togglz value is set to off this behaves like and A2P TN, where - the characteristics of the TNs is set to - 'P'
    TollFreeunchangedDo - nothing with respect to A2P
  • for Origination - Route plan attribute
    • Action - valueDescription of - action
    asSpecifiedCreates/updates the - origination route plan for the TN with route plan details provided in - the request
    offRemoves the origination route - plan for the TN. Route list is the request must be - empty
    unchangedDoesn't update/create the - origination route plan, even when route plan details exist in the - request
    • Origination route plan is - validated against CallForward and RewriteUser
      • Route plan and CallForward cannot co-exist. Order is - accepted but will respond with error messages on GET.
      • Route plan and RewriteUser cannot co-exist. Order is - accepted but will respond with error messages on - GET.
  • for Pindrop Enabled attribute
    • Action valueDescription of - action
    trueEnables Pindrop integration on each - phone number in the option - group
    falseExplicitly disables Pindrop - integration on each phone number in the option - group
  • for other attribute
    • systemDefault - implies that the element profile - value should be removed so that the TN changes back to the default - system behavior;
    • unchanged - the value - should remain unchanged - implies a read before write model.
    • Leaving the element out of the payload is equivalent to - unchanged.
- operationId: CreateTnOptionOrder - requestBody: - content: - application/xml: - examples: - example: - value: |- - - - TnOptionOrder1 - - - 10digit - 10digit - testUser1 - 6042661720 - on - a1b2c3 - true - on - sip:+12345678901@1.2.3.4:5060 - - M - campaignId010 - asSpecified - - - 2018551020 - - - - off - false - off - - - 6105552502 - 1 - 100 - - - sip:clarkkent@dailyplanet.com - 2 - 100 - - - 192.168.20.21 - 3 - 50 - - - 7075552509 - 3 - 50 - - - myhost.bandwidth.example - 4 - 100 - - asSpecified - - - 2018551025 - - - - true - - 2018551026 - - - - - responses: - '201': - content: - application/xml: - examples: - example: - value: |- - - - - 2016-01-15T12:01:14.324Z - 14 - jbm - ddbdc72e-dc27-490c-904e-d0c11291b095 - 2016-01-15T12:01:14.324Z - RECEIVED - - - 10digit - 10digit - testUser1 - 6042661720 - on - true - on - - 2018551020 - - - - off - false - off - - 2018551025 - - - - - - - description: Created - '400': - content: - application/xml: - examples: - example: - value: |- - - - - 5081 - Number Format 'wrong' is invalid. - - - description: >- - Bad Request A 400 response Indicates that the order could not be - created. Error text and an error code will be provided in the - ErrorList element. - '409': - content: - application/xml: - examples: - example: - value: |- - - - - 5200 - Origination route plan is not enabled for the account. - - - description: >- - Conflict. Error text and an error code will be provided in the - ErrorList element. - summary: Create TN Option order - tags: - - Tn Option - '/accounts/{accountId}/tnoptions/{orderid}': - get: - description: Retrieve information about a TN Option Order with specified ID. - operationId: GetTnOptionOrder - parameters: - - description: '' - in: path - name: orderid - required: true - schema: - type: string - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - - - 2016-01-15T11:22:58.789Z - 14 - jbm - 409033ee-88ec-43e3-85f3-538f30733963 - 2016-01-15T11:22:58.969Z - COMPLETE - - - on - on - - 2174101601 - - - - off - - 2174101602 - - - - systemdefault - sip:+12345678901@1.2.3.4:5060 - - 2174101603 - - - - - - - 2174101601 - SMS is already Enabled or number is in processing. - - - - description: >- - The descriptive payload for the TN Option Orders query provides a - broad range of information about the TN Option Order identified in - the URL. Included amongst the information is:
  • ErrorList - - the errors discovered with codes and explanations
  • Warnings - - the warnings discovered with - explanations
  • ProcessingStatus(RECEIVED, PROCESSING, - COMPLETE, PARTIAL, FAILED) - the overall status of the - order
- '404': - content: - application/xml: - examples: - example: - value: |- - - - - The resource does not exist - - - description: Not found. The order id does not exist in the system. - summary: Retrieve TN Option order - tags: - - Tn Option '/pet/{petId}': get: tags: diff --git a/docs/css.md b/docs/css.md index 13739c0230..b74f128c81 100644 --- a/docs/css.md +++ b/docs/css.md @@ -10,58 +10,58 @@ Certain components and containers in this project have been given unique classNa ### Operations - - `middle-panel`: top level container for content in the middle panel of an **Operation** - - `right-panel`: top level container for content in the right panel of an **Operation** - - `operation-header`: `

` that contains the **Operation** header/summary - - `operation-description`: container for the **Operation** description +- `middle-panel`: top level container for content in the middle panel of an **Operation** +- `right-panel`: top level container for content in the right panel of an **Operation** +- `operation-header`: `

` that contains the **Operation** header/summary +- `operation-description`: container for the **Operation** description ### Security - - `operation-security`: top level container for the Security/Auth section in an **Operation** - - `security-details`: container for an individual security method in the Security/Auth section +- `operation-security`: top level container for the Security/Auth section in an **Operation** +- `security-details`: container for an individual security method in the Security/Auth section ### Parameters - - `operation-parameters`: container for **Operation** query/path/header/form parameters +- `operation-parameters`: container for **Operation** query/path/header/form parameters ### Requests - - `operation-request-samples`: top level container for the **Request Samples** section in the right panel - - `request-code-sample`: container for the request code samples in the right panel - - `request-payload`: container for the request payload sample in the right panel +- `operation-request-samples`: top level container for the **Request Samples** section in the right panel +- `request-code-sample`: container for the request code samples in the right panel +- `request-payload`: container for the request payload sample in the right panel ### Responses - - `operation-responses`: top level container for the **Responses** section in the middle panel - - `response`: container for individual responses in the **Responses** section - - `response-headers`: `` for response headers for an individual response - - `operation-response-samples`: top level container for the **Response Samples** section in the right panel - - `response-sample`: container for the response payload sample in the right panel +- `operation-responses`: top level container for the **Responses** section in the middle panel +- `response`: container for individual responses in the **Responses** section +- `response-headers`: `` for response headers for an individual response +- `operation-response-samples`: top level container for the **Response Samples** section in the right panel +- `response-sample`: container for the response payload sample in the right panel ### Callbacks - - `callbacks`: top level container for the **Callbacks** section in the middle panel - - `callback`: container for individual callbacks in the **Callbacks** section - - `operation-callback-samples`: top level container for the **Callback Samples** section in the right panel - - `callback-sample`: container for the callback payload sample in the right panel +- `callbacks`: top level container for the **Callbacks** section in the middle panel +- `callback`: container for individual callbacks in the **Callbacks** section +- `operation-callback-samples`: top level container for the **Callback Samples** section in the right panel +- `callback-sample`: container for the callback payload sample in the right panel ### Schemas - - `array-schema`: container for array schema - - `object-schema`: `` for object schema - - `oneOf-schema`: container for oneOf schema - - `recursive-schema` container for recursive schema +- `array-schema`: container for array schema +- `object-schema`: `` for object schema +- `oneOf-schema`: container for oneOf schema +- `recursive-schema` container for recursive schema ### Fields - - `field`: `` for individual fields inside a **Schema** - - `field-details`: container for details on an individual **Field** - - `field-constraints`: `` for constraints on an individual **Field** inside the field details - - `field-deprecated`: deprecated badge for an individual **Field** inside the field details - - `field-example`: example value for an individual **Field** inside the field details - - `field-pattern`: regex pattern for an individual **Field** inside the field details +- `field`: `` for individual fields inside a **Schema** +- `field-details`: container for details on an individual **Field** +- `field-constraints`: `` for constraints on an individual **Field** inside the field details +- `field-deprecated`: deprecated badge for an individual **Field** inside the field details +- `field-example`: example value for an individual **Field** inside the field details +- `field-pattern`: regex pattern for an individual **Field** inside the field details ### Other - - `side-menu`: top level container for the sidebar menu - - `endpoint`: container for the endpoint URL used in multiple places - - `request-body-description`: container for the description of a request body used in multiple places +- `side-menu`: top level container for the sidebar menu +- `endpoint`: container for the endpoint URL used in multiple places +- `request-body-description`: container for the description of a request body used in multiple places diff --git a/e2e/integration/menu.e2e.ts b/e2e/integration/menu.e2e.ts index d889d70152..61dcf1d677 100644 --- a/e2e/integration/menu.e2e.ts +++ b/e2e/integration/menu.e2e.ts @@ -4,7 +4,7 @@ describe('Menu', () => { cy.visit('e2e/standalone.html'); }); it('should have valid items count', () => { - cy.get('.menu-content').find('li').should('have.length', 40); + cy.get('.menu-content').find('li').should('have.length', 35); }); it('should sync active menu items while scroll', () => { diff --git a/e2e/integration/search.e2e.ts b/e2e/integration/search.e2e.ts index 51433366d2..1f440a68ba 100644 --- a/e2e/integration/search.e2e.ts +++ b/e2e/integration/search.e2e.ts @@ -16,9 +16,9 @@ describe('Search', () => { getSearchInput().type('t', { force: true }); cy.get('[role=search] [role=menuitem]') - .should('have.length', 4) - .first() - .should('contain', 'Delete purchase order'); + .should('have.length', 3) + .eq(1) + .should('contain', 'Delete purchase order by ID'); getSearchInput().type('{esc}', { force: true }); getSearchResults().should('not.exist'); @@ -44,8 +44,6 @@ describe('Search', () => { getResult(1).should('have.class', 'active'); getSearchInput().type('{enter}', { force: true }); - - cy.contains('[role=menu] label', 'Introduction').should('have.class', 'active'); }); it('should mark search results', () => { @@ -74,8 +72,5 @@ describe('Search', () => { .should('have.length', 1) .first() .should('contain', 'uploads an image'); - - getSearchInput().clear().type('/tnoptions', { force: true, parseSpecialCharSequences: false }); - cy.get('[role=search] [role=menuitem]').should('have.length', 4); }); }); diff --git a/package-lock.json b/package-lock.json index fbdb5afd4b..5c78b96318 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2140,9 +2140,9 @@ } }, "node_modules/@emotion/is-prop-valid": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@emotion/is-prop-valid/-/is-prop-valid-1.2.1.tgz", - "integrity": "sha512-61Mf7Ufx4aDxx1xlDeOm8aFFigGHE4z+0sKCa+IHCeZKiyP9RLD0Mmx7m8b9/Cf37f7NAvQOOJAbQQGVr5uERw==", + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/@emotion/is-prop-valid/-/is-prop-valid-1.2.2.tgz", + "integrity": "sha512-uNsoYd37AFmaCdXlg6EYD1KaPOaRWRByMCYzbKUX4+hhMfrxdVSelShywL4JVaAeM/eHUOSprYBQls+/neX3pw==", "dev": true, "dependencies": { "@emotion/memoize": "^0.8.1" @@ -6885,9 +6885,9 @@ "dev": true }, "node_modules/csstype": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.2.tgz", - "integrity": "sha512-I7K1Uu0MBPzaFKg4nI5Q7Vs2t+3gWWW648spaF+Rg7pI9ds18Ugn+lvg4SHczUdKlHI5LWBXyqfS8+DufyBsgQ==", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz", + "integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==", "dev": true }, "node_modules/cypress": { @@ -14182,9 +14182,9 @@ } }, "node_modules/nanoid": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.6.tgz", - "integrity": "sha512-BGcqMMJuToF7i1rt+2PWSNVnWIkGCU78jBG3RxO/bZlnZPK2Cmi2QaffxGO/2RvWi9sL+FAiRiXMgsyxQ1DIDA==", + "version": "3.3.8", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.8.tgz", + "integrity": "sha512-WNLf5Sd8oZxOm+TzppcYk8gVOgP+l58xNy58D0nbUnOxOWRWvlcCV4kUF7ltmI6PsrLl/BgKEyS4mqsGChFN0w==", "dev": true, "funding": [ { @@ -15110,9 +15110,9 @@ } }, "node_modules/postcss": { - "version": "8.4.31", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.31.tgz", - "integrity": "sha512-PS08Iboia9mts/2ygV3eLpY5ghnUcfLV/EXTOW1E2qYxJKGGBUtNjN76FYHnMs36RmARn41bC0AZmn+rR0OVpQ==", + "version": "8.4.38", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.38.tgz", + "integrity": "sha512-Wglpdk03BSfXkHoQa3b/oulrotAkwrlLDRSOb9D0bN86FdRyE9lppSp33aHNPgBa0JKCoB+drFLZkQoRRYae5A==", "dev": true, "funding": [ { @@ -15129,9 +15129,9 @@ } ], "dependencies": { - "nanoid": "^3.3.6", + "nanoid": "^3.3.7", "picocolors": "^1.0.0", - "source-map-js": "^1.0.2" + "source-map-js": "^1.2.0" }, "engines": { "node": "^10 || ^12 || >=14" @@ -16899,9 +16899,9 @@ } }, "node_modules/source-map-js": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.0.2.tgz", - "integrity": "sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", "dev": true, "engines": { "node": ">=0.10.0" @@ -20721,9 +20721,9 @@ "dev": true }, "@emotion/is-prop-valid": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@emotion/is-prop-valid/-/is-prop-valid-1.2.1.tgz", - "integrity": "sha512-61Mf7Ufx4aDxx1xlDeOm8aFFigGHE4z+0sKCa+IHCeZKiyP9RLD0Mmx7m8b9/Cf37f7NAvQOOJAbQQGVr5uERw==", + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/@emotion/is-prop-valid/-/is-prop-valid-1.2.2.tgz", + "integrity": "sha512-uNsoYd37AFmaCdXlg6EYD1KaPOaRWRByMCYzbKUX4+hhMfrxdVSelShywL4JVaAeM/eHUOSprYBQls+/neX3pw==", "dev": true, "requires": { "@emotion/memoize": "^0.8.1" @@ -24283,9 +24283,9 @@ } }, "csstype": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.2.tgz", - "integrity": "sha512-I7K1Uu0MBPzaFKg4nI5Q7Vs2t+3gWWW648spaF+Rg7pI9ds18Ugn+lvg4SHczUdKlHI5LWBXyqfS8+DufyBsgQ==", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz", + "integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==", "dev": true }, "cypress": { @@ -29672,9 +29672,9 @@ } }, "nanoid": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.6.tgz", - "integrity": "sha512-BGcqMMJuToF7i1rt+2PWSNVnWIkGCU78jBG3RxO/bZlnZPK2Cmi2QaffxGO/2RvWi9sL+FAiRiXMgsyxQ1DIDA==", + "version": "3.3.8", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.8.tgz", + "integrity": "sha512-WNLf5Sd8oZxOm+TzppcYk8gVOgP+l58xNy58D0nbUnOxOWRWvlcCV4kUF7ltmI6PsrLl/BgKEyS4mqsGChFN0w==", "dev": true }, "nanospinner": { @@ -30373,14 +30373,14 @@ "integrity": "sha512-d7Uw+eZoloe0EHDIYoe+bQ5WXnGMOpmiZFTuMWCwpjzzkL2nTjcKiAk4hh8TjnGye2TwWOk3UXucZ+3rbmBa8Q==" }, "postcss": { - "version": "8.4.31", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.31.tgz", - "integrity": "sha512-PS08Iboia9mts/2ygV3eLpY5ghnUcfLV/EXTOW1E2qYxJKGGBUtNjN76FYHnMs36RmARn41bC0AZmn+rR0OVpQ==", + "version": "8.4.38", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.38.tgz", + "integrity": "sha512-Wglpdk03BSfXkHoQa3b/oulrotAkwrlLDRSOb9D0bN86FdRyE9lppSp33aHNPgBa0JKCoB+drFLZkQoRRYae5A==", "dev": true, "requires": { - "nanoid": "^3.3.6", + "nanoid": "^3.3.7", "picocolors": "^1.0.0", - "source-map-js": "^1.0.2" + "source-map-js": "^1.2.0" } }, "postcss-modules-extract-imports": { @@ -31741,9 +31741,9 @@ "dev": true }, "source-map-js": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.0.2.tgz", - "integrity": "sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", "dev": true }, "source-map-support": { diff --git a/src/components/SearchBox/SearchBox.tsx b/src/components/SearchBox/SearchBox.tsx index b22e66d377..e976566eb6 100644 --- a/src/components/SearchBox/SearchBox.tsx +++ b/src/components/SearchBox/SearchBox.tsx @@ -177,7 +177,9 @@ export class SearchBox extends React.PureComponent )} {this.state.term && this.state.noResults ? ( - {l('noResultsFound')} + + {l('noResultsFound')} + ) : null} ); diff --git a/src/services/models/Operation.ts b/src/services/models/Operation.ts index c5c77f61b8..cb8bd73ddc 100644 --- a/src/services/models/Operation.ts +++ b/src/services/models/Operation.ts @@ -78,7 +78,6 @@ export class OperationModel implements IMenuItem { httpVerb: string; badges: OpenAPIXBadges[]; deprecated: boolean; - badges: OperationCustomBadge[]; path: string; servers: OpenAPIServer[]; security: SecurityRequirementModel[]; @@ -103,7 +102,6 @@ export class OperationModel implements IMenuItem { this.externalDocs = operationSpec.externalDocs; this.deprecated = !!operationSpec.deprecated; - this.badges = operationSpec['x-badges'] ? operationSpec['x-badges'] : []; this.httpVerb = operationSpec.httpVerb; this.deprecated = !!operationSpec.deprecated; this.operationId = operationSpec.operationId; diff --git a/src/types/open-api.ts b/src/types/open-api.ts index ea287b6d27..648d98e424 100644 --- a/src/types/open-api.ts +++ b/src/types/open-api.ts @@ -64,20 +64,6 @@ export interface OpenAPIPath { $ref?: string; } -export type OperationCustomBadgeType = - | 'primary' - | 'success' - | 'warning' - | 'error' - | 'global' - | 'usonly' - | 'experimental'; - -export interface OperationCustomBadge { - name: string; - type: OperationCustomBadgeType; -} - export interface OpenAPIXCodeSample { lang: string; label?: string; @@ -103,7 +89,6 @@ export interface OpenAPIOperation { deprecated?: boolean; security?: OpenAPISecurityRequirement[]; servers?: OpenAPIServer[]; - 'x-badges'?: OperationCustomBadge[]; 'x-codeSamples'?: OpenAPIXCodeSample[]; 'x-code-samples'?: OpenAPIXCodeSample[]; // deprecated 'x-badges'?: OpenAPIXBadges[]; diff --git a/src/utils/openapi.ts b/src/utils/openapi.ts index 4f068c80eb..33e0193a29 100644 --- a/src/utils/openapi.ts +++ b/src/utils/openapi.ts @@ -663,7 +663,6 @@ export function isRedocExtension(key: string): boolean { 'x-badges': true, 'x-additionalPropertiesName': true, 'x-explicitMappingOnly': true, - 'x-badges': true, }; return key in redocExtensions;